RenderCurve (LibSBML Java API)

java.lang.Object
- org.sbml.libsbml.SBase
- - org.sbml.libsbml.Transformation
  - - org.sbml.libsbml.Transformation2D
    - - org.sbml.libsbml.GraphicalPrimitive1D
      - org.sbml.libsbml.RenderCurve

```
public class RenderCurve
extends GraphicalPrimitive1D
```
implementation of the Curve concept from the SBML render extension
The curve concept in the SBML render extension is similar to the curves in the SBML layout. Each curve consists of a number of either straight line segments or cubic bezier elements. The two element types can also by mixed in a single curve object.
In contrast to layout curves, render curves can not have gaps and the individual coordinates of the curve elements can be specified as a combination of absolute and relative values.
Another difference to layout curves is the fact that render curves can specify decorations to be applied to the start and/or the end of the curve ( Since RenderCurve is derived from GraphicalPrimitive1D, it inherits all its attributes and methods.

See Also:

LineEnding).

Constructor Summary

Constructors
Constructor and Description
`RenderCurve()` Creates a new `RenderCurve` object with the given SBML level and SBML version.
`RenderCurve(long level)` Creates a new `RenderCurve` object with the given SBML level and SBML version.
`RenderCurve(long level, long version)` Creates a new `RenderCurve` object with the given SBML level and SBML version.
`RenderCurve(long level, long version, long pkgVersion)` Creates a new `RenderCurve` object with the given SBML level and SBML version.
`RenderCurve(RenderPkgNamespaces renderns)` Creates a new `RenderCurve` object with the given `SBMLNamespaces`.
`RenderCurve(RenderPkgNamespaces renderns, java.lang.String id)` Instantiates an empty curve object with the given `id`.
`RenderCurve(XMLNode node)` Creates a new `RenderCurve` object from the given `XMLNode` object.
`RenderCurve(XMLNode node, long l2version)` Creates a new `RenderCurve` object from the given `XMLNode` object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addElement(RenderPoint cs)` Adds a copy of the given curve segment to the end of the list of curve segments.
`RenderCurve`	`cloneObject()` Creates and returns a deep copy of the `RenderCurve` object.
`void`	`connectToChild()`
`RenderCubicBezier`	`createCubicBezier()` Creates a new bezier element.
`RenderPoint`	`createPoint()` Creates a new point element.
`void`	`delete()` Explicitly deletes the underlying native object.
`RenderPoint`	`getCurveElement(long index)` Returns a pointer to the curve segment with the given index or null if the id is invalid.
`RenderPoint`	`getElement(long index)` Returns a pointer to the curve segment with the given index or null if the id is invalid.
`java.lang.String`	`getElementName()` Returns the XML element name of this object, which for `RenderCurve`, is always `'curve'.`
`java.lang.String`	`getEndHead()` Returns the id of the `LineEnding` object to be applied to the end of the curve.
`ListOfCurveElements`	`getListOfElements()` Returns a pointer to the list of curve segments.
`long`	`getNumElements()` Returns the number of curve segments.
`java.lang.String`	`getStartHead()` Returns the id of the `LineEnding` object to be applied to the start of the curve.
`int`	`getTypeCode()` Returns the libSBML type code for this SBML object.
`boolean`	`isSetEndHead()` Returns true if the end head is set or false otherwise.
`boolean`	`isSetStartHead()` Returns true if the start head is set or false otherwise.
`RenderPoint`	`removeElement(long i)` Removes the curve segment with the given index.
`void`	`renameSIdRefs(java.lang.String oldid, java.lang.String newid)` Renames all the `SIdRef` attributes on this element, including any found in MathML content (if such exists).
`void`	`setEndHead(java.lang.String endHead)` Sets the id of the end head.
`void`	`setStartHead(java.lang.String startHead)` Sets the id of the start head.
`XMLNode`	`toXML()` Creates an `XMLNode` object from this `RenderCurve` object.

Methods inherited from class org.sbml.libsbml.GraphicalPrimitive1D
addDash, clearDashes, getDashByIndex, getId, getNumDashes, getStroke, getStrokeWidth, insertDash, isSetDashArray, isSetId, isSetStroke, isSetStrokeWidth, removeDash, setDashByIndex, setId, setStroke, setStrokeWidth, unsetId

Methods inherited from class org.sbml.libsbml.Transformation2D
getIdentityMatrix2D, getMatrix2D, setMatrix, setMatrix2D

Methods inherited from class org.sbml.libsbml.Transformation
getIdentityMatrix, getMatrix, getName, isSetMatrix, isSetName, setName, unsetName

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, getIdAttribute, getLevel, getLine, getListOfAllElements, getListOfAllElements, getListOfAllElementsFromPlugins, getListOfAllElementsFromPlugins, getMetaId, getModel, getModelHistory, getNamespaces, getNotes, getNotesString, getNumCVTerms, getNumDisabledPlugins, getNumPlugins, getPackageCoreVersion, getPackageName, getPackageVersion, getParentSBMLObject, getPlugin, getPlugin, getPrefix, getResourceBiologicalQualifier, getResourceModelQualifier, getSBMLDocument, getSBOTerm, getSBOTermAsURL, getSBOTermID, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

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

- Constructor Detail
  - RenderCurve
```
public RenderCurve(long level,
                   long version,
                   long pkgVersion)
            throws SBMLConstructorException
