org.spase.parser121
Enum EnumComponent

java.lang.Object
  java.lang.Enum<EnumComponent>
      org.spase.parser121.EnumComponent

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<EnumComponent>

public enum EnumComponent
extends java.lang.Enum<EnumComponent>

Java class for enumComponent.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="enumComponent">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="Phi"/>
     <enumeration value="R"/>
     <enumeration value="Theta"/>
     <enumeration value="X"/>
     <enumeration value="Y"/>
     <enumeration value="Z"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

PHI
The angle between the meridian of a vector and the zero meridian of the coordinate system in which the vector is expressed.

R
The component of a vector in the radial direction from the center of the coordinate system.

THETA
For spatial points, the angular distance from a meridian normal to the equator.

X
The component of a vector along the X-axis in a cartessian coordinate system.

Y
The component of a vector along the Y-axis in a cartessian coordinate system.

Z
The component of a vector along the Z-axis in a cartessian coordinate system.

Method Summary

static EnumComponent	fromValue(java.lang.String v)
java.lang.String	value()
static EnumComponent	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static EnumComponent[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

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

Enum Constant Detail

PHI

public static final EnumComponent PHI

The angle between the meridian of a vector and the zero meridian of the coordinate system in which the vector is expressed. Equivalently, the angle between the projection of a position or measured vector into the X-Y plane and X-axis in the coordinate system in which the vector is expressed. Also referred to as the azimuthal angle or "longitude". Mathematically: Phi = arctan(y/x)

R

public static final EnumComponent R

The component of a vector in the radial direction from the center of the coordinate system.

THETA

public static final EnumComponent THETA

For spatial points, the angular distance from a meridian normal to the equator. Also referred to as the zenith angle or "latitude". As a "latitude" angles range from +90 to -90 with zero at the equator and positive angles are in the direction designated as "North." An alternate range of values is often called "co-latitude" where values range from 0 to +180 as measured from the "north" pole. Mathematically: Theta = arctan(sqrt(x^2 + y^2)/z)

X

public static final EnumComponent X

The component of a vector along the X-axis in a cartessian coordinate system.

Y

public static final EnumComponent Y

The component of a vector along the Y-axis in a cartessian coordinate system.

Z

public static final EnumComponent Z

The component of a vector along the Z-axis in a cartessian coordinate system.

Method Detail

values

public static final EnumComponent[] values()

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

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

Returns:

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

valueOf

public static EnumComponent valueOf(java.lang.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:

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

value

public java.lang.String value()

fromValue

public static EnumComponent fromValue(java.lang.String v)