Transformation (LibSBML Java API)

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

Direct Known Subclasses:

Transformation2D
```
public class Transformation
extends SBase
```
implementation of a 3D transformation matrix.
The Transformation class represents a 3D transformation which normally is a 4x4 matrix. Since the last row is always 0 0 0 1 for affine transformations, we leave out those values and store the matrix as an array of 4x3 columns

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`delete()` Explicitly deletes the underlying native object.
`static SWIGTYPE_p_double`	`getIdentityMatrix()` Returns a 3D identity matrix.
`SWIGTYPE_p_double`	`getMatrix()` Returns the matrix which is an array of double values of length 12.
`java.lang.String`	`getName()` Returns the value of the 'name' attribute of this `Transformation`.
`boolean`	`isSetMatrix()` Returns true if the matrix has been set or false otherwise.
`boolean`	`isSetName()` Predicate returning `true` or `false` depending on whether this `Transformation`'s 'name' attribute has been set.
`void`	`setMatrix(SWIGTYPE_p_double m)` Sets the matrix to the values given in the array.
`int`	`setName(java.lang.String name)` Sets the value of the 'name' attribute of this `Transformation`.
`int`	`unsetName()` Unsets the value of the 'name' attribute of this `Transformation`.

Methods inherited from class org.sbml.libsbml.SBase
addCVTerm, addCVTerm, appendAnnotation, appendAnnotation, appendNotes, appendNotes, cloneObject, connectToChild, deleteDisabledPlugins, deleteDisabledPlugins, disablePackage, enablePackage, equals, getAncestorOfType, getAncestorOfType, getAnnotation, getAnnotationString, getColumn, getCVTerm, getCVTerms, getDisabledPlugin, getElementByMetaId, getElementBySId, getElementName, getId, 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, getTypeCode, getURI, getVersion, hashCode, hasValidLevelVersionNamespaceCombination, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetId, isSetIdAttribute, isSetMetaId, isSetModelHistory, isSetNotes, isSetSBOTerm, isSetUserData, matchesRequiredSBMLNamespacesForAddition, matchesSBMLNamespaces, removeFromParentAndDelete, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, removeTopLevelAnnotationElement, renameMetaIdRefs, renameSIdRefs, renameUnitSIdRefs, replaceTopLevelAnnotationElement, replaceTopLevelAnnotationElement, setAnnotation, setAnnotation, setId, setIdAttribute, setMetaId, setModelHistory, setNamespaces, setNotes, setNotes, setNotes, setSBOTerm, setSBOTerm, toSBML, toXMLNode, unsetAnnotation, unsetCVTerms, unsetId, unsetIdAttribute, unsetMetaId, unsetModelHistory, unsetNotes, unsetSBOTerm, unsetUserData

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

- 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 Transformation.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 Transformation.delete() themselves.
    
    Overrides:
    
    delete in class SBase
  - getIdentityMatrix
```
public static SWIGTYPE_p_double getIdentityMatrix()
```
    Returns a 3D identity matrix. The matrix contains 12 double values.
  - setMatrix
```
public void setMatrix(SWIGTYPE_p_double m)
```
    Sets the matrix to the values given in the array.
    
    Parameters:
    
    m - array with new values to be set for this Transformation object.
  - getMatrix
```
public SWIGTYPE_p_double getMatrix()
```
    Returns the matrix which is an array of double values of length 12.
    
    Returns:
    
    a pointer to the array of numbers for the transformation.
  - isSetMatrix
```
public boolean isSetMatrix()
```
    Returns true if the matrix has been set or false otherwise. The matrix is considered as set if none of the values in the matrix is NaN.
    
    Returns:
    
    true or false depending on whether a NaN was found.
  - getName
```
public java.lang.String getName()
```
    Returns the value of the 'name' attribute of this Transformation.
    
    Overrides:
    
    getName in class SBase
    
    Returns:
    
    the name of the Transformation
    
    See Also:
    
    SBase.getIdAttribute(), SBase.isSetName(), SBase.setName(String sid), SBase.unsetName()
  - isSetName
```
public boolean isSetName()
```
    Predicate returning true or false depending on whether this Transformation's 'name' attribute has been set.
    
    Overrides:
    
    isSetName in class SBase
    
    Returns:
    
    returns true or false depending on whether the name on the Transformation has been set.
    
    See Also:
    
    SBase.getName(), SBase.setName(String sid), SBase.unsetName()
  - setName
```
public int setName(java.lang.String name)
```
    Sets the value of the 'name' attribute of this Transformation.
    
    Overrides:
    
    setName in class SBase
    
    Parameters:
    
    name - the new name for the Transformation
    
    Returns:
    
    status if the operation succeeded
  - unsetName
```
public int unsetName()
```
    Unsets the value of the 'name' attribute of this Transformation.
    Overrides:
    
    unsetName in class SBase
    
    Returns:
    integer value indicating success/failure of the function. The possible values returned by this function are:
    
    LIBSBML_OPERATION_SUCCESS
    LIBSBML_OPERATION_FAILED
    See Also:
    
    SBase.getName(), SBase.setName(String sid), SBase.isSetName()

Class Transformation

Method Summary

Methods inherited from class org.sbml.libsbml.SBase

Methods inherited from class java.lang.Object

Method Detail

delete

getIdentityMatrix

setMatrix

getMatrix

isSetMatrix

getName

isSetName

setName

unsetName