org.sbml.jsbml.ext.spatial

Class CSGRotation

java.lang.Object

org.sbml.jsbml.AbstractTreeNode

org.sbml.jsbml.AbstractSBase

org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

org.sbml.jsbml.ext.spatial.CSGNode

org.sbml.jsbml.ext.spatial.CSGTransformation

org.sbml.jsbml.ext.spatial.CSGRotation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, javax.swing.tree.TreeNode, SpatialNamedSBase, SBase, TreeNodeWithChangeSupport

public class CSGRotation
extends CSGTransformation

Since:

1.0

Version:

$Rev: 1639 $

Author:

Alex Thomas

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Double	rotateAngleInRadians
private java.lang.Double	rotateAxisX
private java.lang.Double	rotateAxisY
private java.lang.Double	rotateAxisZ
private static long	serialVersionUID

Fields inherited from class org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

spatialId

Fields inherited from class org.sbml.jsbml.AbstractSBase

ignoredExtensions, ignoredXMLElements

Fields inherited from class org.sbml.jsbml.AbstractTreeNode

listOfListeners, parent, UNKNOWN_ATTRIBUTES, UNKNOWN_ELEMENTS

Constructor Summary

Constructors

Constructor and Description
CSGRotation()
CSGRotation(CSGRotation csgt)
CSGRotation(int level, int version)
CSGRotation(java.lang.String id, int level, int version)

Method Summary

Methods

Modifier and Type	Method and Description
CSGRotation	clone() Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.
boolean	equals(java.lang.Object object) Returns true if and only if the given SBase has exactly the same properties like this SBase instance.
double	getRotateAngleInRadians() Returns the value of rotateAngleInRadians
double	getRotateAxisX() Returns the value of rotateAxisX
double	getRotateAxisY() Returns the value of rotateAxisY
double	getRotateAxisZ() Returns the value of rotateAxisZ
int	hashCode() Returns a hash code value for this SBase instance.
boolean	isSetRotateAngleInRadians() Returns whether rotateAngleInRadians is set
boolean	isSetRotateAxisX() Returns whether rotateAxisX is set
boolean	isSetRotateAxisY() Returns whether rotateAxisY is set
boolean	isSetRotateAxisZ() Returns whether rotateAxisZ is set
boolean	readAttribute(java.lang.String attributeName, java.lang.String prefix, java.lang.String value) Sets the given attribute in this SBase.
void	setRotateAngleInRadians(double rotateAngleInRadians) Sets the value of rotateAngleInRadians
void	setRotateAxisX(double rotateAxisX) Sets the value of rotateAxisX
void	setRotateAxisY(double rotateAxisY) Sets the value of rotateAxisY
void	setRotateAxisZ(double rotateAxisZ) Sets the value of rotateAxisZ
java.lang.String	toString()
boolean	unsetRotateAngleInRadians() Unsets the variable rotateAngleInRadians
boolean	unsetRotateAxisX() Unsets the variable rotateAxisX
boolean	unsetRotateAxisY() Unsets the variable rotateAxisY
boolean	unsetRotateAxisZ() Unsets the variable rotateAxisZ
java.util.Map<java.lang.String,java.lang.String>	writeXMLAttributes() Returns a map with all the attributes of this SBase that need to be written out in XML.

Methods inherited from class org.sbml.jsbml.ext.spatial.CSGTransformation

getAllowsChildren, getChildAt, getChildCount, getCSGNode, isSetCSGNode, setCSGNode, unsetCSGNode

Methods inherited from class org.sbml.jsbml.ext.spatial.AbstractSpatialNamedSBase

getSpatialId, isSetSpatialId, setSpatialId, unsetSpatialId

