org.jeospace.coordinate
Class Attitude

java.lang.Object
  org.jeospace.coordinate.Attitude

public class Attitude

extends java.lang.Object

An object containing a set of measure objects that together represent an orientation, also commonly known as Euler Angles.

Version:

$Revision: 1.1.1.1 $

Author:

Rex Melton

See Also:

Longitude, Latitude

Field Summary

Latitude	pitch The pitch of the Attitude object
Longitude	roll The roll of the Attitude object
Longitude	yaw The yaw of the Attitude object

Constructor Summary

Attitude()
Create an Attitude initialized with default parameters; all coordinate components set to zero.

Attitude(Attitude a)
Create an Attitude initialized to duplicate the passed object.

Attitude(double yawDegrees, double pitchDegrees, double rollDegrees)
Create an Attitude initialized to the specified values.

Attitude(Longitude yaw, Latitude pitch, Longitude roll)
Create an Attitude initialized to the specified values.

Method Summary

void	clear() Clear the Attitude's components.
boolean	equals(java.lang.Object obj) Compare two Attitude objects for equality.
int	hashCode() Calculate the hashcode
void	set(Attitude a) Set the Attitude's components.
void	set(double yawDegrees, double pitchDegrees, double rollDegrees) Set the Attitude's components.
void	set(Longitude yaw, Latitude pitch, Longitude roll) Set the Attitude's components.
java.lang.String	toString() Return a string representation of this attitude.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

yaw

public final Longitude yaw

The yaw of the Attitude object

pitch

public final Latitude pitch

The pitch of the Attitude object

roll

public final Longitude roll

The roll of the Attitude object

Constructor Detail

Attitude

public Attitude()

Create an Attitude initialized with default parameters; all coordinate components set to zero.

Attitude

public Attitude(Longitude yaw,
                Latitude pitch,
                Longitude roll)

Create an Attitude initialized to the specified values.

Attitude

public Attitude(double yawDegrees,
                double pitchDegrees,
                double rollDegrees)

Create an Attitude initialized to the specified values.

Attitude

public Attitude(Attitude a)

Create an Attitude initialized to duplicate the passed object.

Method Detail

set

public void set(Longitude yaw,
                Latitude pitch,
                Longitude roll)

Set the Attitude's components.

Parameters:

yaw - the Longitude initializer for the yaw component

pitch - the Latitude initializer for the pitch component

roll - the Longitude initializer for the roll component

set

public void set(double yawDegrees,
                double pitchDegrees,
                double rollDegrees)

Set the Attitude's components.

Parameters:

yawDegrees - the double value initializer for the yaw component

pitchDegrees - the double value initializer for the pitch component

rollDegrees - the double value initializer for the roll component

set

public void set(Attitude a)

Set the Attitude's components.

Parameters:

a - the initializing Attitude object

clear

public void clear()

Clear the Attitude's components.

hashCode

public int hashCode()

Calculate the hashcode

Returns:

the hashcode

equals

public boolean equals(java.lang.Object obj)

Compare two Attitude objects for equality. The result is true if and only if the argument object is not null, is an Attitude object and represents an identical orientation as this Attitude coordinate object.

Two Attitude coordinate objects are equal only if it's constituent Longitude and Latitude objects are equal.

Parameters:

obj - the object to compare with

Returns:

true if the Attitude coordinate objects are the same; false otherwise.

toString

public java.lang.String toString()

Return a string representation of this attitude.

Returns:

a string representation of this attitude.