COPASI API  4.40.278
CSBMLunitInterface::CExpressionInformation Class Reference

#include <CSBMLunitInterface.h>

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.

Constructor & Destructor Documentation

◆ CExpressionInformation()

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

Default constructor.

Member Data Documentation

◆ mErrorCode

int CSBMLunitInterface::CExpressionInformation::mErrorCode

◆ mObjectDisplayString

std::string CSBMLunitInterface::CExpressionInformation::mObjectDisplayString

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

Referenced by CSBMLunitInterface::initializeFromSBMLModel().

◆ mPerTime

bool CSBMLunitInterface::CExpressionInformation::mPerTime

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

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

◆ mpExpression

const ASTNode* CSBMLunitInterface::CExpressionInformation::mpExpression

◆ mReactionId

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

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

◆ mRootObject

std::string CSBMLunitInterface::CExpressionInformation::mRootObject

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

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

◆ mRootUnit

CSBMLunitInformation CSBMLunitInterface::CExpressionInformation::mRootUnit

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

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

◆ mTypeDescription

std::string CSBMLunitInterface::CExpressionInformation::mTypeDescription

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

Referenced by CSBMLunitInterface::initializeFromSBMLModel().


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