jpl.mipl.mars.rmc.util
Class Derivation

java.lang.Object
  jpl.mipl.mars.rmc.util.RmcElement
      jpl.mipl.mars.rmc.util.Derivation

All Implemented Interfaces:

Comparable

public class Derivation
extends RmcElement

Purpose: Implementation of Derivation tag from RMC file.

   Copyright 2003, California Institute of Technology.
   ALL RIGHTS RESERVED.
   U.S. Government Sponsorship acknowledge. 2003.
   

============================================================================ Modification History : ---------------------- Date Who What ---------------------------------------------------------------------------- 06/06/2003 Nick Initial Release ============================================================================

Version:

1.0

Author:

Nicholas Toole (Nicholas.T.Toole@jpl.nasa.gov)

Constructor Summary

Derivation()
Default constructor.

Derivation(Element node)
Constructor.

Derivation(String id, String referenceFrameName, List referenceFrameIndices, String[] offset, String[] orienatation)
Constructor.

Method Summary

String	getId() Returns the id of the derivation.
String[]	getOffset() Returns the offset of the derivation.
String	getOffsetX() Returns the x-offset of the derivation.
String	getOffsetY() Returns the y-offset of the derivation.
String	getOffsetZ() Returns the z-offset of the derivation.
String[]	getOrientation() Returns the orientation of the derivation.
String	getOrientationS() Returns the s quaternion position of the derivation.
String	getOrientationV1() Returns the v1 quaternion position of the derivation.
String	getOrientationV2() Returns the v2 quaternion position of the derivation.
String	getOrientationV3() Returns the v3 quaternion position of the derivation.
List	getReferenceFrameIndices() Returns the reference frame RMC of the derivation.
int	getReferenceFrameIndicesSize() Return the number of reference frame indices specified for this derivation RMC
String	getReferenceFrameName() Returns the reference frame name of the derivation.
boolean	offsetIsDefined() Predicate test for offset
boolean	orientationIsDefined() Predicate test for orientation
boolean	referenceFrameIsDefined() Predicate test for reference frmae
void	setId(String id) Sets the id of the derivation.
void	setOffset(String[] offset) Sets the offset of the derivation.
void	setOffsetX(String offsetX) Sets the x-offset of the derivation.
void	setOffsetY(String offsetY) Sets the y-offset of the derivation.
void	setOffsetZ(String offsetZ) Sets the z-offset of the derivation.
void	setOrientation(String[] orientation) Sets the orientation of the derivation.
void	setOrientationS(String orientationS) Sets the s quaternion position of the derivation.
void	setOrientationV1(String orientationV1) Sets the v1 quaternion position of the derivation.
void	setOrientationV2(String orientationV2) Sets the v2 quaternion position of the derivation.
void	setOrientationV3(String orientationV3) Sets the v3 quaternion position of the derivation.
void	setReferenceFrameIndices(List referenceFrameIndices) Sets the name of the derivation.
void	setReferenceFrameName(String referenceFrameName) Sets the reference frame name of the derivation.
Element	toDOM() Returns a DOM tree structure of a Derivation element including nested elements.
String	toXML() Returns an XML-formatted string of this object.

Methods inherited from class jpl.mipl.mars.rmc.util.RmcElement

compareTo, createEmptyDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

Derivation

public Derivation()

Default constructor.

Derivation

public Derivation(String id,
                  String referenceFrameName,
                  List referenceFrameIndices,
                  String[] offset,
                  String[] orienatation)

Constructor.

Parameters:

id - Id of the derivation

referenceFrameName - Reference frame name of the derivation

referenceFrameIndices - Reference frame RMC of the derivation

offset - Offset of the derivation

orientation - Orientation of the derivation

Derivation

public Derivation(Element node)

Constructor.

Parameters:

node - DOM Element of type Derivation

Method Detail

setId

public void setId(String id)

Sets the id of the derivation.

Parameters:

id - Id of the derivation

setReferenceFrameName

public void setReferenceFrameName(String referenceFrameName)

Sets the reference frame name of the derivation.

Parameters:

referenceFrameName - Reference frame name of the derivation

setReferenceFrameIndices

public void setReferenceFrameIndices(List referenceFrameIndices)

Sets the name of the derivation.

Parameters:

name - Name of the derivation

setOrientation

public void setOrientation(String[] orientation)

Sets the orientation of the derivation.

Parameters:

offset - String array of length 4 of the orientation of the derivation

setOffset

public void setOffset(String[] offset)

Sets the offset of the derivation.

Parameters:

offset - String array of length 3 of the offset of the derivation

getId

public String getId()

Returns the id of the derivation.

Returns:

Id of the derivation

getReferenceFrameName

public String getReferenceFrameName()

Returns the reference frame name of the derivation.

Returns:

Reference frame name of the derivation

getReferenceFrameIndices

public List getReferenceFrameIndices()

Returns the reference frame RMC of the derivation.

Returns:

Reference frame RMC of the derivation as a list

getReferenceFrameIndicesSize

public int getReferenceFrameIndicesSize()

Return the number of reference frame indices specified for this derivation RMC

Returns:

Number of reference frame indices specified for this derivation RMC

getOffset

public String[] getOffset()

Returns the offset of the derivation.

Returns:

offset of the derivation

getOrientation

public String[] getOrientation()

Returns the orientation of the derivation.

Returns:

orietation of the derivation

getOrientationS

public String getOrientationS()

Returns the s quaternion position of the derivation.

Returns:

S-quaternion position of the derivation

setOrientationS

public void setOrientationS(String orientationS)

Sets the s quaternion position of the derivation.

Parameters:

orientationS - S-quaternion position of the derivation

getOrientationV1

public String getOrientationV1()

Returns the v1 quaternion position of the derivation.

Returns:

V1-quaternion position of the derivation

setOrientationV1

public void setOrientationV1(String orientationV1)

Sets the v1 quaternion position of the derivation.

Parameters:

orientationV1 - V1-quaternion position of the derivation

getOrientationV2

public String getOrientationV2()

Returns the v2 quaternion position of the derivation.

Returns:

V2-quaternion position of the derivation

setOrientationV2

public void setOrientationV2(String orientationV2)

Sets the v2 quaternion position of the derivation.

Parameters:

orientationV2 - V2-quaternion position of the derivation

getOrientationV3

public String getOrientationV3()

Returns the v3 quaternion position of the derivation.

Returns:

V3-quaternion position of the derivation

setOrientationV3

public void setOrientationV3(String orientationV3)

Sets the v3 quaternion position of the derivation.

Parameters:

orientationV3 - V3-quaternion position of the derivation

getOffsetX

public String getOffsetX()

Returns the x-offset of the derivation.

Returns:

X offset of the derivation

setOffsetX

public void setOffsetX(String offsetX)

Sets the x-offset of the derivation.

Parameters:

offsetX - X-offset of the derivation

getOffsetY

public String getOffsetY()

Returns the y-offset of the derivation.

Returns:

Y offset of the derivation

setOffsetY

public void setOffsetY(String offsetY)

Sets the y-offset of the derivation.

Parameters:

offsetY - Y-offset of the derivation

getOffsetZ

public String getOffsetZ()

Returns the z-offset of the derivation.

Returns:

Z offset of the derivation

setOffsetZ

public void setOffsetZ(String offsetZ)

Sets the z-offset of the derivation.

Parameters:

offsetZ - Z-offset of the derivation

offsetIsDefined

public boolean offsetIsDefined()

Predicate test for offset

Returns:

True if offset is defined in this derivation, false otherwise

orientationIsDefined

public boolean orientationIsDefined()

Predicate test for orientation

Returns:

True if orientation is defined in this derivation, false otherwise

referenceFrameIsDefined

public boolean referenceFrameIsDefined()

Predicate test for reference frmae

Returns:

True if reference frame is defined in this derivation, false otherwise

toXML

public String toXML()

Returns an XML-formatted string of this object.

Specified by:

toXML in class RmcElement

Returns:

XML-formatted string of derivation data

toDOM

public Element toDOM()

Returns a DOM tree structure of a Derivation element including nested elements.

Specified by:

toDOM in class RmcElement

Returns:

Element node representation of this object.