vega.uplink.pointing.PtrParameters

Class DirectionVector

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.DirectionVector

Direct Known Subclasses:

Boresight, OffsetRefAxis, PdfmDirVector, PointedAxis, TargetDir, TargetInert

public class DirectionVector
extends PointingElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AXIS_TAG axis
static java.lang.String	FRAME_TAG frame
static java.lang.String	LATITUDE_TAG lat
static java.lang.String	LONGITUDE_TAG lon
static java.lang.String	ORIGIN_TAG origin
static java.lang.String	REF_TAG ref
static java.lang.String	ROTATE_TAG rotate
static java.lang.String	ROTATION_ANGLE_TAG rotationAngle
static java.lang.String	ROTATION_AXIS_TAG rotationAxis
static java.lang.String	TARGET_TAG target
static java.lang.String	UNITS_TAG units
static java.lang.String	X_TAG x
static java.lang.String	Y_TAG y
static java.lang.String	Z_TAG z

Constructor Summary

Constructors

Constructor and Description
DirectionVector(PointingElement org)
DirectionVector(java.lang.String type)
DirectionVector(java.lang.String type, PointingElement pm)
DirectionVector(java.lang.String type, java.lang.String reference) Creates a Direction vector referenced to another direction vector Direction vectors can be defined by referencing to direction vectors that were previously defined and got a name assigned.
DirectionVector(java.lang.String type, java.lang.String frame, float longitude, float latitude) Creates a fixed direction vector expressed in spherical coordinates For spherical coordinates the element must contain the child elements and .
DirectionVector(java.lang.String type, java.lang.String frame, float x, float y, float z) Creates a fixed direction vector expressed in cartesian coordinates For cartesian coordinates the element must contain the child elements and that contain fixed numbers specifying the components (that must not all be zero).
DirectionVector(java.lang.String type, java.lang.String origin, java.lang.String target) Creates a state vector based in Origin and Target This representation is used to define a direction vector from two state vectors.
DirectionVector(java.lang.String type, java.lang.String axis, java.lang.String rotationAxis, float rotationAngle) Creates a rotated Direction Vector This representation allows to define a direction vector by right-handed rotation of the direction vector axis around rotationAxis by the angle rotationAngle.
DirectionVector(java.lang.String type, java.lang.String frame, java.lang.String unitLongitude, float longitude, java.lang.String unitLatitude, float latitude) Creates a fixed direction vector expressed in spherical coordinates For spherical coordinates the element must contain the child elements and .
DirectionVector(java.lang.String type, java.lang.String axis, java.lang.String rotationAxis, java.lang.String rotationAngleUnit, float rotationAngle) Creates a rotated Direction Vector This representation allows to define a direction vector by right-handed rotation of the direction vector axis around rotationAxis by the angle rotationAngle.

Method Summary

Methods

