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

Detailed Description

{layout} Implementation of the 'layout' package extention to the Model construct.

Public Member Functions

int addLayout (const Layout *layout)
 Adds a copy of the layout object to the list of layouts. More...
 
virtual LayoutModelPluginclone () const
 Creates and returns a deep copy of this LayoutModelPlugin object. More...
 
LayoutcreateLayout ()
 Creates a new layout object and adds it to the list of layout objects and returns it. More...
 
virtual ListgetAllElements (ElementFilter *filter=NULL)
 ------------------------------------------------------------------ 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...
 
LayoutgetLayout (unsigned int index)
 Returns the layout object that belongs to the given index. More...
 
const LayoutgetLayout (unsigned int index) const
 Returns the layout object that belongs to the given index. More...
 
LayoutgetLayout (const std::string &sid)
 Returns the layout object with the given sid attribute. More...
 
const LayoutgetLayout (const std::string &sid) const
 Returns the layout object with the given sid attribute. More...
 
unsigned int getLevel () const
 Returns the SBML level of the package extension of this plugin object. More...
 
const ListOfLayoutsgetListOfLayouts () const
 Returns the ListOfLayouts object for this Model. More...
 
ListOfLayoutsgetListOfLayouts ()
 Returns the ListOfLayouts object for this Model. More...
 
int getNumLayouts () const
 Returns the number of layout objects. 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...
 
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...
 
 LayoutModelPlugin (const std::string &uri, const std::string &prefix, LayoutPkgNamespaces *layoutns)
 Constructor. More...
 
 LayoutModelPlugin (const LayoutModelPlugin &orig)
 Copy constructor. More...
 
LayoutModelPluginoperator= (const LayoutModelPlugin &orig)
 Assignment operator for LayoutModelPlugin. More...
 
LayoutremoveLayout (unsigned int n)
 Removes the nth Layout object from this Model object and returns a pointer to it. More...
 
int setElementNamespace (const std::string &uri)
 Sets the XML namespace to which this element belongs to. More...
 
virtual ~LayoutModelPlugin ()
 Destroy this object. More...
 

Constructor & Destructor Documentation

LayoutModelPlugin::LayoutModelPlugin ( const std::string &  uri,
const std::string &  prefix,
LayoutPkgNamespaces layoutns 
)

Constructor.

LayoutModelPlugin::LayoutModelPlugin ( const LayoutModelPlugin orig)

Copy constructor.

Creates a copy of this SBase object.

LayoutModelPlugin::~LayoutModelPlugin ( )
virtual

Destroy this object.

Member Function Documentation

int LayoutModelPlugin::addLayout ( const Layout layout)

Adds a copy of the layout object to the list of layouts.

Parameters
layoutthe layout object to be added.
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
LayoutModelPlugin * LayoutModelPlugin::clone ( ) const
virtual

Creates and returns a deep copy of this LayoutModelPlugin object.

Returns
a (deep) copy of this LayoutModelPlugin object

Implements SBasePlugin.

Layout * LayoutModelPlugin::createLayout ( )

Creates a new layout object and adds it to the list of layout objects and returns it.

Returns
a new layout object.
List * LayoutModelPlugin::getAllElements ( ElementFilter *  filter = NULL)
virtual

------------------------------------------------------------------

Additional public functions

------------------------------------------------------------------ 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 from SBasePlugin.

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.
Layout * LayoutModelPlugin::getLayout ( unsigned int  index)

Returns the layout object that belongs to the given index.

If the index is invalid, NULL is returned.

Parameters
indexthe index of list of layout objects.
Returns
the Layout object that belongs to the given index. NULL is returned if the index is invalid.
const Layout * LayoutModelPlugin::getLayout ( unsigned int  index) const

Returns the layout object that belongs to the given index.

If the index is invalid, NULL is returned.

Parameters
indexthe index of list of layout objects.
Returns
the Layout object that belongs to the given index. NULL is returned if the index is invalid.
Layout * LayoutModelPlugin::getLayout ( const std::string &  sid)

Returns the layout object with the given sid attribute.

If the id is invalid, NULL is returned.

Parameters
sidthe id attribute of the layout object.
Returns
the Layout object with the given sid attribute. NULL is returned if the given sid is invalid.
const Layout * LayoutModelPlugin::getLayout ( const std::string &  sid) const

Returns the layout object with the given sid attribute.

If the id is invalid, NULL is returned.

Parameters
sidthe id attribute of the layout object.
Returns
the Layout object with the given sid attribute. NULL is returned if the given sid is invalid.
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 ListOfLayouts * LayoutModelPlugin::getListOfLayouts ( ) const

Returns the ListOfLayouts object for this Model.

Returns
the ListOfLayouts object for this Model.
ListOfLayouts * LayoutModelPlugin::getListOfLayouts ( )

Returns the ListOfLayouts object for this Model.

Returns
the ListOfLayouts object for this Model.
int LayoutModelPlugin::getNumLayouts ( ) const

Returns the number of layout objects.

Returns
the number of layout objects.
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.
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.
LayoutModelPlugin & LayoutModelPlugin::operator= ( const LayoutModelPlugin orig)

Assignment operator for LayoutModelPlugin.

Layout * LayoutModelPlugin::removeLayout ( unsigned int  n)

Removes the nth Layout object from this Model object and returns a pointer to it.

The caller owns the returned object and is responsible for deleting it.

Parameters
nthe index of the Layout object to remove
Returns
the Layout object removed. As mentioned above, the caller owns the returned object. NULL is returned if the given index is out of range.
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: