libSBML Perl API  libSBML 5.10.0 Perl API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
SBMLDocumentPlugin Class Reference
Inheritance diagram for SBMLDocumentPlugin:
[legend]

Detailed Description

{core} Template class for the SBMLDocument Plugin class needed by all packages.

Plugin objects for the SBMLDocument element must be this class or a derived class of this class. Package developers should use this class as-is if only "required" attribute is added in the SBMLDocument element by their packages. Otherwise, developers must implement a derived class of this class and use that class as the plugin object for the SBMLDocument element.

Public Member Functions

virtual SBMLDocumentPluginclone () const
 Creates and returns a deep copy of this SBMLDocumentPlugin object. More...
 
virtual ListgetAllElements (ElementFilter *filter=NULL)
 Returns a List of all child SBase objects, including those nested to an arbitrary depth. More...
 
virtual SBasegetElementByMetaId (const std::string &metaid)
 Returns the first child element it can find with the given metaid, or NULL if no such object is found. More...
 
virtual SBasegetElementBySId (const std::string &id)
 Returns the first child element found 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 XML namespace (URI) of the package extension of this plugin object. 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 package name of this plugin object. More...
 
unsigned int getPackageVersion () const
 Returns the package version of the package extension of this plugin object. More...
 
SBasegetParentSBMLObject ()
 Returns the parent SBase object to which this plugin object connected. More...
 
const SBasegetParentSBMLObject () const
 Returns the parent SBase object to which this plugin object connected. More...
 
const std::string & getPrefix () const
 Returns the prefix of the package extension of this plugin object. More...
 
virtual bool getRequired () const
 Returns the bool value of "required" attribute of corresponding package in SBMLDocument element. More...
 
SBMLDocumentgetSBMLDocument ()
 Returns the parent SBMLDocument of this plugin object. More...
 
const SBMLDocumentgetSBMLDocument () const
 Returns the parent SBMLDocument of this plugin object. More...
 
std::string getURI () const
 Gets the URI to which this element belongs to. More...
 
unsigned int getVersion () const
 Returns the SBML version of the package extension of this plugin object. More...
 
virtual bool isSetRequired () const
 Predicate returning true or false depending on whether this SBMLDocumentPlugin's "required" attribute has been set. More...
 
SBMLDocumentPluginoperator= (const SBMLDocumentPlugin &orig)
 Assignment operator for SBMLDocumentPlugin. More...
 
 SBMLDocumentPlugin (const std::string &uri, const std::string &prefix, SBMLNamespaces *sbmlns)
 Constructor. More...
 
 SBMLDocumentPlugin (const SBMLDocumentPlugin &orig)
 Copy constructor. More...
 
int setElementNamespace (const std::string &uri)
 Sets the XML namespace to which this element belongs to. More...
 
virtual int setRequired (bool value)
 Sets the bool value of "required" attribute of corresponding package in SBMLDocument element. More...
 
virtual int unsetRequired ()
 Unsets the value of the "required" attribute of this SBMLDocumentPlugin. More...
 
virtual ~SBMLDocumentPlugin ()
 Destroy this object. More...
 

Constructor & Destructor Documentation

SBMLDocumentPlugin::SBMLDocumentPlugin ( const std::string &  uri,
const std::string &  prefix,
SBMLNamespaces sbmlns 
)

Constructor.

Parameters
urithe URI of package
prefixthe prefix for the given package
sbmlnsthe SBMLNamespaces object for the package
SBMLDocumentPlugin::SBMLDocumentPlugin ( const SBMLDocumentPlugin orig)

Copy constructor.

Creates a copy of this object.

Creates a copy of this SBase object.

SBMLDocumentPlugin::~SBMLDocumentPlugin ( )
virtual

Destroy this object.

Member Function Documentation

SBMLDocumentPlugin * SBMLDocumentPlugin::clone ( ) const
virtual

Creates and returns a deep copy of this SBMLDocumentPlugin object.

Returns
a (deep) copy of this object
a (deep) copy of this SBase object

Implements SBasePlugin.

Reimplemented in CompSBMLDocumentPlugin, LayoutSBMLDocumentPlugin, QualSBMLDocumentPlugin, and FbcSBMLDocumentPlugin.

List * SBasePlugin::getAllElements ( ElementFilter *  filter = NULL)
virtualinherited

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

Returns
a List of pointers to all children objects.