```
    Creates a new RenderCurve object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve(long level,
                   long version)
            throws SBMLConstructorException
```
    Creates a new RenderCurve object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve(long level)
            throws SBMLConstructorException
```
    Creates a new RenderCurve object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve()
            throws SBMLConstructorException
```
    Creates a new RenderCurve object with the given SBML level and SBML version.
    
    Parameters:
    
    level - SBML level of the new object
    
    level - SBML version of the new object
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve(RenderPkgNamespaces renderns)
            throws SBMLConstructorException
```
    Creates a new RenderCurve object with the given SBMLNamespaces.
    
    Parameters:
    
    sbmlns - The SBML namespace for the object.
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve(XMLNode node,
                   long l2version)
            throws SBMLConstructorException
```
    Creates a new RenderCurve object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a RenderCurve object as defined in the render extension specification. This method is normally called when render information is read from a file and should normally not have to be called explicitly.
    
    Parameters:
    
    node - the XMLNode object reference that describes the RenderCurve object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve(XMLNode node)
            throws SBMLConstructorException
```
    Creates a new RenderCurve object from the given XMLNode object. The XMLNode object has to contain a valid XML representation of a RenderCurve object as defined in the render extension specification. This method is normally called when render information is read from a file and should normally not have to be called explicitly.
    
    Parameters:
    
    node - the XMLNode object reference that describes the RenderCurve object to be instantiated.
    
    Throws:
    
    SBMLConstructorException
  - RenderCurve
```
public RenderCurve(RenderPkgNamespaces renderns,
                   java.lang.String id)
            throws SBMLConstructorException
```
    Instantiates an empty curve object with the given id. The decorations are unset and there are no curve elements.
    This constructor is deprecated. The new libsbml API only has constructors which take the SBML level and version or one that takes an SBMLNamespaces object.
    
    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 RenderCurve.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 RenderCurve.delete() themselves.
    
    Overrides:
    
    delete in class GraphicalPrimitive1D
  - setStartHead
```
public void setStartHead(java.lang.String startHead)
```
    Sets the id of the start head.
    
    Parameters:
    
    The - id of a LineEnding object to be applied to the start of the curve.
  - setEndHead
```
public void setEndHead(java.lang.String endHead)
```
    Sets the id of the end head.
    
    Parameters:
    
    The - id of a LineEnding object to be applied to the end of the curve.
  - getStartHead
```
public java.lang.String getStartHead()
```
    Returns the id of the LineEnding object to be applied to the start of the curve.
    
    Returns:
    
    id of the LineEnding for the start of the curve.
  - getEndHead
```
public java.lang.String getEndHead()
```
    Returns the id of the LineEnding object to be applied to the end of the curve.
    
    Returns:
    
    id of the LineEnding for the end of the curve.
  - getNumElements
```
public long getNumElements()
```
    Returns the number of curve segments.
    
    Returns:
    
    number of elements in the curve.
  - createCubicBezier
```
public RenderCubicBezier createCubicBezier()
```
    Creates a new bezier element. The element is added to and owned by the curve.
    
    Returns:
    
    The newly created RenderCubicBezier object.
  - createPoint
```
public RenderPoint createPoint()
```
    Creates a new point element. The element is added to and owned by the curve.
    
    Returns:
    
    The newly created RenderCubicBezier object.
  - getElement
```
public RenderPoint getElement(long index)
```
    Returns a pointer to the curve segment with the given index or null if the id is invalid.
    
    Parameters:
    
    index - the index of the curve element to be returned
    
    Returns:
    
    a pointer to the curve element with the given index or null if the index was out of bounds.
  - getCurveElement
```
public RenderPoint getCurveElement(long index)
```
    Returns a pointer to the curve segment with the given index or null if the id is invalid.
    This method call is deprecated, please use getElement instead.
    
    Parameters:
    
    index - the index of the curve element to be returned
    
    Returns:
    
    a pointer to the curve element with the given index or null if the index was out of bounds.
  - addElement
```
public int addElement(RenderPoint cs)
```
    Adds a copy of the given curve segment to the end of the list of curve segments.
    Parameters:
    
    cs - pointer to the RenderPoint object to be added to the end of the curve elements list.
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_LEVEL_MISMATCH
    LIBSBML_VERSION_MISMATCH
    LIBSBML_OPERATION_FAILED
    See Also:
    
    RenderCurve.createPoint(), RenderCurve.createCubicBezier()
    
    "Note:"
    
    This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained in this RenderCurve. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in the RenderCurve. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see RenderCurve.createPoint() or RenderCurve.createCubicBezier() for methods that do not lead to these issues.
  - removeElement
```
public RenderPoint removeElement(long i)
```
    Removes the curve segment with the given index. If the index is valid, a pointer to the removed element is returned and the caller is responsible for deleting the object. If the index is not valid, null is returned.
    
    Parameters:
    
    i - index of element to be removed.
    
    Returns:
    
    pointer to removed element.
  - getListOfElements
```
public ListOfCurveElements getListOfElements()
```
    Returns a pointer to the list of curve segments.
    
    Returns:
    
    pointer to the ListOfCurveElements object for the RenderCurve.
  - renameSIdRefs
```
public void renameSIdRefs(java.lang.String oldid,
                          java.lang.String newid)
