Constructor and Description |
---|
Point()   |
Point(LayoutPkgNamespaces layoutns)   |
Point(LayoutPkgNamespaces layoutns,
double x,
double y)   |
Point(LayoutPkgNamespaces layoutns,
double x,
double y,
double z)   |
Point(long level)   |
Point(long level,
long version)   |
Point(long level,
long version,
long pkgVersion)   |
Point(Point orig)   |
Point(XMLNode node)   |
Point(XMLNode node,
long l2version)   |
Modifier and Type | Method and Description |
---|---|
Point |
cloneObject()
Creates and returns a deep copy of this
SBase object. |
void |
delete()
Explicitly deletes the underlying native object.
|
String |
getElementName()
Returns the XML element name of this object.
|
int |
getTypeCode()
Returns the libSBML type code for this object.
|
double |
getXOffset()   |
double |
getYOffset()   |
double |
getZOffset()   |
void |
initDefaults()   |
void |
setElementName(String name)   |
void |
setOffsets(double x,
double y)   |
void |
setOffsets(double x,
double y,
double z)   |
void |
setX(double x)   |
void |
setXOffset(double x)   |
void |
setY(double y)   |
void |
setYOffset(double y)   |
void |
setZ(double z)   |
void |
setZOffset(double z)   |
XMLNode |
toXML(String name)   |
int |
unsetId()
Unsets the value of the 'id' attribute of this SBML object.
|
double |
x()   |
double |
y()   |
double |
z()   |
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getElementByMetaId, getElementBySId, getLevel, getLine, getListOfAllElements, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm
public Point() throws SBMLConstructorException
SBMLConstructorException
public Point(LayoutPkgNamespaces layoutns) throws SBMLConstructorException
SBMLConstructorException
public Point(LayoutPkgNamespaces layoutns, double x, double y) throws SBMLConstructorException
SBMLConstructorException
public Point(LayoutPkgNamespaces layoutns, double x, double y, double z) throws SBMLConstructorException
SBMLConstructorException
public Point(long level) throws SBMLConstructorException
SBMLConstructorException
public Point(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public Point(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public Point(Point orig) throws SBMLConstructorException
SBMLConstructorException
public Point(XMLNode node) throws SBMLConstructorException
SBMLConstructorException
public Point(XMLNode node, long l2version) throws SBMLConstructorException
SBMLConstructorException
public Point cloneObject()
SBase
object.
cloneObject
 in class SBase
SBase
object.public void delete()
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 Point.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 Point.delete()
themselves.
public String getElementName()
This is overridden by subclasses to return a string appropriate to the
SBML component. For example, Model
defines it as returning
'model'
, CompartmentType
defines it as returning 'compartmentType'
,
and so on.
getElementName
 in class SBase
public int getTypeCode()
This method may return the type code of this SBML object, or it may
return SBML_UNKNOWN
. This
is because subclasses of SBase
are not required to implement this
method to return a type code. This method is meant primarily for the
LibSBML C interface, in which class and subclass information is not
readily available.
getTypeCode
 in class SBase
SBML_UNKNOWN
(the default).
Point.getElementName()
,
SBase.getPackageName()
public double getXOffset()
public double getYOffset()
public double getZOffset()
public void initDefaults()
public void setElementName(String name)
public void setOffsets(double x, double y)
public void setOffsets(double x, double y, double z)
public void setX(double x)
public void setXOffset(double x)
public void setY(double y)
public void setYOffset(double y)
public void setZ(double z)
public void setZOffset(double z)
public int unsetId()
Most (but not all) objects in SBML include two common attributes: 'id'
and 'name'. The identifier given by an object's 'id' attribute value
is used to identify the object within the SBML model definition.
Other objects can refer to the component using this identifier. The
data type of 'id' is always either Sid
or
UnitSId
, depending on the object in question. Both
data types are defined as follows:
letter .= 'a'..'z','A'..'Z' digit .= '0'..'9' idChar .= letter | digit | '_' SId .= ( letter | '_' ) idChar*
The equality of SId
and UnitSId
type values
in SBML is determined by an exact character sequence match i.e.,
comparisons of these identifiers must be performed in a case-sensitive
manner. This applies to all uses of SId
and
UnitSId
.
public double x()
public double y()
public double z()