Tissue Forge C++ 0.2.1
Interactive, particle-based physics, chemistry and biology modeling and simulation environment
Loading...
Searching...
No Matches
TissueForge::state::Species Struct Reference

The Tissue Forge species object. More...

#include <tfSpecies.h>

Public Member Functions

int32_t flags () const
 
std::string str () const
 
void initDefaults ()
 
const std::string getId () const
 
int setId (const char *sid)
 
const std::string getName () const
 
int setName (const char *name)
 
const std::string getSpeciesType () const
 
int setSpeciesType (const char *sid)
 
const std::string getCompartment () const
 
int setCompartment (const char *sid)
 
FloatP_t getInitialAmount () const
 
int setInitialAmount (FloatP_t value)
 
FloatP_t getInitialConcentration () const
 
int setInitialConcentration (FloatP_t value)
 
const std::string getSubstanceUnits () const
 
int setSubstanceUnits (const char *sid)
 
const std::string getSpatialSizeUnits () const
 
int setSpatialSizeUnits (const char *sid)
 
const std::string getUnits () const
 
int setUnits (const char *sname)
 
bool getHasOnlySubstanceUnits () const
 
int setHasOnlySubstanceUnits (int value)
 
bool getBoundaryCondition () const
 
int setBoundaryCondition (int value)
 
int getCharge () const
 
int setCharge (int value)
 
bool getConstant () const
 
int setConstant (int value)
 
const std::string getConversionFactor () const
 
int setConversionFactor (const char *sid)
 
bool isSetId () const
 
bool isSetName () const
 
bool isSetSpeciesType () const
 
bool isSetCompartment () const
 
bool isSetInitialAmount () const
 
bool isSetInitialConcentration () const
 
bool isSetSubstanceUnits () const
 
bool isSetSpatialSizeUnits () const
 
bool isSetUnits () const
 
bool isSetCharge () const
 
bool isSetConversionFactor () const
 
bool isSetConstant () const
 
bool isSetBoundaryCondition () const
 
bool isSetHasOnlySubstanceUnits () const
 
int unsetId ()
 
int unsetName ()
 
int unsetConstant ()
 
int unsetSpeciesType ()
 
int unsetInitialAmount ()
 
int unsetInitialConcentration ()
 
int unsetSubstanceUnits ()
 
int unsetSpatialSizeUnits ()
 
int unsetUnits ()
 
int unsetCharge ()
 
int unsetConversionFactor ()
 
int unsetCompartment ()
 
int unsetBoundaryCondition ()
 
int unsetHasOnlySubstanceUnits ()
 
int hasRequiredAttributes ()
 
 Species (const std::string &s)
 
 Species (const Species &other)
 
std::string toString ()
 Get a JSON string representation.
 

Static Public Member Functions

static SpeciesfromString (const std::string &str)
 Create from a JSON string representation.
 

Public Attributes

libsbml::Species * species
 

Detailed Description

The Tissue Forge species object.

Mostly, this is a wrap of libSBML Species.

Member Function Documentation

◆ fromString()

static Species * TissueForge::state::Species::fromString ( const std::string & str)
static

Create from a JSON string representation.

Parameters
str
Returns
Species*

◆ toString()

std::string TissueForge::state::Species::toString ( )

Get a JSON string representation.

Returns
std::string

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