LayoutModelPlugin (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBasePlugin
- - org.sbml.libsbml.LayoutModelPlugin

public class LayoutModelPlugin
extends SBasePlugin

layout Extension of Model.

Constructor Summary

Constructors
Constructor and Description
`LayoutModelPlugin(LayoutModelPlugin orig)` Copy constructor.
`LayoutModelPlugin(java.lang.String uri, java.lang.String prefix, LayoutPkgNamespaces layoutns)` Creates a new `LayoutModelPlugin` object using the given parameters.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addLayout(Layout layout)` Adds a copy of the layout object to the list of layouts.
`SBasePlugin`	`cloneObject()` Creates and returns a deep copy of this `LayoutModelPlugin` object.
`Layout`	`createLayout()` Creates a new layout object and adds it to the list of layout objects and returns it.
`void`	`delete()` Explicitly deletes the underlying native object.
`Layout`	`getLayout(long index)` Returns the layout object that belongs to the given index.
`Layout`	`getLayout(java.lang.String sid)` Returns the layout object with the given `sid` attribute.
`ListOfLayouts`	`getListOfLayouts()` Returns the `ListOfLayouts` object for this `Model`.
`int`	`getNumLayouts()` Returns the number of layout objects.
`Layout`	`removeLayout(long n)` Removes the nth `Layout` object from this `Model` object and returns a pointer to it.

Methods inherited from class org.sbml.libsbml.SBasePlugin
getElementByMetaId, getElementBySId, getElementNamespace, getLevel, getListOfAllElements, getListOfAllElements, getPackageName, getPackageVersion, getParentSBMLObject, getPrefix, getSBMLDocument, getURI, getVersion, isValidTypeForList, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, setElementNamespace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LayoutModelPlugin
```
public LayoutModelPlugin(java.lang.String uri,
                         java.lang.String prefix,
                         LayoutPkgNamespaces layoutns)
```
    Creates a new LayoutModelPlugin 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/'.
    
    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.
    
    Parameters:
    
    uri - the URI of the SBML Level 3 package implemented by this libSBML package extension.
    
    prefix - the XML namespace prefix being used for the package.
    
    layoutns - the namespaces object for the package.
  - LayoutModelPlugin
```
public LayoutModelPlugin(LayoutModelPlugin orig)
```
    Copy constructor. Creates a copy of this SBase object.
    
    Parameters:
    
    orig - the instance to copy.
- Method Detail
  - delete
```
public void delete()
```
    Explicitly deletes the underlying native object.
    In general, application software will not need to call this method directly. The Java language binding for libSBML is implemented as a language wrapper that provides a Java interface to libSBML's underlying C++/C code. Some of the Java methods return objects that are linked to objects created not by Java code, but by C++ code. The Java objects wrapped around them will be deleted when the garbage collector invokes the corresponding C++ finalize() methods for the objects. The finalize() methods in turn call the LayoutModelPlugin.delete() method on the libSBML object.
    This method is exposed in case calling programs want to ensure that the underlying object is freed immediately, and not at some arbitrary time determined by the Java garbage collector. In normal usage, callers do not need to invoke LayoutModelPlugin.delete() themselves.
    
    Overrides:
    
    delete in class SBasePlugin
  - cloneObject
```
public SBasePlugin cloneObject()
```
    Creates and returns a deep copy of this LayoutModelPlugin object.
    
    Overrides:
    
    cloneObject in class SBasePlugin
    
    Returns:
    
    a (deep) copy of this LayoutModelPlugin object.
  - getListOfLayouts
```
public ListOfLayouts getListOfLayouts()
```
    Returns the ListOfLayouts object for this Model.
    
    Returns:
    
    the ListOfLayouts object for this Model.
  - getLayout
```
public Layout getLayout(long index)
```
    Returns the layout object that belongs to the given index. If the index is invalid, null is returned.
    
    Parameters:
    
    index - the index of list of layout objects.
    
    Returns:
    
    the Layout object that belongs to the given index. null is returned if the index is invalid.
  - getLayout
```
public Layout getLayout(java.lang.String sid)
```
    Returns the layout object with the given sid attribute. If the id is invalid, null is returned.
    
    Parameters:
    
    sid - the id attribute of the layout object.
    
    Returns:
    
    the Layout object with the given sid attribute. null is returned if the given sid is invalid.
  - addLayout
```
public int addLayout(Layout layout)
```
    Adds a copy of the layout object to the list of layouts.
    Parameters:
    
    layout - the layout object to be added.
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
    LIBSBML_INVALID_OBJECT
    LIBSBML_LEVEL_MISMATCH
    LIBSBML_VERSION_MISMATCH
    LIBSBML_PKG_VERSION_MISMATCH
    LIBSBML_DUPLICATE_OBJECT_ID
  - createLayout
```
public Layout createLayout()
```
    Creates a new layout object and adds it to the list of layout objects and returns it.
    
    Returns:
    
    a new layout object.
  - removeLayout
```
public Layout removeLayout(long 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:
    
    n - the 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.
  - getNumLayouts
```
public int getNumLayouts()
```
    Returns the number of layout objects.
    
    Returns:
    
    the number of layout objects.

Class LayoutModelPlugin

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBasePlugin

Methods inherited from class java.lang.Object

Constructor Detail

LayoutModelPlugin

LayoutModelPlugin

Method Detail

delete

cloneObject

getListOfLayouts

getLayout

getLayout

addLayout

createLayout

removeLayout

getNumLayouts