Modifier and Type	Method and Description
DirectionVector	copy()
java.lang.String	getAxis() For rotated direction vector, get the axis this vector reference
java.lang.String	getFrame() Return the frame to which the vector is relative
float	getLatitude() For a direction vector expressed in spherical coordinates, get the latitude
float	getLatitude(java.lang.String unit) For a direction vector expressed in spherical coordinates, get the latitude in the given unit
java.lang.String	getLatitudeUnit() For a direction vector expressed in spherical coordinates, get the unit where the latitude is expressed.
float	getLongitude() For a direction vector expressed in spherical coordinates, get the longitude
float	getLongitude(java.lang.String unit) For a direction vector expressed in spherical coordinates, get the longitude in the given unit
java.lang.String	getLongitudeUnit() For a direction vector expressed in spherical coordinates, get the unit where the longitude is expressed.
java.lang.String	getOrigin() For state vector based in Origin and Target, get the Origin
java.lang.String	getReference() For referenced direction vectors set the name of the referenced vector
float	getRotationAngle() For rotated direction vector, get the rotation angle
float	getRotationAngle(java.lang.String unit) For rotated direction vector, get the rotation angle in the given unit
java.lang.String	getRotationAngleUnit() For rotated direction vector, get the units where the rotation angle is expressed.
java.lang.String	getRotationAxis() For rotated direction vector, get the axis this vector rotation axis
java.lang.String	getTarget() For state vector based in Origin and Target, get the Target
java.lang.String	getUnit(java.lang.String field)
float	getX() Get the x component of the fixed vector
float	getY() Get the y component of the fixed vector
float	getZ() Get the z component of the fixed vector
void	setAxis(java.lang.String axis) For rotated direction vector, set the axis this vector reference
void	setBooleanField(java.lang.String field, boolean value)
void	setFloatArrayField(java.lang.String field, float[] xAngles)
void	setFloatField(java.lang.String field, float value)
void	setFrame(java.lang.String frame) Set the frame to which the vector is relative
void	setIntegerField(java.lang.String field, int value)
void	setLatitude(float latitude) For a direction vector expressed in spherical coordinates, set the latitude in deg.
void	setLatitude(java.lang.String units, float latitude) For a direction vector expressed in spherical coordinates, set the latitude
void	setLongitude(float longitude) For a direction vector expressed in spherical coordinates, set the longitude in deg.
void	setLongitude(java.lang.String units, float longitude) For a direction vector expressed in spherical coordinates, set the longitude
void	setOrigin(java.lang.String origin) For state vector based in Origin and Target, set the Origin
void	setReference(java.lang.String reference) For referenced direction vectors set the name of the referenced vector
void	setRotationAngle(float angle) For rotated direction vector, set the rotation angle
void	setRotationAngle(java.lang.String angleUnit, float angle) For rotated direction vector, set the rotation angle
void	setRotationAxis(java.lang.String rotationAxis) For rotated direction vector, set the axis this vector rotation axis
void	setStringField(java.lang.String field, java.lang.String value)
void	setTarget(java.lang.String target) For state vector based in Origin and Target, set the Target
void	setUnit(java.lang.String field, java.lang.String unit)
void	setX(float x) Set the x component of the fixed vector
void	setY(float y) Set the y component of the fixed vector
void	setZ(float z) Set the z component of the fixed vector

Methods inherited from class vega.uplink.pointing.PointingElement

addAttribute, addChild, asDataset, copyFrom, equals, getAttribute, getAttributes, getChild, getChildren, getDescription, getFirstLevelTextContent, getName, getValue, hasAttributtes, hasChildren, readFrom, regenerate, removeAttribute, removeAttribute, setDescription, setValue, toString, toStringParameter, toXml, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNITS_TAG

public static java.lang.String UNITS_TAG

units

X_TAG

public static java.lang.String X_TAG

x

Y_TAG

public static java.lang.String Y_TAG

y

Z_TAG

public static java.lang.String Z_TAG

z

FRAME_TAG

public static java.lang.String FRAME_TAG

frame

LATITUDE_TAG

public static java.lang.String LATITUDE_TAG

lat

LONGITUDE_TAG

public static java.lang.String LONGITUDE_TAG

lon

ORIGIN_TAG

public static java.lang.String ORIGIN_TAG

origin

REF_TAG

public static java.lang.String REF_TAG

ref

TARGET_TAG

public static java.lang.String TARGET_TAG

target

ROTATE_TAG

public static java.lang.String ROTATE_TAG

rotate

AXIS_TAG

public static java.lang.String AXIS_TAG

axis

ROTATION_AXIS_TAG

public static java.lang.String ROTATION_AXIS_TAG

rotationAxis

ROTATION_ANGLE_TAG

public static java.lang.String ROTATION_ANGLE_TAG

rotationAngle

Constructor Detail

DirectionVector

public DirectionVector(java.lang.String type,
               PointingElement pm)

DirectionVector

public DirectionVector(PointingElement org)

DirectionVector

public DirectionVector(java.lang.String type)

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String frame,
               float x,
               float y,
               float z)

Creates a fixed direction vector expressed in cartesian coordinates For cartesian coordinates the element must contain the child elements and that contain fixed numbers specifying the components (that must not all be zero). The direction vector corresponds to the normalization of the vector.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

frame - The frame where this vector is expressed (SC,EME2000,CG)

x - The x component of this vector

y - The y component of this vector

z - The z component of this vector

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String frame,
               java.lang.String unitLongitude,
               float longitude,
               java.lang.String unitLatitude,
               float latitude)

