COPASI API  4.16.103
Public Member Functions | Public Attributes | List of all members
CSBMLunitInterface::CExpressionInformation Class Reference

#include <CSBMLunitInterface.h>

Collaboration diagram for CSBMLunitInterface::CExpressionInformation:
Collaboration graph
[legend]

Public Member Functions

 CExpressionInformation (unsigned int sbmlLevel, unsigned int sbmlVersion)
 Default constructor. More...
 

Public Attributes

int mErrorCode
 error code after run More...
 
std::string mObjectDisplayString
 display name of the object that either contains the expression or the the expression applies to. More...
 
bool mPerTime
 specifies whether the units of the result of the expression are some unit divided by time More...
 
const ASTNode * mpExpression
 root node of an expression in the sbml model More...
 
std::string mReactionId
 id of a reaction. If this is set the local parameters of the reaction are in scope for the expression More...
 
std::string mRootObject
 if this is not "" then the root of the expression should have the units of the referenced object More...
 
CSBMLunitInformation mRootUnit
 if mRootObject is "" then this member specifies the units of the root of the expression More...
 
std::string mTypeDescription
 this indicates the origin of the expression for display purposes, e.g. "kinetic law" More...
 

Detailed Description

This class contains the information about one mathematical expression from an sbml model and how it relates to units constraints.

Definition at line 131 of file CSBMLunitInterface.h.

Constructor & Destructor Documentation

CSBMLunitInterface::CExpressionInformation::CExpressionInformation ( unsigned int  sbmlLevel,
unsigned int  sbmlVersion 
)
inline

Default constructor.

Definition at line 159 of file CSBMLunitInterface.h.

160  : mpExpression(NULL), mPerTime(false), mRootObject(), mRootUnit(CSBMLunitInformation(sbmlLevel, sbmlVersion)), mReactionId(), mErrorCode(0)
161  {};
std::string mRootObject
if this is not "" then the root of the expression should have the units of the referenced object ...
bool mPerTime
specifies whether the units of the result of the expression are some unit divided by time ...
CSBMLunitInformation mRootUnit
if mRootObject is "" then this member specifies the units of the root of the expression ...
const ASTNode * mpExpression
root node of an expression in the sbml model
std::string mReactionId
id of a reaction. If this is set the local parameters of the reaction are in scope for the expression...

Member Data Documentation

int CSBMLunitInterface::CExpressionInformation::mErrorCode

error code after run

Definition at line 150 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::debugOutput(), and CSBMLunitInterface::handleOneExpression().

std::string CSBMLunitInterface::CExpressionInformation::mObjectDisplayString

display name of the object that either contains the expression or the the expression applies to.

Definition at line 156 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::initializeFromSBMLModel().

bool CSBMLunitInterface::CExpressionInformation::mPerTime

specifies whether the units of the result of the expression are some unit divided by time

Definition at line 138 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::debugOutput(), CSBMLunitInterface::determineUnits(), CSBMLunitInterface::handleOneExpression(), and CSBMLunitInterface::initializeFromSBMLModel().

const ASTNode* CSBMLunitInterface::CExpressionInformation::mpExpression
std::string CSBMLunitInterface::CExpressionInformation::mReactionId

id of a reaction. If this is set the local parameters of the reaction are in scope for the expression

Definition at line 147 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::debugOutput(), CSBMLunitInterface::determineUnits(), CSBMLunitInterface::handleOneExpression(), and CSBMLunitInterface::initializeFromSBMLModel().

std::string CSBMLunitInterface::CExpressionInformation::mRootObject

if this is not "" then the root of the expression should have the units of the referenced object

Definition at line 141 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::debugOutput(), CSBMLunitInterface::determineUnits(), CSBMLunitInterface::handleOneExpression(), and CSBMLunitInterface::initializeFromSBMLModel().

CSBMLunitInformation CSBMLunitInterface::CExpressionInformation::mRootUnit

if mRootObject is "" then this member specifies the units of the root of the expression

Definition at line 144 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::debugOutput(), CSBMLunitInterface::determineUnits(), CSBMLunitInterface::handleOneExpression(), and CSBMLunitInterface::initializeFromSBMLModel().

std::string CSBMLunitInterface::CExpressionInformation::mTypeDescription

this indicates the origin of the expression for display purposes, e.g. "kinetic law"

Definition at line 153 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::initializeFromSBMLModel().


The documentation for this class was generated from the following file: