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

Detailed Description

comp The core module of the 'comp' package extension.

Public Member Functions

virtual void addL2Namespaces (XMLNamespaces *xmlns) const
 adds all L2 Extension namespaces to the namespace list. More...
 
virtual CompExtensionclone () const
 Creates and returns a deep copy of this CompExtension object. More...
 
 CompExtension ()
 Constructor. More...
 
 CompExtension (const CompExtension &)
 Copy constructor. More...
 
virtual void enableL2NamespaceForDocument (SBMLDocument *doc) const
 Adds the L2 Namespace to the document and enables the extension. More...
 
virtual unsigned int getLevel (const std::string &uri) const
 Returns the SBML Level with the given URI of this package. More...
 
virtual const std::string & getName () const
 Returns the name of this package as a short-form label ("comp"). More...
 
int getNumOfSBasePlugins () const
 Returns the number of SBasePlugin objects stored in this object. More...
 
unsigned int getNumOfSupportedPackageURI () const
 Returns the number of supported package Namespace (package versions) of this package extension. More...
 
virtual unsigned int getPackageVersion (const std::string &uri) const
 Returns the package version with the given URI of this package. More...
 
virtual SBMLNamespacesgetSBMLExtensionNamespaces (const std::string &uri) const
 Returns an SBMLExtensionNamespaces<CompExtension> object whose alias type is CompPkgNamespace. More...
 
virtual const char * getStringFromTypeCode (int typeCode) const
 This method takes a type code of comp package and returns a string representing the code. More...
 
const std::string & getSupportedPackageURI (unsigned int i) const
 Returns the ith URI (the supported package version) More...
 
virtual const std::string & getURI (unsigned int sbmlLevel, unsigned int sbmlVersion, unsigned int pkgVersion) const
 Returns the URI (namespace) of the package corresponding to the combination of the given SBML Level, SBML Version, and Level 3 package version. More...
 
virtual unsigned int getVersion (const std::string &uri) const
 Returns the SBML version with the given URI of this package. More...
 
bool isEnabled () const
 Check if this package is enabled (true) or disabled (false). More...
 
virtual bool isInUse (SBMLDocument *doc) const
 Determines whether this extension is being used by the given SBMLDocument. More...
 
bool isSupported (const std::string &uri) const
 Returns a flag indicating, whether the given URI (package version) is supported by this package extension. More...
 
CompExtensionoperator= (const CompExtension &)
 Assignment operator for CompExtension. More...
 
virtual void removeL2Namespaces (XMLNamespaces *xmlns) const
 Removes the L2 Namespaces. More...
 
bool setEnabled (bool isEnabled)
 enable/disable this package. More...
 
virtual ~CompExtension ()
 Destroy this object. More...
 

Static Public Member Functions

static unsigned int getDefaultLevel ()
 Returns the default SBML Level this extension. More...
 
static unsigned int getDefaultPackageVersion ()
 Returns the default SBML version this extension. More...
 
static unsigned int getDefaultVersion ()
 Returns the default SBML Version this extension. More...
 
static const std::string & getPackageName ()
 Returns the package name of this extension. More...
 
static const std::string & getXmlnsL3V1V1 ()
 Returns URI of supported versions of this package. More...
 

Constructor & Destructor Documentation

CompExtension::CompExtension ( )

Constructor.

CompExtension::CompExtension ( const CompExtension orig)

Copy constructor.

CompExtension::~CompExtension ( )
virtual

Destroy this object.

Member Function Documentation

void SBMLExtension::addL2Namespaces ( XMLNamespaces xmlns) const
virtualinherited

adds all L2 Extension namespaces to the namespace list.

adds the L2 Namespace

This method should be overridden by all extensions that want to serialize to an L2 annotation.

CompExtension * CompExtension::clone ( ) const
virtual

Creates and returns a deep copy of this CompExtension object.

Returns
a (deep) copy of this CompExtension object

Implements SBMLExtension.

void SBMLExtension::enableL2NamespaceForDocument ( SBMLDocument doc) const
virtualinherited

Adds the L2 Namespace to the document and enables the extension.

If the extension supports serialization to SBML L2 Annotations, this method should be overrridden, so it will be activated.

unsigned int CompExtension::getDefaultLevel ( )
static

Returns the default SBML Level this extension.

unsigned int CompExtension::getDefaultPackageVersion ( )
static

Returns the default SBML version this extension.

unsigned int CompExtension::getDefaultVersion ( )
static

Returns the default SBML Version this extension.

unsigned int CompExtension::getLevel ( const std::string &  uri) const
virtual