```
    Renames all the SIdRef attributes on this element, including any found in MathML content (if such exists).
    This method works by looking at all attributes and (if appropriate) mathematical formulas, comparing the identifiers to the value of @p oldid. If any matches are found, the matching identifiers are replaced with newid. The method does not descend into child elements.
    
    Overrides:
    
    renameSIdRefs in class SBase
    
    Parameters:
    
    oldid - the old identifier
    
    newid - the new identifier
  - cloneObject
```
public RenderCurve cloneObject()
```
    Creates and returns a deep copy of the RenderCurve object.
    
    Overrides:
    
    cloneObject in class SBase
    
    Returns:
    
    a (deep) copy of this RenderCurve
  - getElementName
```
public java.lang.String getElementName()
```
    Returns the XML element name of this object, which for RenderCurve, is always 'curve'.
    
    Overrides:
    
    getElementName in class SBase
    
    Returns:
    
    the name of this element, i.e., 'curve'.
  - getTypeCode
```
public int getTypeCode()
```
    Returns the libSBML type code for this SBML object.
    LibSBML attaches an identifying code to every kind of SBML object. These are known as SBML type codes. In other languages, the set of type codes is stored in an enumeration in the Java language interface for libSBML, the type codes are defined as static integer constants in interface class libsbmlConstants. The names of the type codes all begin with the characters SBML_.
    
    Overrides:
    
    getTypeCode in class SBase
    
    Returns:
    
    the SBML type code for this object, or SBML_UNKNOWN (default).
    
    See Also:
    
    RenderCurve.getElementName()
  - isSetStartHead
```
public boolean isSetStartHead()
```
    Returns true if the start head is set or false otherwise. The start decoration is considered set if the string is not empty and if it is not the string 'none'
    
    Returns:
    
    true is the start decoration id is set
  - isSetEndHead
```
public boolean isSetEndHead()
```
    Returns true if the end head is set or false otherwise. The end decoration is considered set if the string is not empty and if it is not the string 'none'
    
    Returns:
    
    true is the end decoration id is set
  - toXML
```
public XMLNode toXML()
```
    Creates an XMLNode object from this RenderCurve object.
    
    Overrides:
    
    toXML in class GraphicalPrimitive1D
    
    Returns:
    
    the XMLNode with the XML representation for the RenderCurve object.
  - connectToChild
```
public void connectToChild()
```
    Overrides:
    
    connectToChild in class SBase

Class RenderCurve

Constructor Summary

Method Summary

Methods inherited from class org.sbml.libsbml.GraphicalPrimitive1D

Methods inherited from class org.sbml.libsbml.Transformation2D

Methods inherited from class org.sbml.libsbml.Transformation

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Constructor Detail

RenderCurve

RenderCurve

RenderCurve

RenderCurve

RenderCurve

RenderCurve

RenderCurve

RenderCurve

Method Detail

delete

setStartHead

setEndHead

getStartHead

getEndHead

getNumElements

createCubicBezier

createPoint

getElement

getCurveElement

addElement

removeElement

getListOfElements

renameSIdRefs

cloneObject

getElementName

getTypeCode

isSetStartHead

isSetEndHead

toXML

connectToChild