Methods inherited from class org.sbml.jsbml.AbstractSBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, checkLevelAndVersionCompatibility, createHistory, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, fireNodeRemovedEvent, firePropertyChange, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getIdManager, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParent, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, isValidLevelAndVersionCombination, isValidMetaId, notifyChildChange, registerChild, removeCVTerm, removeCVTerm, setAnnotation, setHistory, setLevel, setMetaId, setNamespace, setNotes, setNotes, setParentSBML, setParentSBMLObject, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNamespace, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from class org.sbml.jsbml.AbstractTreeNode

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, children, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, getIndex, getListOfTreeNodeChangeListeners, getNumChildren, getRoot, getTreeNodeChangeListenerCount, getUserObject, indexOf, isLeaf, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeTreeNodeChangeListener, removeUserObject, setParent, userObjectKeySet

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.sbml.jsbml.SBase

addCVTerm, addDeclaredNamespace, addExtension, addPlugin, appendNotes, appendNotes, createPlugin, disablePackage, enablePackage, enablePackage, filterCVTerms, filterCVTerms, filterCVTerms, filterCVTerms, getAnnotation, getAnnotationString, getCVTerm, getCVTermCount, getCVTerms, getDeclaredNamespaces, getElementName, getExtension, getExtensionCount, getExtensionPackages, getHistory, getLevel, getLevelAndVersion, getMetaId, getModel, getNamespace, getNotes, getNotesString, getNumCVTerms, getNumPlugins, getParentSBMLObject, getPlugin, getSBMLDocument, getSBOTerm, getSBOTermID, getVersion, hasValidAnnotation, hasValidLevelVersionNamespaceCombination, isExtendedByOtherPackages, isPackageEnabled, isPackageURIEnabled, isPkgEnabled, isPkgURIEnabled, isSetAnnotation, isSetHistory, isSetLevel, isSetLevelAndVersion, isSetMetaId, isSetNotes, isSetParentSBMLObject, isSetPlugin, isSetSBOTerm, isSetVersion, registerChild, removeCVTerm, removeCVTerm, removeTreeNodeChangeListener, setAnnotation, setHistory, setLevel, setMetaId, setNotes, setNotes, setSBOTerm, setSBOTerm, setThisAsParentSBMLObject, setVersion, unregisterChild, unsetAnnotation, unsetCVTerms, unsetExtension, unsetHistory, unsetMetaId, unsetNotes, unsetPlugin, unsetSBOTerm

Methods inherited from interface org.sbml.jsbml.util.TreeNodeWithChangeSupport

addAllChangeListeners, addAllChangeListeners, addTreeNodeChangeListener, addTreeNodeChangeListener, clearUserObjects, containsUserObjectKey, filter, filter, filter, fireNodeAddedEvent, fireNodeRemovedEvent, firePropertyChange, getListOfTreeNodeChangeListeners, getRoot, getTreeNodeChangeListenerCount, getUserObject, isRoot, isSetParent, isSetUserObjects, putUserObject, removeAllTreeNodeChangeListeners, removeAllTreeNodeChangeListeners, removeFromParent, removeTreeNodeChangeListener, removeUserObject, userObjectKeySet

Methods inherited from interface javax.swing.tree.TreeNode

children, getIndex, getParent, isLeaf

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

rotateAxisX

private java.lang.Double rotateAxisX

rotateAxisY

private java.lang.Double rotateAxisY

rotateAxisZ

private java.lang.Double rotateAxisZ

rotateAngleInRadians

private java.lang.Double rotateAngleInRadians

Constructor Detail

CSGRotation

public CSGRotation()

CSGRotation

public CSGRotation(CSGRotation csgt)

Parameters:

node -

CSGRotation

public CSGRotation(int level,
           int version)

Parameters:

level -

version -

CSGRotation

public CSGRotation(java.lang.String id,
           int level,
           int version)

Parameters:

id -

level -

version -

Method Detail

clone

public CSGRotation clone()

Description copied from interface: SBase

Creates a deep copy of this object, i.e., a new SBase with the same properties like this one.

Specified by:

clone in interface SBase

Specified by:

clone in class AbstractSBase

Returns:

a copy of this object

equals

public boolean equals(java.lang.Object object)

Description copied from interface: SBase

Returns true if and only if the given SBase has exactly the same properties like this SBase instance.

Specified by:

equals in interface SBase

Overrides:

