rr::SelectionRecord Class Reference

#include <rrSelectionRecord.h>

Public Types
enum	SelectionType { ,   CONCENTRATION = (0x1 << 1) , BOUNDARY = (0x1 << 4) , _COMPARTMENT = (0x1 << 6) , INITIAL = (0x1 << 9) ,   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_FLOATING_AMOUNT = INITIAL | FLOATING | AMOUNT | INDEPENDENT | DEPENDENT }

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

enum rr::SelectionRecord::SelectionType

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.
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_FLOATING_AMOUNT	initial floating species values

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:

• rrSelectionRecord.h
• rrSelectionRecord.cpp