vega.uplink.pointing.PtrParameters

Class StateVector

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.StateVector

Direct Known Subclasses:

TargetTrack

public class StateVector
extends PointingElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_UNIT km
static java.lang.String	FRAME_FIELD frame
static java.lang.String	LANDMARK_FIELD landmark
static java.lang.String	NAME_TAG name
static java.lang.String	ORIGIN_FIELD origin
static java.lang.String	POSITION_FIELD position
static java.lang.String	REF_TAG ref
static java.lang.String	UNITS_TAG units
static java.lang.String	X_FIELD x
static java.lang.String	Y_FIELD y
static java.lang.String	Z_FIELD z

Constructor Summary

Constructors

Constructor and Description
StateVector(PointingElement org)
StateVector(java.lang.String type, java.lang.String ref) Creates a new StateVector refereed to a solar system object or landmarks defined in the PDFM
StateVector(java.lang.String type, java.lang.String origin, java.lang.String frame, float x, float y, float z) Definition of a state vector that represents a landmark
StateVector(java.lang.String type, java.lang.String landmark, java.lang.String origin, java.lang.String frame, float x, float y, float z) Definition of a state vector that represents a landmark
StateVector(java.lang.String type, java.lang.String origin, java.lang.String frame, java.lang.String xUnit, float x, java.lang.String yUnit, float y, java.lang.String zUnit, float z) Definition of a state vector that represents a landmark
StateVector(java.lang.String type, java.lang.String origin, java.lang.String frame, java.lang.String x, java.lang.String y, java.lang.String z) Definition of a state vector that represents a landmark
StateVector(java.lang.String type, java.lang.String landmark, java.lang.String origin, java.lang.String frame, java.lang.String x, java.lang.String y, java.lang.String z) Definition of a state vector that represents a landmark

Method Summary

Methods

Modifier and Type	Method and Description
StateVector	copy()
java.lang.String	getLandMark() Get the name of the landmark
java.lang.String	getOrigin() Get the origin component of the landmark
java.lang.String	getRef() Get the referenced solar system object or landmark
java.lang.String	getUnit(java.lang.String field)
java.lang.String	getUnitX() Get the unit where X component of the position of the landmark is expressed
java.lang.String	getUnitY() Get the unit where Y component of the position of the landmark is expressed
java.lang.String	getUnitZ() Get the unit where Z component of the position of the landmark is expressed
float	getX() Get the X component of the position of the landmark
float	getX(java.lang.String unit)
float	getY() Get the Y component of the position of the landmark
float	getY(java.lang.String unit)
float	getZ() Get the Y component of the position of the landmark
float	getZ(java.lang.String unit)
void	setLandMark(java.lang.String name)
void	setOrigin(java.lang.String origin) Set the origin component of the landmark
void	setRef(java.lang.String ref) Set the referenced solar system object or landmark
void	setUnit(java.lang.String field, java.lang.String unit)
void	setX(java.lang.String unit, float x) Set the X component of the position of the landmark
void	setY(java.lang.String unit, float y) Set the Y component of the position of the landmark
void	setZ(java.lang.String unit, float z) Set the Z component of the position of the landmark
java.lang.String	toXml(int indent) Write a XML representation of this element

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, validate

Methods inherited from class java.lang.Object

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

Field Detail

REF_TAG

public static java.lang.String REF_TAG

ref

POSITION_FIELD

public static java.lang.String POSITION_FIELD

position

FRAME_FIELD

public static java.lang.String FRAME_FIELD

frame

ORIGIN_FIELD

public static java.lang.String ORIGIN_FIELD

origin

X_FIELD

public static java.lang.String X_FIELD

x

Y_FIELD

public static java.lang.String Y_FIELD

y

Z_FIELD

public static java.lang.String Z_FIELD

z

DEFAULT_UNIT

public static java.lang.String DEFAULT_UNIT

km

LANDMARK_FIELD

public static java.lang.String LANDMARK_FIELD

landmark

UNITS_TAG

public static java.lang.String UNITS_TAG

units

NAME_TAG

public static java.lang.String NAME_TAG

name

Constructor Detail

StateVector

public StateVector(PointingElement org)

StateVector

public StateVector(java.lang.String type,
           java.lang.String ref)

Creates a new StateVector refereed to a solar system object or landmarks defined in the PDFM

Parameters:

type - Type of the stateVector

ref - solar system object or landmarks defined in the PDFM

StateVector

public StateVector(java.lang.String type,
           java.lang.String landmark,
           java.lang.String origin,
           java.lang.String frame,
           java.lang.String x,
           java.lang.String y,
           java.lang.String z)

Definition of a state vector that represents a landmark

Parameters:

type - The type of state vector. Subclasses will hardcode this type

landmark - The name of the landmark

origin - The origin

frame - The frame where the landmark is defined

x - The X component of the position of the landmark. It must be expressed in km.