equals in class CSGTransformation

Parameters:

object - the SBase to be compared to.

Returns:

true if and only if the given Object is an instance of SBase that has exactly the same properties like this SBase instance.

getRotateAxisX

public double getRotateAxisX()

Returns the value of rotateAxisX

Returns:

the value of rotateAxisX

isSetRotateAxisX

public boolean isSetRotateAxisX()

Returns whether rotateAxisX is set

Returns:

whether rotateAxisX is set

setRotateAxisX

public void setRotateAxisX(double rotateAxisX)

Sets the value of rotateAxisX

unsetRotateAxisX

public boolean unsetRotateAxisX()

Unsets the variable rotateAxisX

Returns:

true, if rotateAxisX was set before, otherwise false

getRotateAxisY

public double getRotateAxisY()

Returns the value of rotateAxisY

Returns:

the value of rotateAxisY

isSetRotateAxisY

public boolean isSetRotateAxisY()

Returns whether rotateAxisY is set

Returns:

whether rotateAxisY is set

setRotateAxisY

public void setRotateAxisY(double rotateAxisY)

Sets the value of rotateAxisY

unsetRotateAxisY

public boolean unsetRotateAxisY()

Unsets the variable rotateAxisY

Returns:

true, if rotateAxisY was set before, otherwise false

getRotateAxisZ

public double getRotateAxisZ()

Returns the value of rotateAxisZ

Returns:

the value of rotateAxisZ

isSetRotateAxisZ

public boolean isSetRotateAxisZ()

Returns whether rotateAxisZ is set

Returns:

whether rotateAxisZ is set

setRotateAxisZ

public void setRotateAxisZ(double rotateAxisZ)

Sets the value of rotateAxisZ

unsetRotateAxisZ

public boolean unsetRotateAxisZ()

Unsets the variable rotateAxisZ

Returns:

true, if rotateAxisZ was set before, otherwise false

getRotateAngleInRadians

public double getRotateAngleInRadians()

Returns the value of rotateAngleInRadians

Returns:

the value of rotateAngleInRadians

isSetRotateAngleInRadians

public boolean isSetRotateAngleInRadians()

Returns whether rotateAngleInRadians is set

Returns:

whether rotateAngleInRadians is set

setRotateAngleInRadians

public void setRotateAngleInRadians(double rotateAngleInRadians)

Sets the value of rotateAngleInRadians

unsetRotateAngleInRadians

public boolean unsetRotateAngleInRadians()

Unsets the variable rotateAngleInRadians

Returns:

true, if rotateAngleInRadians was set before, otherwise false

hashCode

public int hashCode()

Description copied from interface: SBase

Returns a hash code value for this SBase instance.

Specified by:

hashCode in interface SBase

Overrides:

hashCode in class AbstractSpatialNamedSBase

Returns:

a hash code value for this SBase instance.

See Also:

Object.hashCode()

writeXMLAttributes

public java.util.Map<java.lang.String,java.lang.String> writeXMLAttributes()

Description copied from interface: SBase

Returns a map with all the attributes of this SBase that need to be written out in XML.

The attribute name is used as a key and the attribute value as value. If a prefix is needed for the attribute name, it need to be set directly in this map.

Specified by:

writeXMLAttributes in interface SBase

Overrides:

writeXMLAttributes in class AbstractSpatialNamedSBase

Returns:

a Map containing the XML attributes of this object.

readAttribute

public boolean readAttribute(java.lang.String attributeName,
                    java.lang.String prefix,
                    java.lang.String value)

Description copied from interface: SBase

Sets the given attribute in this SBase.

If the given attribute name is not recognized, nothing is done and false is returned.

Specified by:

readAttribute in interface SBase

Overrides:

readAttribute in class AbstractSpatialNamedSBase

Parameters:

attributeName - localName of the XML attribute

prefix - prefix of the XML attribute

value - value of the XML attribute

Returns:

true if the attribute has been successfully read.

toString

public java.lang.String toString()

Overrides:

toString in class AbstractSpatialNamedSBase