Inheritance diagram for SpatialCompartmentPlugin:

Detailed Description

Public Member Functions
virtual SpatialCompartmentPlugin *	clone () const
	Creates and returns a deep copy of this SpatialCompartmentPlugin object. More...

CompartmentMapping *	createCompartmentMapping ()
	Creates a new CompartmentMapping object, adds it to this SpatialCompartmentPlugin object and returns the CompartmentMapping object created. More...

virtual List *	getAllElements (ElementFilter *filter=NULL)
	Returns a List of all child SBase objects, including those nested to an arbitrary depth. More...

CompartmentMapping *	getCompartmentMapping ()
	Returns the value of the "compartmentMapping" element of this SpatialCompartmentPlugin. More...

const CompartmentMapping *	getCompartmentMapping () const
	Returns the value of the "compartmentMapping" element of this SpatialCompartmentPlugin. More...

virtual SBase *	getElementByMetaId (const std::string &metaid)
	Returns the first child element that has the given `metaid`, or `NULL` if no such object is found. More...

virtual SBase *	getElementBySId (const std::string &id)
	Returns the first child element that has the given `id` in the model-wide SId namespace, or `NULL` if no such object is found. More...

const std::string &	getElementNamespace () const
	Returns the namespace URI of the package to which this plugin object belongs. More...

unsigned int	getLevel () const
	Returns the SBML Level of the package extension of this plugin object. More...

const std::string &	getPackageName () const
	Returns the short-form name of the package to which this plugin object belongs. More...

unsigned int	getPackageVersion () const
	Returns the package version of the package extension of this plugin object. More...

SBase *	getParentSBMLObject ()
	Returns the parent object to which this plugin object is connected. More...

const SBase *	getParentSBMLObject () const
	Returns the parent object to which this plugin object is connected. More...

const std::string &	getPrefix () const
	Returns the XML namespace prefix of the package to which this plugin object belongs. More...

SBMLDocument *	getSBMLDocument ()
	Returns the SBMLDocument object containing this object instance. More...

const SBMLDocument *	getSBMLDocument () const
	Returns the SBMLDocument object containing this object instance. More...

std::string	getURI () const
	Returns the XML namespace URI for the package to which this object belongs. More...

unsigned int	getVersion () const
	Returns the Version within the SBML Level of the package extension of this plugin object. More...

bool	isSetCompartmentMapping () const
	Predicate returning `true` if this SpatialCompartmentPlugin's "compartmentMapping" element is set. More...

virtual bool	isValidTypeForList (SBase *item) const

SpatialCompartmentPlugin &	operator= (const SpatialCompartmentPlugin &rhs)
	Assignment operator for SpatialCompartmentPlugin. More...

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

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

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

int	setCompartmentMapping (const CompartmentMapping *compartmentMapping)
	Sets the value of the "compartmentMapping" element of this SpatialCompartmentPlugin. More...

int	setElementNamespace (const std::string &uri)
	Sets the XML namespace to which this object belongs. More...

	SpatialCompartmentPlugin (const SpatialCompartmentPlugin &orig)
	Copy constructor for SpatialCompartmentPlugin. More...

	SpatialCompartmentPlugin (const std::string &uri, const std::string &prefix, SpatialPkgNamespaces *spatialns)
	Creates a new SpatialCompartmentPlugin using the given URI, prefix and package namespace. More...

int	unsetCompartmentMapping ()
	Unsets the value of the "compartmentMapping" element of this SpatialCompartmentPlugin. More...

virtual	~SpatialCompartmentPlugin ()
	Destructor for SpatialCompartmentPlugin. More...

Constructor & Destructor Documentation

◆ SpatialCompartmentPlugin() [1/2]

SpatialCompartmentPlugin::SpatialCompartmentPlugin	(	const std::string &	uri,
		const std::string &	prefix,
		SpatialPkgNamespaces *	spatialns
	)

Creates a new SpatialCompartmentPlugin using the given URI, prefix and package namespace.

Parameters

uri	a string, representing the URI of the SBML Level 3 package implemented by this libSBML package extension.
prefix	a string, the XML namespace prefix being used for this package.
spatialns	a pointer to the namesspaces object (SpatialPkgNamespaces) for this package.

