libSBML C++ API  5.20.4
List of all members | Public Member Functions
MultiASTPlugin Class Reference
Multistate, Multicomponent and Multicompartment Species
Inheritance diagram for MultiASTPlugin:
[legend]

Detailed Description

multi Extension of ASTBasePlugin.

This class of objects is defined by libSBML only and has no direct equivalent in terms of SBML components. This class is not prescribed by the SBML specifications, although it is used to implement features defined in SBML.

The MultiASTPlugin object is used to extend the standard SBML AST (abstract syntax tree) base object (ASTBase) to allow a "ci" element (AST_NAME) to have an optional "speciesReference" attribute. This attribute is used to distinguish which version of a Species should be used in the mathematics. If a "template" type Species appears as both a reactant and a product in the same Reaction, for example, it may have one amount as a reactant and a different amount as a product, since the same template is being used to match slightly different pools of elements in each case. By defining the "speciesReference" attribute on an AST_NAME that references that Species, the modeler may determine which amount is being referenced. Similarly, an AST_NAME node may reference a SpeciesFeature that appears in multiple Species in the Reaction, and this attribute can be used to specify which one should be used.

Public Member Functions

virtual MultiASTPlugin * clone () const
 Creates and returns a deep copy of this MultiASTPlugin object. More...
 
const std::string & getRepresentationType () const
 Returns the value of the "representationType" attribute of this MultiASTPlugin. More...
 
const std::string & getSpeciesReference () const
 Returns the value of the "speciesReference" attribute of this MultiASTPlugin. More...
 
bool isSetRepresentationType () const
 Predicate returning true if this MultiASTPlugin's "representationType" attribute is set. More...
 
bool isSetSpeciesReference () const
 Predicate returning true if this MultiASTPlugin's "speciesReference" attribute is set. More...
 
 MultiASTPlugin (const MultiASTPlugin &orig)
 Copy constructor. More...
 
 MultiASTPlugin (const std::string &uri)
 Creates a new MultiASTPlugin object using the given parameters. More...
 
MultiASTPlugin & operator= (const MultiASTPlugin &orig)
 Assignment operator for MultiModelPlugin. More...
 
virtual void renameSIdRefs (const std::string &oldid, const std::string &newid)
 Renames the speciesReference SIdRef attribute on this node. More...
 
int setRepresentationType (const std::string &representationType)
 Sets the value of the "representationType" attribute of this MultiASTPlugin. More...
 
int setSpeciesReference (const std::string &speciesReference)
 Sets the value of the "speciesReference" attribute of this MultiASTPlugin. More...
 
int unsetRepresentationType ()
 Unsets the value of the "representationType" attribute of this MultiASTPlugin. More...
 
int unsetSpeciesReference ()
 Unsets the value of the "speciesReference" attribute of this MultiASTPlugin. More...
 
virtual ~MultiASTPlugin ()
 Destructor for MultiASTPlugin. More...
 

Constructor & Destructor Documentation

◆ MultiASTPlugin() [1/2]

MultiASTPlugin::MultiASTPlugin ( const std::string &  uri)

Creates a new MultiASTPlugin object using the given parameters.

In the XML representation of an SBML document, XML namespaces are used to identify the origin of each XML construct used. XML namespaces are identified by their unique resource identifiers (URIs). The core SBML specifications stipulate the namespaces that must be used for core SBML constructs; for example, all XML elements that belong to SBML Level 3 Version 1 Core must be placed in the XML namespace identified by the URI "http://www.sbml.org/sbml/level3/version1/core". Individual SBML Level 3 packages define their own XML namespaces; for example, all elements belonging to the SBML Level 3 Layout Version 1 package must be placed in the XML namespace "http://www.sbml.org/sbml/level3/version1/layout/version1/".
Parameters
urithe URI of the SBML Level 3 package implemented by this libSBML package extension.

◆ MultiASTPlugin() [2/2]

MultiASTPlugin::MultiASTPlugin ( const MultiASTPlugin &  orig)

Copy constructor.

Parameters
origthe MultiASTPlugin instance to copy.

◆ ~MultiASTPlugin()

MultiASTPlugin::~MultiASTPlugin ( )
virtual

Destructor for MultiASTPlugin.

Member Function Documentation

◆ clone()

MultiASTPlugin * MultiASTPlugin::clone ( ) const
virtual

Creates and returns a deep copy of this MultiASTPlugin object.

Returns
a (deep) copy of this SBase object

◆ getRepresentationType()

const std::string& MultiASTPlugin::getRepresentationType ( ) const

Returns the value of the "representationType" attribute of this MultiASTPlugin.

Returns
the value of the "representationType" attribute of this MultiASTPlugin as a string.

◆ getSpeciesReference()

const std::string& MultiASTPlugin::getSpeciesReference ( ) const

Returns the value of the "speciesReference" attribute of this MultiASTPlugin.

Returns
the value of the "speciesReference" attribute of this MultiASTPlugin as a string.

◆ isSetRepresentationType()

bool MultiASTPlugin::isSetRepresentationType ( ) const

Predicate returning true if this MultiASTPlugin's "representationType" attribute is set.

Returns
true if this MultiASTPlugin's "representationType" attribute has been set, otherwise false is returned.

◆ isSetSpeciesReference()

bool MultiASTPlugin::isSetSpeciesReference ( ) const

Predicate returning true if this MultiASTPlugin's "speciesReference" attribute is set.

Returns
true if this MultiASTPlugin's "speciesReference" attribute has been set, otherwise false is returned.

◆ operator=()

MultiASTPlugin & MultiASTPlugin::operator= ( const MultiASTPlugin &  orig)

Assignment operator for MultiModelPlugin.

Parameters
origthe object whose values are used as the basis of the assignment.

◆ renameSIdRefs()

virtual void MultiASTPlugin::renameSIdRefs ( const std::string &  oldid,
const std::string &  newid 
)
virtual

Renames the speciesReference SIdRef attribute on this node.

Parameters
oldidthe old identifier.
newidthe new identifier.

◆ setRepresentationType()

int MultiASTPlugin::setRepresentationType ( const std::string &  representationType)

Sets the value of the "representationType" attribute of this MultiASTPlugin.

Parameters
representationTypestd::string& value of the "representationType" attribute to be set.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value: Calling this function with representationType = NULL or an empty string is equivalent to calling unsetRepresentationType().

◆ setSpeciesReference()

int MultiASTPlugin::setSpeciesReference ( const std::string &  speciesReference)

Sets the value of the "speciesReference" attribute of this MultiASTPlugin.

Parameters
speciesReferencestd::string& value of the "speciesReference" attribute to be set.
Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value: Calling this function with speciesReference = NULL or an empty string is equivalent to calling unsetSpeciesReference().

◆ unsetRepresentationType()

int MultiASTPlugin::unsetRepresentationType ( )

Unsets the value of the "representationType" attribute of this MultiASTPlugin.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value:

◆ unsetSpeciesReference()

int MultiASTPlugin::unsetSpeciesReference ( )

Unsets the value of the "speciesReference" attribute of this MultiASTPlugin.

Returns
integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. This particular function only does one thing irrespective of user input or object state, and thus will only return a single value: