public class Point extends SBase
A point is specified via the required attributes 'x', 'y' and an optional
attribute 'z', all of which are of type double. If the attribute z is not
specified, the object is a two dimensional object. The Point
class also
has an optional attribute id of type SId. While not used in the
&ldquolayout&rdquo package, it can be used by programs to refer to the
elements.
Constructor and Description |
---|
Point()
Creates a new point with x,y and z set to 0.0.
|
Point(LayoutPkgNamespaces layoutns)
Ctor.
|
Point(LayoutPkgNamespaces layoutns,
double x,
double y)
Creates a new point with the given coordinates.
|
Point(LayoutPkgNamespaces layoutns,
double x,
double y,
double z)
Creates a new point with the given coordinates.
|
Point(long level)
Creates a new point with x,y and z set to 0.0.
|
Point(long level,
long version)
Creates a new point with x,y and z set to 0.0.
|
Point(long level,
long version,
long pkgVersion)
Creates a new point with x,y and z set to 0.0.
|
Point(Point orig)
Copy constructor.
|
Point(XMLNode node)
|
Point(XMLNode node,
long l2version)
|
Modifier and Type | Method and Description |
---|---|
Point |
cloneObject()
Creates and returns a deep copy of this
Point . |
void |
delete()
Explicitly deletes the underlying native object.
|
java.lang.String |
getElementName()
Returns the XML element name of
this SBML object.
|
java.lang.String |
getId()
Returns the value of the 'id' attribute of this
Point . |
int |
getTypeCode()
Returns the libSBML type code of this object instance.
|
double |
getXOffset()
Returns the x offset.
|
double |
getYOffset()
Returns the y offset.
|
double |
getZOffset()
Returns the z offset.
|
boolean |
getZOffsetExplicitlySet()   |
void |
initDefaults()
Sets the Z offset to 0.0.
|
boolean |
isSetId()
|
void |
setElementName(java.lang.String name)
Sets the element name to be returned by getElementName().
|
int |
setId(java.lang.String id)
Sets the value of the 'id' attribute of this
Point . |
void |
setOffsets(double x,
double y)
Sets the coordinates to the given values.
|
void |
setOffsets(double x,
double y,
double z)
Sets the coordinates to the given values.
|
void |
setX(double x)
Sets the x offset.
|
void |
setXOffset(double x)
Sets the x offset.
|
void |
setY(double y)
Sets the y offset.
|
void |
setYOffset(double y)
Sets the y offset.
|
void |
setZ(double z)
Sets the z offset.
|
void |
setZOffset(double z)
Sets the z offset.
|
XMLNode |
toXML(java.lang.String name)
Creates an
XMLNode object from this. |
int |
unsetId()
Unsets the value of the 'id' attribute of this
Point . |
double |
x()
Returns the x offset.
|
double |
y()
Returns the y offset.
|
double |
z()
Returns the z offset.
|
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public Point(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public Point(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public Point(long level) throws SBMLConstructorException
SBMLConstructorException
public Point() throws SBMLConstructorException
SBMLConstructorException
public Point(LayoutPkgNamespaces layoutns) throws SBMLConstructorException
SBMLConstructorException
public Point(Point orig) throws SBMLConstructorException
SBMLConstructorException
public Point(LayoutPkgNamespaces layoutns, double x, double y, double z) throws SBMLConstructorException
SBMLConstructorException
public Point(LayoutPkgNamespaces layoutns, double x, double y) throws SBMLConstructorException
SBMLConstructorException
public Point(XMLNode node, long l2version) throws SBMLConstructorException
SBMLConstructorException
public Point(XMLNode node) throws SBMLConstructorException
SBMLConstructorException
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 double x()
public double y()
public double z()
public double getXOffset()
public double getYOffset()
public double getZOffset()
public void setX(double x)
public void setY(double y)
public void setZ(double z)
public void setXOffset(double x)
public void setYOffset(double y)
public void setZOffset(double z)
public void setOffsets(double x, double y, double z)
public void setOffsets(double x, double y)
public boolean getZOffsetExplicitlySet()
public void initDefaults()
public java.lang.String getId()
Point
.public int setId(java.lang.String id)
Point
.public int unsetId()
Point
.public void setElementName(java.lang.String name)
public java.lang.String getElementName()
getElementName
 in class SBase
public Point cloneObject()
Point
.
cloneObject
 in class SBase
Point
.public int getTypeCode()
LibSBML attaches an identifying code to every kind of SBML object. These
are integer constants known as SBML type codes. The names of all
the codes begin with the characters SBML_
.
In the Java language interface for libSBML, the
type codes are defined as static integer constants in the interface class
libsbmlConstants
. Note that different Level 3
package plug-ins may use overlapping type codes to identify the package
to which a given object belongs, call the getPackageName()
method on the object.
getTypeCode
 in class SBase
SBML_LAYOUT_POINT
Point.getElementName()
,
SBase.getPackageName()