: 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/".

: The SBMLNamespaces object encapsulates SBML Level/Version/namespaces information. It is used to communicate the SBML Level, Version, and (in Level 3) packages used in addition to SBML Level 3 Core. A common approach to using libSBML's SBMLNamespaces facilities is to create an SBMLNamespaces object somewhere in a program once, then hand that object as needed to object constructors that accept SBMLNamespaces as arguments.

◆ SpatialCompartmentPlugin() [2/2]

SpatialCompartmentPlugin::SpatialCompartmentPlugin ( const SpatialCompartmentPlugin & orig )

Copy constructor for SpatialCompartmentPlugin.

Parameters

orig	the SpatialCompartmentPlugin instance to copy.

◆ ~SpatialCompartmentPlugin()

SpatialCompartmentPlugin::~SpatialCompartmentPlugin ( )

virtual

Destructor for SpatialCompartmentPlugin.

Member Function Documentation

◆ clone()

SpatialCompartmentPlugin * SpatialCompartmentPlugin::clone ( ) const

virtual

Creates and returns a deep copy of this SpatialCompartmentPlugin object.

Returns: a (deep) copy of this SpatialCompartmentPlugin object.

Reimplemented from SBasePlugin.

◆ createCompartmentMapping()

CompartmentMapping * SpatialCompartmentPlugin::createCompartmentMapping ( )

Creates a new CompartmentMapping object, adds it to this SpatialCompartmentPlugin object and returns the CompartmentMapping object created.

Returns: a new CompartmentMapping object instance.

◆ getAllElements()

List * SpatialCompartmentPlugin::getAllElements ( ElementFilter * filter = NULL )

virtual

Returns a List of all child SBase objects, including those nested to an arbitrary depth.

Parameters

filter an ElementFilter that may impose restrictions on the objects to be retrieved.

Returns: a List* pointer of pointers to all SBase child objects with any restriction imposed.

Reimplemented from SBasePlugin.

◆ getCompartmentMapping() [1/2]

CompartmentMapping * SpatialCompartmentPlugin::getCompartmentMapping ( )

Returns the value of the "compartmentMapping" element of this SpatialCompartmentPlugin.

Returns: the value of the "compartmentMapping" element of this SpatialCompartmentPlugin as a CompartmentMapping*.

◆ getCompartmentMapping() [2/2]

const CompartmentMapping * SpatialCompartmentPlugin::getCompartmentMapping ( ) const

Returns the value of the "compartmentMapping" element of this SpatialCompartmentPlugin.

Returns: the value of the "compartmentMapping" element of this SpatialCompartmentPlugin as a CompartmentMapping*.

◆ getElementByMetaId()

SBase * SpatialCompartmentPlugin::getElementByMetaId ( const std::string & metaid )

virtual

Returns the first child element that has the given metaid, or NULL if no such object is found.

Parameters

metaid a string representing the metaid attribute of the object to retrieve.

Returns: a pointer to the SBase element with the given metaid. If no such object is found this method returns NULL.

Reimplemented from SBasePlugin.

◆ getElementBySId()

SBase * SpatialCompartmentPlugin::getElementBySId ( const std::string & id )

virtual

Returns the first child element that has the given id in the model-wide SId namespace, or NULL if no such object is found.

Parameters

id	a string representing the id attribute of the object to retrieve.

Returns: a pointer to the SBase element with the given id. If no such object is found, this method returns NULL.

Reimplemented from SBasePlugin.

◆ getElementNamespace()

const std::string & SBasePlugin::getElementNamespace ( ) const

inherited

Returns the namespace URI of the package to which this plugin object belongs.

Returns: the XML namespace URI of the SBML Level 3 package implemented by this libSBML package extension.

◆ getLevel()

unsigned int SBasePlugin::getLevel ( ) const

inherited

Returns the SBML Level of the package extension of this plugin object.

Returns: the SBML Level.

See also: getVersion()

◆ getPackageName()

const std::string & SBasePlugin::getPackageName ( ) const

inherited

Returns the short-form name of the package to which this plugin object belongs.

Returns: the short-form package name (or nickname) of the SBML package implemented by this package extension.

◆ getPackageVersion()

unsigned int SBasePlugin::getPackageVersion ( ) const

inherited

Returns the package version of the package extension of this plugin object.

Returns: the package version of the package extension of this plugin object.

See also: getLevel(); getVersion()

◆ getParentSBMLObject() [1/2]

SBase * SBasePlugin::getParentSBMLObject ( )

inherited

Returns the parent object to which this plugin object is connected.

Returns: the parent object of this object.

◆ getParentSBMLObject() [2/2]

const SBase * SBasePlugin::getParentSBMLObject ( ) const

inherited

Returns the parent object to which this plugin object is connected.

Returns: the parent object of this object.

◆ getPrefix()

const std::string & SBasePlugin::getPrefix ( ) const

inherited

Returns the XML namespace prefix of the package to which this plugin object belongs.

Returns: the XML namespace prefix of the SBML Level 3 package implemented by this libSBML package extension.

◆ getSBMLDocument() [1/2]

SBMLDocument * SBasePlugin::getSBMLDocument ( )

inherited

Returns the SBMLDocument object containing this object instance.

: LibSBML uses the class SBMLDocument as a top-level container for storing SBML content and data associated with it (such as warnings and error messages). An SBML model in libSBML is contained inside an SBMLDocument object. SBMLDocument corresponds roughly to the class SBML defined in the SBML Level 3 and Level 2 specifications, but it does not have a direct correspondence in SBML Level 1. (But, it is created by libSBML no matter whether the model is Level 1, Level 2 or Level 3.)

This method allows the caller to obtain the SBMLDocument for the current object.

Returns: the parent SBMLDocument object of this plugin object.

See also: getParentSBMLObject()

◆ getSBMLDocument() [2/2]

const SBMLDocument * SBasePlugin::getSBMLDocument ( ) const

inherited

Returns the SBMLDocument object containing this object instance.

: LibSBML uses the class SBMLDocument as a top-level container for storing SBML content and data associated with it (such as warnings and error messages). An SBML model in libSBML is contained inside an SBMLDocument object. SBMLDocument corresponds roughly to the class SBML defined in the SBML Level 3 and Level 2 specifications, but it does not have a direct correspondence in SBML Level 1. (But, it is created by libSBML no matter whether the model is Level 1, Level 2 or Level 3.)

This method allows the caller to obtain the SBMLDocument for the current object.

Returns: the parent SBMLDocument object of this plugin object.

See also: getParentSBMLObject()

◆ getURI()

std::string SBasePlugin::getURI ( ) const

inherited

Returns the XML namespace URI for the package to which this object belongs.

: 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/".

This method first looks into the SBMLNamespaces object possessed by the parent SBMLDocument object of the current object. If this cannot be found, this method returns the result of getElementNamespace().

Returns: a string, the URI of the XML namespace to which this object belongs.

See also: getPackageName(); getElementNamespace(); getSBMLDocument()

◆ getVersion()

unsigned int SBasePlugin::getVersion ( ) const

inherited

Returns the Version within the SBML Level of the package extension of this plugin object.

Returns: the SBML Version.

See also: getLevel()

◆ isSetCompartmentMapping()

bool SpatialCompartmentPlugin::isSetCompartmentMapping ( ) const

Predicate returning true if this SpatialCompartmentPlugin's "compartmentMapping" element is set.

Returns: true if this SpatialCompartmentPlugin's "compartmentMapping" element has been set, otherwise false is returned.

◆ isValidTypeForList()

virtual bool SBasePlugin::isValidTypeForList ( SBase * item ) const

virtualinherited

◆ operator=()

SpatialCompartmentPlugin & SpatialCompartmentPlugin::operator= ( const SpatialCompartmentPlugin & rhs )

Assignment operator for SpatialCompartmentPlugin.

Parameters

rhs	the SpatialCompartmentPlugin object whose values are to be used as the basis of the assignment.

◆ renameMetaIdRefs()

virtual void SBasePlugin::renameMetaIdRefs	(	const std::string &	oldid,
		const std::string &	newid
	)

virtualinherited

: Replaces all uses of a given meta identifier attribute value with another value.

