libSBML Perl API  libSBML 5.16.0 Perl API
MultiASTPlugin Class Reference
Inheritance diagram for MultiASTPlugin:
[legend]

Detailed Description

{multi}

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 (

Public Member Functions

virtual void addExpectedAttributes (ExpectedAttributes &attributes, XMLInputStream &stream, int type)
 
virtual MultiASTPluginclone () const
 Creates and returns a deep copy of this MultiASTPlugin object. More...
 
const std::string & getRepresentationType () const
 
const std::string & getSpeciesReference () const
 
bool isSetRepresentationType () const
 
bool isSetSpeciesReference () const
 
 MultiASTPlugin (const std::string &uri)
 Creates a new MultiASTPlugin object using the given parameters. More...
 
 MultiASTPlugin (const MultiASTPlugin &orig)
 Copy constructor. More...
 
MultiASTPluginoperator= (const MultiASTPlugin &orig)
 Assignment operator for MultiModelPlugin. More...
 
virtual bool read (XMLInputStream &stream, const std::string &reqd_prefix, const XMLToken &currentElement)
 
virtual bool readAttributes (const XMLAttributes &attributes, const ExpectedAttributes &expectedAttributes, XMLInputStream &stream, const XMLToken &element, int type)
 
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)
 
int setSpeciesReference (const std::string &speciesReference)
 
int unsetRepresentationType ()
 
int unsetSpeciesReference ()
 
virtual void writeAttributes (XMLOutputStream &stream, int type) const
 
virtual void writeXMLNS (XMLOutputStream &stream) const
 
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

◆ addExpectedAttributes()

virtual void MultiASTPlugin::addExpectedAttributes ( ExpectedAttributes &  attributes,
XMLInputStream stream,
int  type 
)
virtual

◆ 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

◆ getSpeciesReference()

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

◆ isSetRepresentationType()

bool MultiASTPlugin::isSetRepresentationType ( ) const

◆ isSetSpeciesReference()

bool MultiASTPlugin::isSetSpeciesReference ( ) const

◆ operator=()

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

Assignment operator for MultiModelPlugin.

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

◆ read()

bool MultiASTPlugin::read ( XMLInputStream stream,
const std::string &  reqd_prefix,
const XMLToken currentElement 
)
virtual

◆ readAttributes()

virtual bool MultiASTPlugin::readAttributes ( const XMLAttributes attributes,
const ExpectedAttributes &  expectedAttributes,
XMLInputStream stream,
const XMLToken element,
int  type 
)
virtual

◆ 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)

◆ setSpeciesReference()

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

◆ unsetRepresentationType()

int MultiASTPlugin::unsetRepresentationType ( )

◆ unsetSpeciesReference()

int MultiASTPlugin::unsetSpeciesReference ( )

◆ writeAttributes()

virtual void MultiASTPlugin::writeAttributes ( XMLOutputStream stream,
int  type 
) const
virtual

◆ writeXMLNS()

virtual void MultiASTPlugin::writeXMLNS ( XMLOutputStream stream) const
virtual