Creates a fixed direction vector expressed in spherical coordinates For spherical coordinates the element must contain the child elements and . The cartesian components of the vector are (cos(lat)*cos(lon), cos(lat)*sin(lon), sin(lat)). For spherical coordinates the attribute units must be provided and must contain a dimension of an angle. The frame attribute specifies relative to which frame the direction vector is defined. Possible values are SC, EME2000 and CG.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

frame - The frame where this vector is expressed (SC,EME2000,CG)

unitLongitude - Unit in which the longitude is expressed

longitude - Longitude

unitLatitude - Unit in which the latitude is expressed

latitude - Latitude

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String frame,
               float longitude,
               float latitude)

Creates a fixed direction vector expressed in spherical coordinates For spherical coordinates the element must contain the child elements and . The cartesian components of the vector are (cos(lat)*cos(lon), cos(lat)*sin(lon), sin(lat)). The unit in which longitude and latitude are written must be deg. The frame attribute specifies relative to which frame the direction vector is defined. Possible values are SC, EME2000 and CG.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

frame - The frame where this vector is expressed (SC,EME2000,CG)

longitude - Longitude expressed in deg.

latitude - Latitude expressed in deg.

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String origin,
               java.lang.String target)

Creates a state vector based in Origin and Target This representation is used to define a direction vector from two state vectors. Because state vectors are always defined relative to inertial frame, the resulting direction vector is defined relative to inertial frame.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

origin - Origin State vector

target - Target State vector

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String reference)

Creates a Direction vector referenced to another direction vector Direction vectors can be defined by referencing to direction vectors that were previously defined and got a name assigned.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

reference - Name of the referenced direction vector

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String axis,
               java.lang.String rotationAxis,
               java.lang.String rotationAngleUnit,
               float rotationAngle)

Creates a rotated Direction Vector This representation allows to define a direction vector by right-handed rotation of the direction vector axis around rotationAxis by the angle rotationAngle. The axes axis and rotationAxis must both be defined either relative to SC or inertial frame.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

axis - The axis that this vector reference

rotationAxis - Rotation axis of the vector

rotationAngleUnit - Unit in which the angle of rotation is expressed

rotationAngle - Rotation angle

DirectionVector

public DirectionVector(java.lang.String type,
               java.lang.String axis,
               java.lang.String rotationAxis,
               float rotationAngle)

Creates a rotated Direction Vector This representation allows to define a direction vector by right-handed rotation of the direction vector axis around rotationAxis by the angle rotationAngle. The axes axis and rotationAxis must both be defined either relative to SC or inertial frame.

Parameters:

type - The type of direction vector (target, targetDir or dirVector)

axis - The axis that this vector reference

rotationAxis - Rotation axis of the vector

rotationAngle - Rotation angle. It must be expressed in deg.

Method Detail

copy

public DirectionVector copy()

Overrides:

copy in class PointingElement

getUnit

public java.lang.String getUnit(java.lang.String field)

setUnit

public void setUnit(java.lang.String field,
           java.lang.String unit)

setFloatArrayField

public void setFloatArrayField(java.lang.String field,
                      float[] xAngles)

setFloatField

public void setFloatField(java.lang.String field,
                 float value)

setIntegerField

public void setIntegerField(java.lang.String field,
                   int value)

setStringField

public void setStringField(java.lang.String field,
                  java.lang.String value)

setBooleanField

public void setBooleanField(java.lang.String field,
                   boolean value)

setX

public void setX(float x)

Set the x component of the fixed vector

Parameters:

x - The x component

setY

public void setY(float y)

Set the y component of the fixed vector

Parameters:

y - The y component

setZ

public void setZ(float z)

Set the z component of the fixed vector

Parameters:

z - The z component

getX

public float getX()

Get the x component of the fixed vector

Returns:

The x component

getY

public float getY()

Get the y component of the fixed vector

Returns:

The y component

getZ

public float getZ()

Get the z component of the fixed vector

Returns:

The z component

getFrame

public java.lang.String getFrame()

Return the frame to which the vector is relative

Returns:

Frame to which the vector is relative

setFrame

