vega.uplink.pointing

Class PdfmSurface

java.lang.Object

CompositeDataset

vega.uplink.pointing.PointingElement

vega.uplink.pointing.PtrParameters.Surface

vega.uplink.pointing.PdfmSurface

public class PdfmSurface
extends Surface

Within the PDFM it is possible to define the surfaces. One surface with name CG is predefined and represents a spherical comet with 2km radius. This is the default surface used in Limb pointings.

Field Summary

Fields inherited from class vega.uplink.pointing.PtrParameters.Surface

SURFACE_TAG

Constructor Summary

Constructors

Constructor and Description
PdfmSurface()
PdfmSurface(PointingElement org)
PdfmSurface(java.lang.String surfaceName)
PdfmSurface(java.lang.String name, 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.
PdfmSurface(java.lang.String name, 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
java.lang.String	getSurfaceName() Get the name of this surface, that will be used to refer to it.
boolean	hasSurfaceName()
static PdfmSurface	readFrom(org.w3c.dom.Node node)
void	setSurfaceName(java.lang.String name) Set the name of the surface, that will be used to refer to it.
java.lang.String	toXml(int indent) Write a XML representation of this element

Methods inherited from class vega.uplink.pointing.PtrParameters.Surface

copy, getA, getA, getB, getB, getC, getC, getFloatField, getFrame, getOrigin, getRef, getUnit, getUnitA, getUnitB, getUnitC, setA, setAAxis, setAxis, setB, setBAxis, setC, setCAxis, setFloatField, setFrame, setOrigin, setRef, setUnit

Methods inherited from class vega.uplink.pointing.PointingElement

addAttribute, addChild, asDataset, copyFrom, equals, getAttribute, getAttributes, getChild, getChildren, getDescription, getFirstLevelTextContent, getName, getValue, hasAttributtes, hasChildren, 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

Constructor Detail

PdfmSurface

public PdfmSurface(PointingElement org)

PdfmSurface

public PdfmSurface()

PdfmSurface

public PdfmSurface(java.lang.String surfaceName)

PdfmSurface

public PdfmSurface(java.lang.String name,
           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:

name - Name of the surface, that will be used to refer to it.

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

PdfmSurface

public PdfmSurface(java.lang.String name,
           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:

name - Name of the surface, that will be used to refer to it.

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

Method Detail

setSurfaceName

public void setSurfaceName(java.lang.String name)

Set the name of the surface, that will be used to refer to it.

Parameters:

name -

getSurfaceName

public java.lang.String getSurfaceName()

Get the name of this surface, that will be used to refer to it.

Returns:

hasSurfaceName

public boolean hasSurfaceName()

Returns:

True if this surface has name that will be used to refer to it or false if it is an inline definition

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:

readFrom

public static PdfmSurface readFrom(org.w3c.dom.Node node)