org.sbml.jsbml.ext.dyn

Enum SpatialKind

java.lang.Object

java.lang.Enum<SpatialKind>

org.sbml.jsbml.ext.dyn.SpatialKind

All Implemented Interfaces:

Serializable, Comparable<SpatialKind>

public enum SpatialKind
extends Enum<SpatialKind>

This is a collection of possible values for the spatialIndex attribute within a SpatialComponent. Supported values this type are bound to a Cartesian coordinate system. This has been defined in version 1 of the Dynamic Structures specification.

Since:

1.0

Author:

Harold Gómez

Enum Constant Summary

Enum Constants

Enum Constant and Description
alpha Refers to elemental rotation of an object about the X coordinate axis
beta Refers to elemental rotation of an object about the Y coordinate axis
cartesianX Refers to the X coordinate component of an object's position within a Cartesian coordinate system
cartesianY Refers to the Y coordinate component of an object's position within a Cartesian coordinate system
cartesianZ Refers to the Z coordinate component of an object's position within a Cartesian coordinate system
F_x Refers to the X component of the force vector that drives movement
F_y Refers to the Y component of the force vector that drives movement
F_z Refers to the Z component of the force vector that drives movement
gamma Refers to elemental rotation of an object about the Z coordinate axis

Method Summary

Modifier and Type	Method and Description
static SpatialKind	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpatialKind[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

cartesianX

public static final SpatialKind cartesianX

Refers to the X coordinate component of an object's position within a Cartesian coordinate system

cartesianY

public static final SpatialKind cartesianY

Refers to the Y coordinate component of an object's position within a Cartesian coordinate system

cartesianZ

public static final SpatialKind cartesianZ

Refers to the Z coordinate component of an object's position within a Cartesian coordinate system

alpha

public static final SpatialKind alpha

Refers to elemental rotation of an object about the X coordinate axis

beta

public static final SpatialKind beta

Refers to elemental rotation of an object about the Y coordinate axis

gamma

public static final SpatialKind gamma

Refers to elemental rotation of an object about the Z coordinate axis

F_x

public static final SpatialKind F_x

Refers to the X component of the force vector that drives movement

F_y

public static final SpatialKind F_y

Refers to the Y component of the force vector that drives movement

F_z

public static final SpatialKind F_z

Refers to the Z component of the force vector that drives movement

Method Detail

values

public static SpatialKind[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpatialKind c : SpatialKind.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpatialKind valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null