public void setFrame(java.lang.String frame)

Set the frame to which the vector is relative

Parameters:

frame - Frame to which the vector is relative

setLongitude

public void setLongitude(java.lang.String units,
                float longitude)

For a direction vector expressed in spherical coordinates, set the longitude

Parameters:

units - Unit in which the longitude is expressed

longitude - Longitude

setLongitude

public void setLongitude(float longitude)

For a direction vector expressed in spherical coordinates, set the longitude in deg.

Parameters:

longitude - Longitude in deg.

setLatitude

public void setLatitude(java.lang.String units,
               float latitude)

For a direction vector expressed in spherical coordinates, set the latitude

Parameters:

units - Unit in which the latitude is expressed

latitude - Latitude

setLatitude

public void setLatitude(float latitude)

For a direction vector expressed in spherical coordinates, set the latitude in deg.

Parameters:

latitude - Latitude in deg.

getLatitude

public float getLatitude()

For a direction vector expressed in spherical coordinates, get the latitude

Returns:

Latitude

getLatitude

public float getLatitude(java.lang.String unit)

For a direction vector expressed in spherical coordinates, get the latitude in the given unit

Parameters:

unit - the desired unit

Returns:

Latitude

getLongitude

public float getLongitude()

For a direction vector expressed in spherical coordinates, get the longitude

Returns:

Longitude

getLongitude

public float getLongitude(java.lang.String unit)

For a direction vector expressed in spherical coordinates, get the longitude in the given unit

Returns:

Longitude

getLongitudeUnit

public java.lang.String getLongitudeUnit()

For a direction vector expressed in spherical coordinates, get the unit where the longitude is expressed.

Returns:

unit where the longitude is expressed

getLatitudeUnit

public java.lang.String getLatitudeUnit()

For a direction vector expressed in spherical coordinates, get the unit where the latitude is expressed.

Returns:

unit where the latitude is expressed

setOrigin

public void setOrigin(java.lang.String origin)

For state vector based in Origin and Target, set the Origin

Parameters:

origin - Origin State vector

setTarget

public void setTarget(java.lang.String target)

For state vector based in Origin and Target, set the Target

Parameters:

target - Target State vector

getTarget

public java.lang.String getTarget()

For state vector based in Origin and Target, get the Target

Returns:

Target State vector

getOrigin

public java.lang.String getOrigin()

For state vector based in Origin and Target, get the Origin

Returns:

Origin State vector

setReference

public void setReference(java.lang.String reference)

For referenced direction vectors set the name of the referenced vector

Parameters:

reference - Name of the referenced vector

getReference

public java.lang.String getReference()

For referenced direction vectors set the name of the referenced vector

Returns:

Name of the referenced vector

setAxis

public void setAxis(java.lang.String axis)

For rotated direction vector, set the axis this vector reference

Parameters:

axis -

getAxis

public java.lang.String getAxis()

For rotated direction vector, get the axis this vector reference

Returns:

Axis

setRotationAxis

public void setRotationAxis(java.lang.String rotationAxis)

For rotated direction vector, set the axis this vector rotation axis

Parameters:

rotationAxis - Rotation Axis

getRotationAxis

public java.lang.String getRotationAxis()

For rotated direction vector, get the axis this vector rotation axis

Returns:

Rotation Axis

setRotationAngle

public void setRotationAngle(java.lang.String angleUnit,
                    float angle)

For rotated direction vector, set the rotation angle

Parameters:

angleUnit - Unit in which the angle of rotation is expressed

angle - Rotation angle

setRotationAngle

public void setRotationAngle(float angle)

For rotated direction vector, set the rotation angle

Parameters:

angle - Rotation angle. The rotation angle unit is set to deg.

getRotationAngle

public float getRotationAngle()

For rotated direction vector, get the rotation angle

Returns:

Rotation angle

getRotationAngle

public float getRotationAngle(java.lang.String unit)

For rotated direction vector, get the rotation angle in the given unit

Parameters:

unit - The desired unit

Returns:

Rotation angle

getRotationAngleUnit

public java.lang.String getRotationAngleUnit()

For rotated direction vector, get the units where the rotation angle is expressed.

Returns: