public class Curve extends SBase
The Curve
class describes how to connect elements in a diagram defined
with the use of the &ldquolayout&rdquo package. A curve is fully
specified by a mandatory listOfCurveSegments element and is used in four
places in the &ldquolayout&rdquo package:
ReactionGlyph
to/from the SpeciesGlyph
it represents.
GeneralGlyph
to/from the glyph it represents.
In the text above, the term 'center piece' refers to either the Curve
element of a ReactionGlyph
, or its BoundingBox
.
Constructor and Description |
---|
Curve()
Creates a curve with an empty list of segments.
|
Curve(Curve source)
Copy constructor.
|
Curve(LayoutPkgNamespaces layoutns)
Creates a new
Curve with the given LayoutPkgNamespaces object. |
Curve(long level)
Creates a curve with an empty list of segments.
|
Curve(long level,
long version)
Creates a curve with an empty list of segments.
|
Curve(long level,
long version,
long pkgVersion)
Creates a curve with an empty list of segments.
|
Curve(XMLNode node)
|
Curve(XMLNode node,
long l2version)
|
Modifier and Type | Method and Description |
---|---|
void |
addCurveSegment(LineSegment segment)
Adds a new CurveSegment to the end of the list.
|
Curve |
cloneObject()
Creates and returns a deep copy of this
Curve . |
void |
connectToChild()   |
CubicBezier |
createCubicBezier()
Creates a new
CubicBezier and adds it to the end of the list. |
LineSegment |
createLineSegment()
Creates a new
LineSegment and adds it to the end of the list. |
void |
delete()
Explicitly deletes the underlying native object.
|
LineSegment |
getCurveSegment(long index)
Returns a pointer to the curve segment with the given index.
|
java.lang.String |
getElementName()
Returns the XML element name of
this SBML object.
|
ListOfLineSegments |
getListOfCurveSegments()
Returns a refernce to the
ListOf object That holds all the curve
segments. |
long |
getNumCurveSegments()
Returns the number of curve segments.
|
int |
getTypeCode()
Returns the libSBML type code of this object instance.
|
void |
initDefaults()
Does nothing since no defaults are defined for
Curve . |
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, 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, unsetId, unsetMetaId, unsetModelHistory, unsetName, unsetNotes, unsetSBOTerm, unsetUserData
public Curve(long level, long version, long pkgVersion) throws SBMLConstructorException
SBMLConstructorException
public Curve(long level, long version) throws SBMLConstructorException
SBMLConstructorException
public Curve(long level) throws SBMLConstructorException
SBMLConstructorException
public Curve() throws SBMLConstructorException
SBMLConstructorException
public Curve(LayoutPkgNamespaces layoutns) throws SBMLConstructorException
Curve
with the given LayoutPkgNamespaces
object.SBMLConstructorException
public Curve(XMLNode node, long l2version) throws SBMLConstructorException
SBMLConstructorException
public Curve(XMLNode node) throws SBMLConstructorException
SBMLConstructorException
public Curve(Curve source) 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 Curve.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 Curve.delete()
themselves.
public void initDefaults()
Curve
.public ListOfLineSegments getListOfCurveSegments()
ListOf
object That holds all the curve
segments.public LineSegment getCurveSegment(long index)
null
is returned.public void addCurveSegment(LineSegment segment)
public long getNumCurveSegments()
public LineSegment createLineSegment()
LineSegment
and adds it to the end of the list. A
reference to the new LineSegment
object is returned.public CubicBezier createCubicBezier()
CubicBezier
and adds it to the end of the list. A
reference to the new CubicBezier
object is returned.public java.lang.String getElementName()
getElementName
 in class SBase
public Curve cloneObject()
Curve
.
cloneObject
 in class SBase
Curve
.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_CURVE
Curve.getElementName()
,
SBase.getPackageName()
public void connectToChild()
connectToChild
 in class SBase