Reimplemented in LayoutModelPlugin, FbcModelPlugin, CompModelPlugin, CompSBasePlugin, CompSBMLDocumentPlugin, and QualModelPlugin.

SBase * SBasePlugin::getElementByMetaId ( const std::string &  metaid)
virtualinherited

Returns the first child element it can find with the given metaid, or NULL if no such object is found.

Parameters
metaidstring representing the metaid of objects to find
Returns
pointer to the first element found with the given metaid.

Reimplemented in FbcModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.

SBase * SBasePlugin::getElementBySId ( const std::string &  id)
virtualinherited

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

Parameters
idstring representing the id of objects to find
Returns
pointer to the first element found with the given id.

Reimplemented in FbcModelPlugin, CompModelPlugin, CompSBasePlugin, and CompSBMLDocumentPlugin.

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

Returns the XML namespace (URI) of the package extension of this plugin object.

Returns
the URI of the package extension of this plugin object.
unsigned int SBasePlugin::getLevel ( ) const
inherited

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

Returns
the SBML level of the package extension of this plugin object.
const std::string & SBasePlugin::getPackageName ( ) const
inherited

Returns the package name of this plugin object.

Returns
the package name of this plugin object.
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.
SBase * SBasePlugin::getParentSBMLObject ( )
inherited

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

Returns
the parent SBase object to which this plugin object connected.
const SBase * SBasePlugin::getParentSBMLObject ( ) const
inherited

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

Returns
the parent SBase object to which this plugin object connected.
const std::string & SBasePlugin::getPrefix ( ) const
inherited

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

Returns
the prefix of the package extension of this plugin object.
bool SBMLDocumentPlugin::getRequired ( ) const
virtual

Returns the bool value of "required" attribute of corresponding package in SBMLDocument element.

(EXTENSION) Additional public functions

Returns
the bool value of "required" attribute of corresponding package in SBMLDocument element.
SBMLDocument * SBasePlugin::getSBMLDocument ( )
inherited

Returns the parent SBMLDocument of this plugin object.

Returns
the parent SBMLDocument object of this plugin object.
const SBMLDocument * SBasePlugin::getSBMLDocument ( ) const
inherited

Returns the parent SBMLDocument of this plugin object.

Returns
the parent SBMLDocument object of this plugin object.
std::string SBasePlugin::getURI ( ) const
inherited

Gets the URI to which this element belongs to.

For example, all elements that belong to SBML Level 3 Version 1 Core must would have the URI "http://www.sbml.org/sbml/level3/version1/core"; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must would have the URI "http://www.sbml.org/sbml/level3/version1/layout/version1/"

Unlike getElementNamespace, this function first returns the URI for this element by looking into the SBMLNamespaces object of the document with the its package name. if not found it will return the result of getElementNamespace

Returns
the URI this elements
See also
getPackageName()
getElementNamespace()
SBMLDocument::getSBMLNamespaces()
getSBMLDocument()
unsigned int SBasePlugin::getVersion ( ) const
inherited

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

Returns
the SBML version of the package extension of this plugin object.
bool SBMLDocumentPlugin::isSetRequired ( ) const
virtual

Predicate returning true or false depending on whether this SBMLDocumentPlugin's "required" attribute has been set.

Returns
true if the "required" attribute of this SBMLDocument has been set, false otherwise.
SBMLDocumentPlugin & SBMLDocumentPlugin::operator= ( const SBMLDocumentPlugin orig)

Assignment operator for SBMLDocumentPlugin.

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

Sets the XML namespace to which this element belongs to.

For example, all elements that belong to SBML Level 3 Version 1 Core must set the namespace to "http://www.sbml.org/sbml/level3/version1/core"; all elements that belong to Layout Extension Version 1 for SBML Level 3 Version 1 Core must set the namespace to "http://www.sbml.org/sbml/level3/version1/layout/version1/"

Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
int SBMLDocumentPlugin::setRequired ( bool  value)
virtual

Sets the bool value of "required" attribute of corresponding package in SBMLDocument element.

Parameters
valuethe bool value of "required" attribute of corresponding package in SBMLDocument element.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:

Reimplemented in CompSBMLDocumentPlugin.

int SBMLDocumentPlugin::unsetRequired ( )
virtual

Unsets the value of the "required" attribute of this SBMLDocumentPlugin.

Returns
integer value indicating success/failure of the function. The possible values returned by this function are: