libRoadRunner C++ API  1.3
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | Public Attributes | List of all members
rr::SelectionRecord Class Reference

#include <rrSelectionRecord.h>

Public Types

enum  SelectionType { ,
  CONCENTRATION = (0x1 << 1) , BOUNDARY = (0x1 << 4) , _COMPARTMENT = (0x1 << 6) , INITIAL = (0x1 << 9) ,
  EIGENVALUE = (0x1 << 14) , COMPLEX = (0x1 << 23), EIGENVALUE_COMPLEX = EIGENVALUE | COMPLEX , COMPARTMENT = _COMPARTMENT | INDEPENDENT | DEPENDENT | CURRENT,
  GLOBAL_PARAMETER = _GLOBAL_PARAMETER | INDEPENDENT | DEPENDENT | CURRENT, FLOATING_AMOUNT = FLOATING | AMOUNT | INDEPENDENT | DEPENDENT | CURRENT , BOUNDARY_CONCENTRATION = BOUNDARY | CONCENTRATION | INDEPENDENT | DEPENDENT | CURRENT , FLOATING_AMOUNT_RATE = FLOATING | RATE | DEPENDENT ,
  REACTION_RATE = REACTION | RATE | DEPENDENT, INITIAL_AMOUNT = INITIAL | AMOUNT | INDEPENDENT | DEPENDENT , DEPENDENT_INITIAL_GLOBAL_PARAMETER = INITIAL | _GLOBAL_PARAMETER | DEPENDENT , MODEL_STATE = ALL_INDEPENDENT_AMOUNT & ~INITIAL,
  SBML_INITIALIZE = STATE_VECTOR
}
 

Public Member Functions

 SelectionRecord (const int &index=0, const SelectionType type=UNKNOWN, const string &p1="", const string &p2="")
 
 SelectionRecord (const std::string str)
 
std::string to_string () const
 
std::string to_repr () const
 

Public Attributes

int index
 
string p1
 
string p2
 
SelectionType selectionType
 

Detailed Description

a way to find sbml model elements using the RoadRunner syntax.

Member Enumeration Documentation

Enumerator
CONCENTRATION 

species must have either a CONCENTRATION or AMOUNT modifer to distinguish it.

BOUNDARY 

species must have either a BOUNDARY or FLOATING modifiers.

_COMPARTMENT 

Compartments and parameters can be either current or initial values. These values with and underscore, '_' are intended to be used with either an CURRENT or INITIAL value modifier.

INITIAL 

sbml elements can be accessed as either a initial value, or a current value, they must have one or the other.

EIGENVALUE 

eigenvalue without complex is real part of eigenvalue.

COMPLEX 

the complex bit, off to get real values, on to get imaginary parts.

Only used with EIGENVALUE currently.

EIGENVALUE_COMPLEX 

complex eigenvalue

COMPARTMENT 

the current compartment value

GLOBAL_PARAMETER 

the current global parameter value

FLOATING_AMOUNT 

current amounts

BOUNDARY_CONCENTRATION 

current concentrations

FLOATING_AMOUNT_RATE 

floating species value rates (value, not reaction rates), these are always current

REACTION_RATE 

reaction rate, always current

INITIAL_AMOUNT 

initial species values

DEPENDENT_INITIAL_GLOBAL_PARAMETER 

Global parameters that have initial assignment rules.

MODEL_STATE 

The combination of values that uniquely define the current state of the sbml model.

Note, any sbml variable can be defined by a rule, the model state is defined as the set of variabls that define the current state of the model. These do not include the initial values as the initial values can not be changed by advancing the model with the integrator.

SBML_INITIALIZE 

If this bit is set, then the reset function evaluates all of the SBML model init conditions (init values and all init assignment rules), and assigns them to the model state variable. This setting brings the model back the originally loaded state.

Constructor & Destructor Documentation

rr::SelectionRecord::SelectionRecord ( const int &  index = 0,
const SelectionType  type = UNKNOWN,
const string &  p1 = "",
const string &  p2 = "" 
)

Selections really should be constructed by the RoadRunner::createSelection method.

This just creates a new ebmpy selection.

rr::SelectionRecord::SelectionRecord ( const std::string  str)

creates a empty selection.

Member Function Documentation

std::string rr::SelectionRecord::to_repr ( ) const

gets a longer description of this selection, this is intended to called as a python repr

std::string rr::SelectionRecord::to_string ( ) const

get a short description of this selection, this returns a string compatable with RoadRunner::createSelection.

Member Data Documentation

int rr::SelectionRecord::index

After the selection record is created by the roadrunner object, this is an index into the variables list that the ExecutableModel has.

string rr::SelectionRecord::p1

For single argument selections, i.e. ee( S1 ), this is the argument, for two arg selections, this is the first arg.

string rr::SelectionRecord::p2

the second argument of two arg selections.

SelectionType rr::SelectionRecord::selectionType

the type of selection.


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