vega.uplink.pointing.PtrParameters

Class Surface

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.Surface

Direct Known Subclasses:

PdfmSurface

public class Surface
extends PointingElement

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SURFACE_TAG surface

Constructor Summary

Constructors

Constructor and Description
Surface() Creates a surface referenced to the CG surface
Surface(PointingElement org)
Surface(java.lang.String ref) Creates a surface referenced to another surface
Surface(java.lang.String frame, java.lang.String origin, java.lang.String units, float a, float b, float c, float axisAX, float axisAY, float axisAZ, float axisBX, float axisBY, float axisBZ, float axisCX, float axisCY, float axisCZ) Creates a ellipsoid surface.
Surface(java.lang.String frame, java.lang.String origin, java.lang.String unitsA, float a, java.lang.String unitsB, float b, java.lang.String unitsC, float c, java.lang.String axisAFrame, float axisAX, float axisAY, float axisAZ, java.lang.String axisBFrame, float axisBX, float axisBY, float axisBZ, java.lang.String axisCFrame, float axisCX, float axisCY, float axisCZ) Creates a ellipsoid surface.

Method Summary

Methods

Modifier and Type	Method and Description
Surface	copy()
float	getA()
float	getA(java.lang.String unit)
float	getB()
float	getB(java.lang.String unit)
float	getC()
float	getC(java.lang.String unit)
float	getFloatField(java.lang.String field)
java.lang.String	getFrame() Return the frame to which the Surface is relative
java.lang.String	getOrigin() Get the origin component of this surface
java.lang.String	getRef() Get the name of the other surface this surface refers to
java.lang.String	getUnit(java.lang.String field)
java.lang.String	getUnitA()
java.lang.String	getUnitB()
java.lang.String	getUnitC()
void	setA(java.lang.String units, float value) Set the A semi axe component of this surface with units
void	setAAxis(java.lang.String frame, float x, float y, float z) Set the A axis of this surface, with the frame it refers to
void	setAxis(java.lang.String name, java.lang.String frame, float x, float y, float z) Set the a axis of this surface, with the frame it refers to
void	setB(java.lang.String units, float value) Set the B semi axe component of this surface with units
void	setBAxis(java.lang.String frame, float x, float y, float z) Set the B axis of this surface, with the frame it refers to
void	setC(java.lang.String units, float value) Set the C semi axe component of this surface with units
void	setCAxis(java.lang.String frame, float x, float y, float z) Set the C axis of this surface, with the frame it refers to
void	setFloatField(java.lang.String field, float value)
void	setFrame(java.lang.String frame) Set the frame that this surface is relative to.
void	setOrigin(java.lang.String origin) Set the origin component of this surface
void	setRef(java.lang.String ref) Set the name of the other surface this surface refers to
void	setUnit(java.lang.String field, java.lang.String unit)

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

SURFACE_TAG

public static java.lang.String SURFACE_TAG

surface

Constructor Detail

Surface

public Surface(PointingElement org)

Surface

public Surface()

Creates a surface referenced to the CG surface

Surface

public Surface(java.lang.String frame,
       java.lang.String origin,
       java.lang.String unitsA,
       float a,
       java.lang.String unitsB,
       float b,
       java.lang.String unitsC,
       float c,
       java.lang.String axisAFrame,
       float axisAX,
       float axisAY,
       float axisAZ,
       java.lang.String axisBFrame,
       float axisBX,
       float axisBY,
       float axisBZ,
       java.lang.String axisCFrame,
       float axisCX,
       float axisCY,
       float axisCZ)

Creates a ellipsoid surface. This representation allows to define a reference ellipsoid, defined by the semi axes a, b and c and the corresponding axes. The axes are defined relative to a frame (for example CG). The specified axes shall be mutually orthogonal.

Parameters:

frame - Frame that this surface is relative to

origin - Origin of the surface

unitsA - Units where the semi axe A is expressed

a - semi axe A

unitsB - Units where the semi axe B is expressed

b - semi axe B

unitsC - Units where the semi axe C is expressed

c - semi axe C

axisAFrame - Frame of the axe A

axisAX - X Component of the axe A

axisAY - Y Component of the axe A

axisAZ - Z Component of the axe A

axisBFrame - Frame of the axe B

axisBX - X Component of the axe B

axisBY - Y Component of the axe B

axisBZ - Z Component of the axe B

axisCFrame - Frame of the axe C

axisCX - X Component of the axe C

axisCY - Y Component of the axe C

axisCZ - Z Component of the axe C

Surface

public Surface(java.lang.String frame,
       java.lang.String origin,
       java.lang.String units,
       float a,
       float b,
       float c,
       float axisAX,
       float axisAY,
       float axisAZ,
       float axisBX,
       float axisBY,
       float axisBZ,
       float axisCX,
       float axisCY,
       float axisCZ)

Creates a ellipsoid surface. This representation allows to define a reference ellipsoid, defined by the semi axes a, b and c and the corresponding axes. The axes are defined relative to a frame (for example CG). The specified axes shall be mutually orthogonal.

Parameters:

frame - Frame that this surface is relative to (And the axis A, B and C)

origin - Origin of the surface

units - Units where the semi axes A,B and C is expressed

a - semi axe A

b - semi axe B

c - semi axe C

axisAX - X Component of the axe A

axisAY - Y Component of the axe A

axisAZ - Z Component of the axe A

axisBX - X Component of the axe B

axisBY - Y Component of the axe B

axisBZ - Z Component of the axe B

axisCX - X Component of the axe C

axisCY - Y Component of the axe C

axisCZ - Z Component of the axe C

Surface

public Surface(java.lang.String ref)

Creates a surface referenced to another surface

Parameters:

ref - Name of the other surface

Method Detail

copy

public Surface copy()

Overrides:

copy in class PointingElement

setFrame

public void setFrame(java.lang.String frame)

Set the frame that this surface is relative to.

Parameters:

frame -

setOrigin

public void setOrigin(java.lang.String origin)

Set the origin component of this surface

Parameters:

origin -

getOrigin

public java.lang.String getOrigin()

Get the origin component of this surface

Parameters:

origin -

setA

public void setA(java.lang.String units,
        float value)

Set the A semi axe component of this surface with units

Parameters:

origin -

getA

public float getA()

getA

public float getA(java.lang.String unit)

getUnitA

public java.lang.String getUnitA()

setB

public void setB(java.lang.String units,
        float value)

Set the B semi axe component of this surface with units

Parameters:

origin -

getB

public float getB()

getB

public float getB(java.lang.String unit)

getUnitB

public java.lang.String getUnitB()

setC

public void setC(java.lang.String units,
        float value)

Set the C semi axe component of this surface with units

Parameters:

origin -

getC

public float getC()

getC

public float getC(java.lang.String unit)

getUnitC

public java.lang.String getUnitC()

setAxis

public void setAxis(java.lang.String name,
           java.lang.String frame,
           float x,
           float y,
           float z)

Set the a axis of this surface, with the frame it refers to

Parameters:

name -

frame -

x -

y -

z -

setAAxis

public void setAAxis(java.lang.String frame,
            float x,
            float y,
            float z)

Set the A axis of this surface, with the frame it refers to

Parameters:

frame -

x -

y -

z -

setBAxis

public void setBAxis(java.lang.String frame,
            float x,
            float y,
            float z)

Set the B axis of this surface, with the frame it refers to

Parameters:

frame -

x -

y -

z -

setCAxis

public void setCAxis(java.lang.String frame,
            float x,
            float y,
            float z)

Set the C axis of this surface, with the frame it refers to

Parameters:

frame -

x -

y -

z -

setFloatField

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

getFloatField

public float getFloatField(java.lang.String field)

getUnit

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

setUnit

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

getFrame

public java.lang.String getFrame()

Return the frame to which the Surface is relative

Returns:

Frame to which the vector is relative

setRef

public void setRef(java.lang.String ref)

Set the name of the other surface this surface refers to

Parameters:

ref -

getRef

public java.lang.String getRef()

Get the name of the other surface this surface refers to

Parameters:

ref -