Curve (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.Curve

```
public class Curve
extends SBase
```
layout A curve connecting elements in a diagram.
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:
- SpeciesReferenceGlyph: Here it describes a curve from/to the center piece of the parent ReactionGlyph to/from the SpeciesGlyph it represents.
- ReactionGlyph: Here it describes a curve for the center piece of a reaction.
- ReferenceGlyph: Here it describes a curve from/to the center piece of the parent GeneralGlyph to/from the glyph it represents.
- GeneralGlyph: Here it describes a curve for the center piece of an additional relationship.
In the text above, the term 'center piece' refers to either the Curve element of a ReactionGlyph, or its BoundingBox.

Constructor Summary

Constructors
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)` Creates a new `Curve` from the given `XMLNode`
`Curve(XMLNode node, long l2version)` Creates a new `Curve` from the given `XMLNode`

Method Summary

All Methods Instance Methods Concrete Methods
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.

Methods inherited from class org.sbml.libsbml.SBase
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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Curve
```
public Curve(long level,
             long version,
             long pkgVersion)
      throws SBMLConstructorException
```
    Creates a curve with an empty list of segments.
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve(long level,
             long version)
      throws SBMLConstructorException
```
    Creates a curve with an empty list of segments.
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve(long level)
      throws SBMLConstructorException
```
    Creates a curve with an empty list of segments.
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve()
      throws SBMLConstructorException
```
    Creates a curve with an empty list of segments.
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve(LayoutPkgNamespaces layoutns)
      throws SBMLConstructorException
```
    Creates a new Curve with the given LayoutPkgNamespaces object.
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve(XMLNode node,
             long l2version)
      throws SBMLConstructorException
```
    Creates a new Curve from the given XMLNode
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve(XMLNode node)
      throws SBMLConstructorException
```
    Creates a new Curve from the given XMLNode
    
    Throws:
    
    SBMLConstructorException
  - Curve
```
public Curve(Curve source)
      throws SBMLConstructorException
```
    Copy constructor.
    
    Throws:
    
    SBMLConstructorException
- Method Detail
  - 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 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.
    
    Overrides:
    
    delete in class SBase
  - initDefaults
```
public void initDefaults()
```
    Does nothing since no defaults are defined for Curve.
  - getListOfCurveSegments
```
public ListOfLineSegments getListOfCurveSegments()
```
    Returns a refernce to the ListOf object That holds all the curve segments.
  - getCurveSegment
```
public LineSegment getCurveSegment(long index)
```
    Returns a pointer to the curve segment with the given index. If the index is invalid, null is returned.
  - addCurveSegment
```
public void addCurveSegment(LineSegment segment)
```
    Adds a new CurveSegment to the end of the list.
  - getNumCurveSegments
```
public long getNumCurveSegments()
```
    Returns the number of curve segments.
  - createLineSegment
```
public LineSegment createLineSegment()
```
    Creates a new LineSegment and adds it to the end of the list. A reference to the new LineSegment object is returned.
  - createCubicBezier
```
public CubicBezier createCubicBezier()
```
    Creates a new CubicBezier and adds it to the end of the list. A reference to the new CubicBezier object is returned.
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this SBML object.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the string of the name of this element
  - cloneObject
```
public Curve cloneObject()
```
    Creates and returns a deep copy of this Curve.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this Curve.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code of this object instance.
    
    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.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object: SBML_LAYOUT_CURVE
    
    See Also:
    
    Curve.getElementName(), SBase.getPackageName()
    
    "Warning:"
    
    The specific integer values of the possible type codes may be reused by different Level 3 package plug-ins. Thus, to identifiy the correct code, it is necessary to invoke both getTypeCode() and getPackageName().
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this.
  - connectToChild
```
public void connectToChild()
```
    Overrides:
    
    connectToChild in class SBase

Class Curve

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

Curve

Curve

Curve

Curve

Curve

Curve

Curve

Curve

Method Detail

delete

initDefaults

getListOfCurveSegments

getCurveSegment

addCurveSegment

getNumCurveSegments

createLineSegment

createCubicBezier

getElementName

cloneObject

getTypeCode

toXML

connectToChild