: In SBML, object "meta" identifiers are of the XML data type ID; the SBML object attribute itself is typically named metaid. All attributes that hold values referring to values of type ID are of the XML data type IDREF. They are also sometimes informally referred to as "metaid refs", in analogy to the SBML-defined type SIdRef.

This method works by looking at all meta-identifier attribute values, comparing the identifiers to the value of oldid. If any matches are found, the matching identifiers are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

◆ renameSIdRefs()

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

virtualinherited

: Replaces all uses of a given SIdRef type attribute value with another value.

In SBML, object identifiers are of a data type called SId. In SBML Level 3, an explicit data type called SIdRef was introduced for attribute values that refer to SId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as "referring to an identifier", but the effective data type was the same as SIdRef in Level 3. These and other methods of libSBML refer to the type SIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.

This method works by looking at all attributes and (if appropriate) mathematical formulas in MathML content, comparing the referenced identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

Reimplemented in FbcReactionPlugin.

◆ renameUnitSIdRefs()

virtual void SBasePlugin::renameUnitSIdRefs	(	const std::string &	oldid,
		const std::string &	newid
	)

virtualinherited

: Replaces all uses of a given UnitSIdRef type attribute value with another value.

: In SBML, unit definitions have identifiers of type UnitSId. In SBML Level 3, an explicit data type called UnitSIdRef was introduced for attribute values that refer to UnitSId values; in previous Levels of SBML, this data type did not exist and attributes were simply described to as "referring to a unit identifier", but the effective data type was the same as UnitSIdRef in Level 3. These and other methods of libSBML refer to the type UnitSIdRef for all Levels of SBML, even if the corresponding SBML specification did not explicitly name the data type.

This method works by looking at all unit identifier attribute values (including, if appropriate, inside mathematical formulas), comparing the referenced unit identifiers to the value of oldid. If any matches are found, the matching values are replaced with newid. The method does not descend into child elements.

Parameters

oldid	the old identifier.
newid	the new identifier.

◆ setCompartmentMapping()

int SpatialCompartmentPlugin::setCompartmentMapping ( const CompartmentMapping * compartmentMapping )

Sets the value of the "compartmentMapping" element of this SpatialCompartmentPlugin.

Parameters

compartmentMapping CompartmentMapping* value of the "compartmentMapping" element to be set.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

◆ setElementNamespace()

int SBasePlugin::setElementNamespace ( const std::string & uri )

inherited

Sets the XML namespace to which this object belongs.

: 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

uri	the URI to assign to this object.

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:

LIBSBML_OPERATION_SUCCESS

See also: getElementNamespace()

Examples: convertLayout.cpp.

◆ unsetCompartmentMapping()

int SpatialCompartmentPlugin::unsetCompartmentMapping ( )

Unsets the value of the "compartmentMapping" element of this SpatialCompartmentPlugin.

Returns

integer value indicating success/failure of the function. The value is drawn from the enumeration OperationReturnValues_t. The possible values returned by this function are:

Detailed Description

Public Member Functions

Constructor & Destructor Documentation

◆ SpatialCompartmentPlugin() [1/2]

◆ SpatialCompartmentPlugin() [2/2]

◆ ~SpatialCompartmentPlugin()

Member Function Documentation

◆ clone()

◆ createCompartmentMapping()

◆ getAllElements()

◆ getCompartmentMapping() [1/2]

◆ getCompartmentMapping() [2/2]

◆ getElementByMetaId()

◆ getElementBySId()

◆ getElementNamespace()

◆ getLevel()

◆ getPackageName()

◆ getPackageVersion()

◆ getParentSBMLObject() [1/2]

◆ getParentSBMLObject() [2/2]

◆ getPrefix()

◆ getSBMLDocument() [1/2]

◆ getSBMLDocument() [2/2]

◆ getURI()

◆ getVersion()

◆ isSetCompartmentMapping()

◆ isValidTypeForList()

◆ operator=()

◆ renameMetaIdRefs()

◆ renameSIdRefs()

◆ renameUnitSIdRefs()

◆ setCompartmentMapping()

◆ setElementNamespace()

◆ unsetCompartmentMapping()