Main Page | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

srm::OrientationEulerAnglesZXZ Class Reference

The OrientationEulerAnglesZXZ class. The Orientation subclass in Euler Angles (ZXZ) representation. More...

#include <Orientation.h>

Inheritance diagram for srm::OrientationEulerAnglesZXZ:

Inheritance graph
[legend]
Collaboration diagram for srm::OrientationEulerAnglesZXZ:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OrientationEulerAnglesZXZ ()
 Default constructor.

 OrientationEulerAnglesZXZ (const SRM_Euler_Angles_ZXZ_Params &params)
 Constructor using Euler angles (ZXZ) parameter.

 OrientationEulerAnglesZXZ (SRM_Long_Float spin, SRM_Long_Float nutation, SRM_Long_Float precession)
 Constructor using spin, nutation, and precession parameters.

 OrientationEulerAnglesZXZ (const Orientation &other)
 Copy constructor.

virtual Orientationoperator= (const Orientation &other)
 Assignment operator.

virtual SRM_Euler_Angles_ZXZ_Params getEulerAnglesZXZ () const
 Gets the orientation in Euler angles (ZXZ) representation.

virtual void setEulerAnglesZXZ (const SRM_Euler_Angles_ZXZ_Params &params)
 Sets the Euler angles (ZXZ) orientation representation.

virtual void setEulerAnglesZXZ (SRM_Long_Float spin, SRM_Long_Float nutation, SRM_Long_Float precession)
 Sets the orientation using spin, nutation, and precession parameters.

virtual std::string toString () const
 Returns the string for the Euler angles (ZXZ) orientation representation.

virtual SRM_Ori_Rep_Type getOriRep () const
 Returns the native orientation representation type.


Static Public Member Functions

bool isValidParams (const SRM_Euler_Angles_ZXZ_Params &params)
 Returns true if the Euler angles (ZXZ) parameters represent a valid orientation.

OrientationEulerAnglesZXZ compose (const Orientation &left, const Orientation &right)
 Composes the right orientation with the left orientation and returns the result in the output orientation, i.e., composed_ori = left*right.

bool equivParams (const SRM_Euler_Angles_ZXZ_Params &params1, const SRM_Euler_Angles_ZXZ_Params &params2, SRM_Long_Float tolerance=0.0)
 ref: Table 3


Protected Member Functions

virtual void _updateIntData () const
 the virtual function to convert the data from native representation to the internal representation

virtual void _updateRepData ()
 the virtual function to convert the data from internal representation to the native representation


Protected Attributes

SRM_Euler_Angles_ZXZ_Params _euler_angles

Detailed Description

The OrientationEulerAnglesZXZ class. The Orientation subclass in Euler Angles (ZXZ) representation.

Author:
David Shen

Definition at line 488 of file Orientation.h.


Constructor & Destructor Documentation

srm::OrientationEulerAnglesZXZ::OrientationEulerAnglesZXZ  ) 
 

Default constructor.

The default value is (0, 0, 0).

srm::OrientationEulerAnglesZXZ::OrientationEulerAnglesZXZ const SRM_Euler_Angles_ZXZ_Params params  ) 
 

Constructor using Euler angles (ZXZ) parameter.

Note:
the spin angle is in radians in the range of [-2PI, 2PI]

the nutation angle is in radians in the range of [-2PI, 2PI]

the precession angle is in radians in the range of [-2PI, 2PI]

Exceptions:
This method throws srm::Exception

srm::OrientationEulerAnglesZXZ::OrientationEulerAnglesZXZ SRM_Long_Float  spin,
SRM_Long_Float  nutation,
SRM_Long_Float  precession
 

Constructor using spin, nutation, and precession parameters.

Parameters:
spin in: the spin angle, which is in radians in the range of [-2PI, 2PI]
nutation in: the nutation angle is in radians in the range of [-2PI, 2PI]
precession in: the precession angle, which is in radians in the range of [-2PI, 2PI]
Exceptions:
This method throws srm::Exception


Member Function Documentation

OrientationEulerAnglesZXZ srm::OrientationEulerAnglesZXZ::compose const Orientation left,
const Orientation right
[static]
 

Composes the right orientation with the left orientation and returns the result in the output orientation, i.e., composed_ori = left*right.

Exceptions:
This method throws srm::Exception

virtual void srm::OrientationEulerAnglesZXZ::setEulerAnglesZXZ SRM_Long_Float  spin,
SRM_Long_Float  nutation,
SRM_Long_Float  precession
[inline, virtual]
 

Sets the orientation using spin, nutation, and precession parameters.

Parameters:
spin in: the spin angle, which is in radians in the range of [-2PI, 2PI]
nutation in: the nutation angle is in radians in the range of [-2PI, 2PI]
precession in: the precession angle, which is in radians in the range of [-2PI, 2PI]
Exceptions:
This method throws srm::Exception

Reimplemented from srm::Orientation.

Definition at line 555 of file Orientation.h.

virtual void srm::OrientationEulerAnglesZXZ::setEulerAnglesZXZ const SRM_Euler_Angles_ZXZ_Params params  )  [virtual]
 

Sets the Euler angles (ZXZ) orientation representation.

Note:
the spin angle is in radians in the range of [-2PI, 2PI]

the nutation angle is in radians in the range of [-2PI, 2PI]

the precession angle is in radians in the range of [-2PI, 2PI]

Exceptions:
This method throws srm::Exception

Reimplemented from srm::Orientation.


The documentation for this class was generated from the following file:
Spatial Reference Model C++ API Version 4.4 - December 7, 2009
Copyright © 2009 SEDRIS Docs by Doxygen 1.3.2