public class LineSegment extends SBase
The LineSegment
class consists of the mandatory attribute xsi:type and two
child elements of type Point
. One is called 'start' and represents the
starting point of the line, the other is called 'end' and represents the
endpoint of the line. The LineSegment
class is also the base class for
CubicBezier
, which represent curved lines instead of straight ones.
Constructor and Description |
---|
LineSegment()
Creates a line segment with the given SBML level, version, and package version
and both points set to (0.0,0.0,0.0)
|
LineSegment(LayoutPkgNamespaces layoutns)
Creates a line segment with the
LayoutPkgNamespaces and both points set to (0.0,0.0,0.0) |
LineSegment(LayoutPkgNamespaces layoutns,
double x1,
double y1,
double x2,
double y2)
Creates a new line segment with the given 2D coordinates.
|
LineSegment(LayoutPkgNamespaces layoutns,
double x1,
double y1,
double z1,
double x2,
double y2,
double z2)
Creates a new line segment with the given 3D coordinates.
|
LineSegment(LayoutPkgNamespaces layoutns,
Point start,
Point end)
Creates a new line segment with the two given points.
|
LineSegment(LineSegment orig)
Copy constructor.
|
LineSegment(long level)
Creates a line segment with the given SBML level, version, and package version
and both points set to (0.0,0.0,0.0)
|
LineSegment(long level,
long version)
Creates a line segment with the given SBML level, version, and package version
and both points set to (0.0,0.0,0.0)
|
LineSegment(long level,
long version,
long pkgVersion)
Creates a line segment with the given SBML level, version, and package version
and both points set to (0.0,0.0,0.0)
|
LineSegment(XMLNode node)
Creates a new
LineSegment from the given XMLNode |
LineSegment(XMLNode node,
long l2version)
Creates a new
LineSegment from the given XMLNode |
Modifier and Type | Method and Description |
---|---|
LineSegment |
cloneObject()
Creates and returns a deep copy of this
LineSegment . |
void |
connectToChild()   |
void |
delete()
Explicitly deletes the underlying native object.
|
java.lang.String |
getElementName()
Returns the XML element name of
this SBML object.
|
Point |
getEnd()
Returns the end point of the line.
|
Point |
getStart()
Returns the start point of the line.
|
int |
getTypeCode()
Returns the libSBML type code of this object instance.
|
void |
initDefaults()
Does noting since no defaults are defined for
LineSegment . |
void |
setEnd(double x,
double y)
Initializes the end point with the given coordinates.
|
void |
setEnd(double x,
double y,
double z)
Initializes the end point with the given coordinates.
|
void |
setEnd(Point end)
Initializes the end point with a copy of the given
Point object. |
void |
setStart(double x,
double y)
Initializes the start point with the given coordinates.
|
void |
setStart(double x,
double y,
double z)
Initializes the start point with the given coordinates.
|
void |
setStart(Point start)
Initializes the start point with a copy of the given
Point object. |
XMLNode |
toXML()
Creates an
XMLNode object from this. |
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getId, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getName, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getObjectVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetId, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetName, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setId, setIdAttribute, setMetaId, setModelHistory, setName, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public LineSegment(long level, long version, long pkgVersion) throws SBMLConstructorException
level
- the SBML Level.version
- the Version within the SBML Level.pkgVersion
- the version of the package.
SBMLConstructorException
SBMLDocument
having a different
combination of SBML Level, Version and XML namespaces than the object
itself will result in an error at the time a caller attempts to make the
addition. A parent object must have compatible Level, Version and XML
namespaces. (Strictly speaking, a parent may also have more XML
namespaces than a child, but the reverse is not permitted.) The
restriction is necessary to ensure that an SBML model has a consistent
overall structure. This requires callers to manage their objects
carefully, but the benefit is increased flexibility in how models can be
created by permitting callers to create objects bottom-up if desired. In
situations where objects are not yet attached to parents (e.g.,
SBMLDocument
), knowledge of the intented SBML Level and Version help
libSBML determine such things as whether it is valid to assign a
particular value to an attribute. For packages, this means that the
parent object to which this package element is being added must have
been created with the package namespace, or that the package namespace
was added to it, even if that parent is not a package object itself.public LineSegment(long level, long version) throws SBMLConstructorException
level
- the SBML Level.version
- the Version within the SBML Level.pkgVersion
- the version of the package.
SBMLConstructorException
SBMLDocument
having a different
combination of SBML Level, Version and XML namespaces than the object
itself will result in an error at the time a caller attempts to make the
addition. A parent object must have compatible Level, Version and XML
namespaces. (Strictly speaking, a parent may also have more XML
namespaces than a child, but the reverse is not permitted.) The
restriction is necessary to ensure that an SBML model has a consistent
overall structure. This requires callers to manage their objects
carefully, but the benefit is increased flexibility in how models can be
created by permitting callers to create objects bottom-up if desired. In
situations where objects are not yet attached to parents (e.g.,
SBMLDocument
), knowledge of the intented SBML Level and Version help
libSBML determine such things as whether it is valid to assign a
particular value to an attribute. For packages, this means that the
parent object to which this package element is being added must have
been created with the package namespace, or that the package namespace
was added to it, even if that parent is not a package object itself.public LineSegment(long level) throws SBMLConstructorException
level
- the SBML Level.version
- the Version within the SBML Level.pkgVersion
- the version of the package.
SBMLConstructorException
SBMLDocument
having a different
combination of SBML Level, Version and XML namespaces than the object
itself will result in an error at the time a caller attempts to make the
addition. A parent object must have compatible Level, Version and XML
namespaces. (Strictly speaking, a parent may also have more XML
namespaces than a child, but the reverse is not permitted.) The
restriction is necessary to ensure that an SBML model has a consistent
overall structure. This requires callers to manage their objects
carefully, but the benefit is increased flexibility in how models can be
created by permitting callers to create objects bottom-up if desired. In
situations where objects are not yet attached to parents (e.g.,
SBMLDocument
), knowledge of the intented SBML Level and Version help
libSBML determine such things as whether it is valid to assign a
particular value to an attribute. For packages, this means that the
parent object to which this package element is being added must have
been created with the package namespace, or that the package namespace
was added to it, even if that parent is not a package object itself.public LineSegment() throws SBMLConstructorException
level
- the SBML Level.version
- the Version within the SBML Level.pkgVersion
- the version of the package.
SBMLConstructorException
SBMLDocument
having a different
combination of SBML Level, Version and XML namespaces than the object
itself will result in an error at the time a caller attempts to make the
addition. A parent object must have compatible Level, Version and XML
namespaces. (Strictly speaking, a parent may also have more XML
namespaces than a child, but the reverse is not permitted.) The
restriction is necessary to ensure that an SBML model has a consistent
overall structure. This requires callers to manage their objects
carefully, but the benefit is increased flexibility in how models can be
created by permitting callers to create objects bottom-up if desired. In
situations where objects are not yet attached to parents (e.g.,
SBMLDocument
), knowledge of the intented SBML Level and Version help
libSBML determine such things as whether it is valid to assign a
particular value to an attribute. For packages, this means that the
parent object to which this package element is being added must have
been created with the package namespace, or that the package namespace
was added to it, even if that parent is not a package object itself.public LineSegment(LayoutPkgNamespaces layoutns) throws SBMLConstructorException
LayoutPkgNamespaces
and both points set to (0.0,0.0,0.0)
The package namespaces object used in this constructor is derived from a
SBMLNamespaces
object, which encapsulates SBML Level/Version/namespaces
information. It is used to communicate the SBML Level, Version, and
package version and name information used in addition to SBML Level 3 Core. A
common approach to using libSBML's SBMLNamespaces
facilities is to create an
package namespace object somewhere in a program once, then hand that object
as needed to object constructors of that package that accept it as and
argument, such as this one.
layoutns
- the LayoutPkgNamespaces
object.
SBMLConstructorException
SBMLDocument
having a different
combination of SBML Level, Version and XML namespaces than the object
itself will result in an error at the time a caller attempts to make the
addition. A parent object must have compatible Level, Version and XML
namespaces. (Strictly speaking, a parent may also have more XML
namespaces than a child, but the reverse is not permitted.) The
restriction is necessary to ensure that an SBML model has a consistent
overall structure. This requires callers to manage their objects
carefully, but the benefit is increased flexibility in how models can be
created by permitting callers to create objects bottom-up if desired. In
situations where objects are not yet attached to parents (e.g.,
SBMLDocument
), knowledge of the intented SBML Level and Version help
libSBML determine such things as whether it is valid to assign a
particular value to an attribute. For packages, this means that the
parent object to which this package element is being added must have
been created with the package namespace, or that the package namespace
was added to it, even if that parent is not a package object itself.public LineSegment(LayoutPkgNamespaces layoutns, double x1, double y1, double x2, double y2) throws SBMLConstructorException
SBMLConstructorException
public LineSegment(LineSegment orig) throws SBMLConstructorException
orig
- the instance to copy.SBMLConstructorException
public LineSegment(LayoutPkgNamespaces layoutns, double x1, double y1, double z1, double x2, double y2, double z2) throws SBMLConstructorException
SBMLConstructorException
public LineSegment(LayoutPkgNamespaces layoutns, Point start, Point end) throws SBMLConstructorException
SBMLConstructorException
public LineSegment(XMLNode node, long l2version) throws SBMLConstructorException
LineSegment
from the given XMLNode
SBMLConstructorException
public LineSegment(XMLNode node) throws SBMLConstructorException
LineSegment
from the given XMLNode
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 LineSegment.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 LineSegment.delete()
themselves.
public void setStart(Point start)
Point
object.public void setStart(double x, double y, double z)
public void setStart(double x, double y)
public void setEnd(Point end)
Point
object.public void setEnd(double x, double y, double z)
public void setEnd(double x, double y)
public void initDefaults()
LineSegment
.public java.lang.String getElementName()
getElementName
 in class SBase
public LineSegment cloneObject()
LineSegment
.
cloneObject
 in class SBase
LineSegment
.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_LINESEGMENT
LineSegment.getElementName()
,
SBase.getPackageName()
public void connectToChild()
connectToChild
 in class SBase