y - The Y component of the position of the landmark. It must be expressed in km.

z - The Z component of the position of the landmark. It must be expressed in km.

StateVector

public StateVector(java.lang.String type,
           java.lang.String origin,
           java.lang.String frame,
           java.lang.String x,
           java.lang.String y,
           java.lang.String z)

Definition of a state vector that represents a landmark

Parameters:

type - The type of state vector. Subclasses will harcode this type

origin - The origin

frame - The frame where the landmark is defined

x - The X component of the position of the landmark. It must be expressed in km.

y - The Y component of the position of the landmark. It must be expressed in km.

z - The Z component of the position of the landmark. It must be expressed in km.

StateVector

public StateVector(java.lang.String type,
           java.lang.String landmark,
           java.lang.String origin,
           java.lang.String frame,
           float x,
           float y,
           float z)

Definition of a state vector that represents a landmark

Parameters:

type - The type of state vector. Subclasses will harcode this type

landmark - The name of the landmark

origin - The origin

frame - The frame where the landmark is defined

x - The X component of the position of the landmark. It must be expressed in km.

y - The Y component of the position of the landmark. It must be expressed in km.

z - The Z component of the position of the landmark. It must be expressed in km.

StateVector

public StateVector(java.lang.String type,
           java.lang.String origin,
           java.lang.String frame,
           java.lang.String xUnit,
           float x,
           java.lang.String yUnit,
           float y,
           java.lang.String zUnit,
           float z)

Definition of a state vector that represents a landmark

Parameters:

type - The type of state vector. Subclasses will harcode this type

origin - The origin

frame - The frame where the landmark is defined

xUnit - The unit that the X component of the landmark is expressed

x - The X component of the position of the landmark.

yUnit - The unit that the Y component of the landmark is expressed

y - The Y component of the position of the landmark.

zUnit - The unit that the Z component of the landmark is expressed

z - The Z component of the position of the landmark.

StateVector

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

Definition of a state vector that represents a landmark

Parameters:

type - The type of state vector. Subclasses will harcode this type

origin - The origin

frame - The frame where the landmark is defined

x - The X component of the position of the landmark. It must be expressed in km.

y - The Y component of the position of the landmark. It must be expressed in km.

z - The Z component of the position of the landmark. It must be expressed in km.

Method Detail

copy

public StateVector copy()

Overrides:

copy in class PointingElement

setRef

public void setRef(java.lang.String ref)

Set the referenced solar system object or landmark

Parameters:

ref - solar system object or landmarks defined in the PDFM

getRef

public java.lang.String getRef()

Get the referenced solar system object or landmark

Returns:

solar system object or landmark defined in the PDFM

setOrigin

public void setOrigin(java.lang.String origin)

Set the origin component of the landmark

Parameters:

origin -

getOrigin

public java.lang.String getOrigin()

Get the origin component of the landmark

Returns:

setX

public void setX(java.lang.String unit,
        float x)

Set the X component of the position of the landmark

Parameters:

unit - The unit that the X component of the position of the landmark is expressed

x - the X component of the position of the landmark

setY

public void setY(java.lang.String unit,
        float y)

Set the Y component of the position of the landmark

Parameters:

unit - The unit that the Y component of the position of the landmark is expressed

y - the Y component of the position of the landmark

setZ

public void setZ(java.lang.String unit,
        float z)

Set the Z component of the position of the landmark

Parameters:

unit - The unit that the Z component of the position of the landmark is expressed

z - the Z component of the position of the landmark

getX

public float getX()

Get the X component of the position of the landmark

Returns:

X component of the position of the landmark

getX

public float getX(java.lang.String unit)

getY

public float getY()

Get the Y component of the position of the landmark

Returns:

Y component of the position of the landmark

getY

public float getY(java.lang.String unit)

getZ

public float getZ()

Get the Y component of the position of the landmark

Returns:

Y component of the position of the landmark

getZ

public float getZ(java.lang.String unit)

getUnitX

public java.lang.String getUnitX()

Get the unit where X component of the position of the landmark is expressed

Returns:

the unit where X component of the position of the landmark is expressed

getUnitY

public java.lang.String getUnitY()

Get the unit where Y component of the position of the landmark is expressed

Returns:

the unit where Y component of the position of the landmark is expressed

getUnitZ

public java.lang.String getUnitZ()

Get the unit where Z component of the position of the landmark is expressed

Returns:

the unit where Z component of the position of the landmark is expressed

getLandMark

public java.lang.String getLandMark()

Get the name of the landmark

Returns:

the name of the landmark

setLandMark

public void setLandMark(java.lang.String name)

getUnit

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

setUnit

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

toXml

public java.lang.String toXml(int indent)

Description copied from class: PointingElement

Write a XML representation of this element

Overrides:

toXml in class PointingElement

Parameters:

indent - The initial indent to be applied to the XML

Returns: