CellMLToNektar.pycml.mathml_cn Class Reference

Inheritance diagram for CellMLToNektar.pycml.mathml_cn:

Public Member Functions
def	__init__ (self)
def	evaluate (self)
def	get_units (self, return_set=True)
Public Member Functions inherited from CellMLToNektar.pycml.mathml
def	__init__ (self)
def	__repr__ (self)
def	__deepcopy__ (self, memo)
def	clone_self (self, register=False)
def	get_original_of_clone (self)
def	get_component (self)
def	model (self)
def	eval (self, elt)
Public Member Functions inherited from CellMLToNektar.pycml.element_base
def	__init__ (self)
def	__delattr__ (self, key)
def	__setattr__ (self, key, value)
def	rootNode (self)
def	cmeta_id (self)
def	xml_remove_child_at (self, index=-1)
def	xml_doc (self)
def	xml_properties (self)

Static Public Member Functions
def	create_new (elt, value, units)
Static Public Member Functions inherited from CellMLToNektar.pycml.mathml
def	clone (expr)

Public Attributes
	type
Public Attributes inherited from CellMLToNektar.pycml.element_base
	xml_attributes

Private Member Functions
def	_get_binding_time (self)
def	_reduce (self)

Private Attributes
	_cml_units

Additional Inherited Members
Properties inherited from CellMLToNektar.pycml.mathml
	component = property(get_component)

Detailed Description

Definition at line 4145 of file pycml.py.

Constructor & Destructor Documentation

__init__()

def CellMLToNektar.pycml.mathml_cn.__init__

(

self

)

Definition at line 4146 of file pycml.py.

    def __init__(self):
        super(mathml_cn, self).__init__()
        self._cml_units = None
        return

Member Function Documentation

_get_binding_time()

def CellMLToNektar.pycml.mathml_cn._get_binding_time (   self )

private

Return the binding time of this expression.

The binding time of a <cn> element is always static,
unless the CellML is annotated otherwise.

Definition at line 4184 of file pycml.py.

Referenced by CellMLToNektar.pycml.mathml_ci._reduce(), CellMLToNektar.pycml.mathml_apply._reduce(), and CellMLToNektar.pycml.mathml_piecewise._reduce().

    def _get_binding_time(self):
        """Return the binding time of this expression.

        The binding time of a <cn> element is always static,
        unless the CellML is annotated otherwise.
        """
        bt = self.getAttributeNS(NSS['pe'], u'binding_time', u'static')
        return getattr(BINDING_TIMES, bt)
    

_reduce()

def CellMLToNektar.pycml.mathml_cn._reduce (   self )

private

Reduce this expression by evaluating its static parts.

Is actually a no-op; we must have been annotated explicitly as dynamic.

Definition at line 4193 of file pycml.py.

    def _reduce(self):
        """Reduce this expression by evaluating its static parts.
        
        Is actually a no-op; we must have been annotated explicitly as dynamic.
        """
        return

create_new()

def CellMLToNektar.pycml.mathml_cn.create_new (   elt,   value,   units  )

static

Create a new <cn> element with the given value and units.

Definition at line 4211 of file pycml.py.

    def create_new(elt, value, units):
        """Create a new <cn> element with the given value and units."""
        attrs = {(u'cml:units', NSS[u'cml']): unicode(units)}
        new_elt = elt.xml_create_element(u'cn', NSS[u'm'],
                                         attributes=attrs,
                                         content=unicode(value))
        return new_elt

evaluate()

def CellMLToNektar.pycml.mathml_cn.evaluate

(

self

)

Convert the text content of this element to a floating point
value and return it.  Will handle the type attribute and, if
relevant to the type, the sep child element, but does not yet
handle the base attribute.

Definition at line 4151 of file pycml.py.

Referenced by CellMLToNektar.pycml.mathml_constructor._eval_self(), and CellMLToNektar.pycml.mathml_ci._reduce().

    def evaluate(self):
        """
        Convert the text content of this element to a floating point
        value and return it.  Will handle the type attribute and, if
        relevant to the type, the sep child element, but does not yet
        handle the base attribute.
        """
        if hasattr(self, u'base'):
            raise ValueError('pycml does not yet support the base attribute on cn elements')
        if hasattr(self, u'type'):
            if self.type == u'real':
                val = float(unicode(self))
            elif self.type == u'integer':
                val = int(unicode(self))
            elif self.type == u'e-notation':
                assert len(self.xml_children) == 3
                assert self.xml_children[1] is self.sep
                mantissa = unicode(self.xml_children[0]).strip()
                exponent = unicode(self.xml_children[2]).strip()
                val = float(mantissa + 'e' + exponent)
            elif self.type == u'rational':
                assert len(self.xml_children) == 3
                assert self.xml_children[1] is self.sep
                numer = int(unicode(self.xml_children[0]))
                denom = int(unicode(self.xml_children[2]))
                val = numer / denom
            else:
                raise ValueError('Unsupported type attribute for cn element: '
                                 + self.type)
        else:
            val = float(unicode(self))
        return val

get_units()

def CellMLToNektar.pycml.mathml_cn.get_units	(		self,
			return_set = True
	)

Return the units this number is expressed in.

Definition at line 4200 of file pycml.py.

Referenced by CellMLToNektar.pycml.mathml._ensure_units_exist(), CellMLToNektar.pycml.mathml_units_mixin_tokens._set_in_units(), and CellMLToNektar.pycml.mathml_apply._set_in_units().

    def get_units(self, return_set=True):
        """Return the units this number is expressed in."""
        if not self._cml_units:
            self._cml_units = UnitsSet([self.component.get_units_by_name(self.units)], expression=self)
        if not return_set:
            u = self._cml_units.extract()
        else:
            u = self._cml_units
        return u

Member Data Documentation

_cml_units

CellMLToNektar.pycml.mathml_cn._cml_units

private

Definition at line 4148 of file pycml.py.

Referenced by CellMLToNektar.pycml.mathml_apply._set_in_units(), CellMLToNektar.pycml.mathml_piecewise._set_in_units(), CellMLToNektar.pycml.mathml_apply.get_units(), and CellMLToNektar.pycml.mathml_piecewise.get_units().

type

CellMLToNektar.pycml.mathml_cn.type

Definition at line 4161 of file pycml.py.