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

#include <CSBMLunitInterface.h>

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

Public Member Functions

 CEnvironmentInformation ()
 
 CEnvironmentInformation (const std::string &ri)
 
void drop ()
 drop the top level of the function variables frame stack More...
 
bool isReactionScope () const
 tells if the current scope involves a reaction (local parameters) More...
 
void push (std::map< std::string, ASTNode * > &frame)
 push a mapping for function variables onto the frame stack More...
 

Public Attributes

std::vector< std::map
< std::string, ASTNode * > > 
mFrameStack
 
std::string mReactionID
 

Detailed Description

describes the local environment for the recursive unit analysis. It can either be empty, in this case only the global objects are accessible. If a reaction is provided the local parameters of this reaction are accessible. If a stack of function variables is provided, the top level of this stack describes the accessible variables in the frame. Local parameters and function variables are never simultaneously accessible.

Definition at line 177 of file CSBMLunitInterface.h.

Constructor & Destructor Documentation

CSBMLunitInterface::CEnvironmentInformation::CEnvironmentInformation ( )
inline

Definition at line 180 of file CSBMLunitInterface.h.

180 {};
CSBMLunitInterface::CEnvironmentInformation::CEnvironmentInformation ( const std::string &  ri)
inline

Definition at line 181 of file CSBMLunitInterface.h.

Member Function Documentation

void CSBMLunitInterface::CEnvironmentInformation::drop ( )
inline

drop the top level of the function variables frame stack

Definition at line 188 of file CSBMLunitInterface.h.

References mFrameStack.

Referenced by CSBMLunitInterface::recursion().

189  {if (mFrameStack.size() > 0) mFrameStack.pop_back() ;};
std::vector< std::map< std::string, ASTNode * > > mFrameStack
bool CSBMLunitInterface::CEnvironmentInformation::isReactionScope ( ) const
inline

tells if the current scope involves a reaction (local parameters)

Definition at line 184 of file CSBMLunitInterface.h.

References mFrameStack, and mReactionID.

Referenced by CSBMLunitInterface::getMappedUnitFromIdentifier().

185  {return mReactionID != "" && mFrameStack.size() == 0;}
std::vector< std::map< std::string, ASTNode * > > mFrameStack
void CSBMLunitInterface::CEnvironmentInformation::push ( std::map< std::string, ASTNode * > &  frame)
inline

push a mapping for function variables onto the frame stack

Definition at line 192 of file CSBMLunitInterface.h.

Referenced by CSBMLunitInterface::recursion().

193  {mFrameStack.push_back(frame);};
std::vector< std::map< std::string, ASTNode * > > mFrameStack

Member Data Documentation

std::vector<std::map<std::string, ASTNode*> > CSBMLunitInterface::CEnvironmentInformation::mFrameStack
std::string CSBMLunitInterface::CEnvironmentInformation::mReactionID

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