Returns the SBML Level with the given URI of this package.

Parameters
urithe string of URI that represents one of versions of the comp package.
Returns
the SBML level with the given URI of this package. 0 will be returned if the given URI is invalid.

Implements SBMLExtension.

const std::string & CompExtension::getName ( ) const
virtual

Returns the name of this package as a short-form label ("comp").

Returns
the name of this package.

Implements SBMLExtension.

int SBMLExtension::getNumOfSBasePlugins ( ) const
inherited

Returns the number of SBasePlugin objects stored in this object.

Returns
the number of SBasePlugin objects stored in this object.
unsigned int SBMLExtension::getNumOfSupportedPackageURI ( ) const
inherited

Returns the number of supported package Namespace (package versions) of this package extension.

Returns
the number of supported package Namespace (package versions) of this package extension.
const std::string & CompExtension::getPackageName ( )
static

Returns the package name of this extension.

unsigned int CompExtension::getPackageVersion ( const std::string &  uri) const
virtual

Returns the package version with the given URI of this package.

Parameters
urithe string of URI that represents one of versions of comp package.
Returns
the package version with the given URI of this package. 0 will be returned if the given URI is invalid.

Implements SBMLExtension.

SBMLNamespaces * CompExtension::getSBMLExtensionNamespaces ( const std::string &  uri) const
virtual

Returns an SBMLExtensionNamespaces<CompExtension> object whose alias type is CompPkgNamespace.

Parameters
urithe string of URI that represents one of versions of comp package.
Returns
an CompPkgNamespace object corresponding to the given URI. NULL will be returned if the given URI is not defined in comp package.

Implements SBMLExtension.

const char * CompExtension::getStringFromTypeCode ( int  typeCode) const
virtual

This method takes a type code of comp package and returns a string representing the code.

Parameters
typeCodethe libSBML typecode in question.
Returns
a string representing the libSBML type code.

Implements SBMLExtension.

const std::string & SBMLExtension::getSupportedPackageURI ( unsigned int  i) const
inherited

Returns the ith URI (the supported package version)

Parameters
ithe index of the list of URI (the list of supporeted pacakge versions)
Returns
the URI of supported package version with the given index.
const std::string & CompExtension::getURI ( unsigned int  sbmlLevel,
unsigned int  sbmlVersion,
unsigned int  pkgVersion 
) const
virtual

Returns the URI (namespace) of the package corresponding to the combination of the given SBML Level, SBML Version, and Level 3 package version.

Parameters
sbmlLevelthe level of SBML
sbmlVersionthe version of SBML
pkgVersionthe version of package
Returns
a string of the package URI. An empty string will be returned if no corresponding URI exists.

Implements SBMLExtension.

unsigned int CompExtension::getVersion ( const std::string &  uri) const
virtual

Returns the SBML version with the given URI of this package.

Parameters
urithe string of URI that represents one of versions of comp package.
Returns
the SBML version with the given URI of this package. 0 will be returned if the given URI is invalid.

Implements SBMLExtension.

const std::string & CompExtension::getXmlnsL3V1V1 ( )
static

Returns URI of supported versions of this package.

bool SBMLExtension::isEnabled ( ) const
inherited

Check if this package is enabled (true) or disabled (false).

Returns
true if this package is enabled, otherwise false is returned.
bool SBMLExtension::isInUse ( SBMLDocument doc) const
virtualinherited

Determines whether this extension is being used by the given SBMLDocument.

The default implementation returns true. This means that when a document had this extension enabled, it will not be possible to convert it to L2 as we cannot make sure that the extension can be converted.

Parameters
docthe sbml document to test.
Returns
a boolean indicating whether the extension is actually being used byy the document.
bool SBMLExtension::isSupported ( const std::string &  uri) const
inherited

Returns a flag indicating, whether the given URI (package version) is supported by this package extension.

Returns
true if the given URI (package version) is supported by this package extension, otherwise false is returned.
CompExtension & CompExtension::operator= ( const CompExtension orig)

Assignment operator for CompExtension.

void SBMLExtension::removeL2Namespaces ( XMLNamespaces xmlns) const
virtualinherited

Removes the L2 Namespaces.

Removes the L2 Namespace.

This method should be overridden by all extensions that want to serialize to an L2 annotation.

bool SBMLExtension::setEnabled ( bool  isEnabled)
inherited

enable/disable this package.

Returned value is the result of this function.

Parameters
isEnabledthe bool value: true (enabled) or false (disabled)
Returns
true if this function call succeeded, otherwise false is returned.