org.sbml.libsbml

Class FbcSpeciesPlugin

java.lang.Object

org.sbml.libsbml.SBasePlugin

org.sbml.libsbml.FbcSpeciesPlugin

public class FbcSpeciesPlugin
extends SBasePlugin

fbc Implementation of the 'fbc' package extention to the Species construct.

The Flux Balance Constraints package extends the SBML Level 3 Version 1 Core Species class with the addition of two attributes: 'charge' and 'chemicalFormula'.

Constructor Summary

Constructors

Constructor and Description
FbcSpeciesPlugin(FbcSpeciesPlugin orig) Copy constructor.
FbcSpeciesPlugin(java.lang.String uri, java.lang.String prefix, FbcPkgNamespaces fbcns) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
SBasePlugin	cloneObject() Creates and returns a deep copy of this FbcSpeciesPlugin object.
void	delete() Explicitly deletes the underlying native object.
int	getCharge() Returns the value of the 'charge' attribute of this FbcSpeciesPlugin.
java.lang.String	getChemicalFormula() Returns the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin.
boolean	isSetCharge() Predicate returning true or false depending on whether this FbcSpeciesPlugin 'charge' attribute has been set.
boolean	isSetChemicalFormula() Predicate returning true or false depending on whether this FbcSpeciesPlugin 'chemicalFormula' attribute has been set.
int	setCharge(int charge) Sets the value of the 'charge' attribute of this FbcSpeciesPlugin.
int	setChemicalFormula(java.lang.String chemicalFormula) Sets the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin.
int	unsetCharge() Unsets the value of the 'charge' attribute of this FbcSpeciesPlugin.
int	unsetChemicalFormula() Unsets the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin.

Methods inherited from class org.sbml.libsbml.SBasePlugin

getElementByMetaId, getElementBySId, getElementNamespace, getLevel, getListOfAllElements, getListOfAllElements, getPackageName, getPackageVersion, getParentSBMLObject, getPrefix, getSBMLDocument, getURI, getVersion, setElementNamespace

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FbcSpeciesPlugin

public FbcSpeciesPlugin(FbcSpeciesPlugin orig)

Copy constructor. Creates a copy of this FbcSpeciesPlugin object.

FbcSpeciesPlugin

public FbcSpeciesPlugin(java.lang.String uri,
                java.lang.String prefix,
                FbcPkgNamespaces fbcns)

Constructor

Method Detail

cloneObject

public SBasePlugin cloneObject()

Creates and returns a deep copy of this FbcSpeciesPlugin object.

Overrides:

cloneObject in class SBasePlugin

Returns:

a (deep) copy of this FbcSpeciesPlugin object

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 FbcSpeciesPlugin.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 FbcSpeciesPlugin.delete() themselves.

Overrides:

delete in class SBasePlugin

getCharge

public int getCharge()

Returns the value of the 'charge' attribute of this FbcSpeciesPlugin.

Returns:

the value of the 'charge' attribute of this FbcSpeciesPlugin.

getChemicalFormula

public java.lang.String getChemicalFormula()

Returns the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin.

Returns:

the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin.

isSetCharge

public boolean isSetCharge()

Predicate returning true or false depending on whether this FbcSpeciesPlugin 'charge' attribute has been set.

Returns:

true if this FbcSpeciesPlugin 'charge' attribute has been set, otherwise false is returned.

isSetChemicalFormula

public boolean isSetChemicalFormula()

Predicate returning true or false depending on whether this FbcSpeciesPlugin 'chemicalFormula' attribute has been set.

Returns:

true if this FbcSpeciesPlugin 'chemicalFormula' attribute has been set, otherwise false is returned.

setCharge

public int setCharge(int charge)

Sets the value of the 'charge' attribute of this FbcSpeciesPlugin.

Returns:

integer value indicating success/failure of the function. The only possible value returned by this function is:

• LIBSBML_OPERATION_SUCCESS

setChemicalFormula

public int setChemicalFormula(java.lang.String chemicalFormula)

Sets the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin. The format of chemicalFormula must consist only of atomic names (as in the Periodic Table) or user defined compounds either of which take the form of a single capital letter followed by zero or more lowercase letters. Where there is more than a single atom present, this is indicated with an integer. With regards to order (and enhance inter-operability) it is recommended to use the Hill system order. (However, no error-checking is performed by this routine.)

Returns:

integer value indicating success/failure of the function. The only possible value returned by this function is:

• LIBSBML_OPERATION_SUCCESS

unsetCharge

public int unsetCharge()

Unsets the value of the 'charge' attribute of this FbcSpeciesPlugin.

Returns:

integer value indicating success/failure of the function. The only possible value returned by this function is:

• LIBSBML_OPERATION_SUCCESS

unsetChemicalFormula

public int unsetChemicalFormula()

Unsets the value of the 'chemicalFormula' attribute of this FbcSpeciesPlugin.

Returns:

integer value indicating success/failure of the function. The only possible value returned by this function is:

• LIBSBML_OPERATION_SUCCESS