COPASI API  4.40.278
CSBMLunitInterface::CEnvironmentInformation Class Reference

#include <CSBMLunitInterface.h>

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.

Constructor & Destructor Documentation

◆ CEnvironmentInformation() [1/2]

CSBMLunitInterface::CEnvironmentInformation::CEnvironmentInformation ( )
inline

◆ CEnvironmentInformation() [2/2]

CSBMLunitInterface::CEnvironmentInformation::CEnvironmentInformation ( const std::string &  ri)
inline

Member Function Documentation

◆ drop()

void CSBMLunitInterface::CEnvironmentInformation::drop ( )
inline

drop the top level of the function variables frame stack

References mFrameStack.

Referenced by CSBMLunitInterface::recursion().

◆ isReactionScope()

bool CSBMLunitInterface::CEnvironmentInformation::isReactionScope ( ) const
inline

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

References mFrameStack, and mReactionID.

Referenced by CSBMLunitInterface::getMappedUnitFromIdentifier().

◆ push()

void CSBMLunitInterface::CEnvironmentInformation::push ( std::map< std::string, ASTNode * > &  frame)
inline

push a mapping for function variables onto the frame stack

References mFrameStack.

Referenced by CSBMLunitInterface::recursion().

Member Data Documentation

◆ mFrameStack

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

◆ mReactionID

std::string CSBMLunitInterface::CEnvironmentInformation::mReactionID

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