CellMLToNektar.pycml.MathsError Class Reference

Inheritance diagram for CellMLToNektar.pycml.MathsError:

Collaboration diagram for CellMLToNektar.pycml.MathsError:

Public Member Functions
def	__init__
def	show_xml_context_only
def	__str__
def	ordinal
def	__unicode__

Public Attributes
	message
	warn
	level
	show_xml_context
	cname
	ename
	context
	expr_index
	math_index
	reaction_spec

Private Member Functions
def	_generate_message

Private Attributes
	_show_xml_context_only

Detailed Description

Exception class for validation errors raised while checking mathematics.

Definition at line 3343 of file pycml.py.

Constructor & Destructor Documentation

def CellMLToNektar.pycml.MathsError.__init__	(		self,
			context_obj,
			message,
			warn = False,
			level = None
	)

Create a mathematics validation error.

context_class should be the object that is reporting the error.
message gives more details on what went wrong.
If warn is set to true then produce a warning message, not an error.
level gives the level of the message logged.

Definition at line 3347 of file pycml.py.

    def __init__(self, context_obj, message, warn=False, level=None):
        """Create a mathematics validation error.
        
        context_class should be the object that is reporting the error.
        message gives more details on what went wrong.
        If warn is set to true then produce a warning message, not an error.
        level gives the level of the message logged.
        """
        self.message = message
        self.warn = warn
        self.level = level or (logging.ERROR,logging.WARNING)[warn]
        self.show_xml_context = False
        self._show_xml_context_only = False

        self.cname = context_obj.component.name
        self.ename = context_obj.localName
        self.context = context_obj
        
        # Nicer context explanation
        if isinstance(context_obj, cellml_variable):
            self.expr_index = self.math_index = 0
            self.reaction_spec = ''
            return
        expr_root = context_obj.xml_xpath(u'ancestor-or-self::*[local-name(..)="math"]')[0]
        self.expr_index = self.math_index = 1
        math = expr_root.xml_parent
        for elt in math.xml_element_children():
            if elt is expr_root: break
            if elt.localName in [u'apply', u'semantics']:
                self.expr_index += 1
        for elt in math.xml_element_children(math.xml_parent):
            if elt is math: break
            if elt.localName == u'math':
                self.math_index += 1
        # Is this in a reaction?
        vref = context_obj.xml_xpath(u'ancestor::cml:variable_ref')
        if vref:
            self.reaction_spec = ' in mathematics for variable "%s" in a reaction' % vref[0].variable
        else:
            self.reaction_spec = ''
        return