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

srm::OrientationTaitBryanAngles Class Reference

The OrientationTaitBryanAngles class. The Orientation subclass in Tait-Bryan angles (XYZ) representation. More...

#include <Orientation.h>

Inheritance diagram for srm::OrientationTaitBryanAngles:

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

Collaboration graph
[legend]
List of all members.

Public Member Functions

 OrientationTaitBryanAngles ()
 Default constructor.

 OrientationTaitBryanAngles (const SRM_Tait_Bryan_Angles_Params &params)
 Constructor using Tait-Bryan angles parameter.

 OrientationTaitBryanAngles (SRM_Long_Float roll, SRM_Long_Float pitch, SRM_Long_Float yaw)
 Constructor using roll, pitch and yaw parameters.

 OrientationTaitBryanAngles (const Orientation &other)
 Copy constructor.

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

virtual SRM_Tait_Bryan_Angles_Params getTaitBryanAngles () const
 Gets the orientation in Tait-Bryan angles representation.

virtual void setTaitBryanAngles (const SRM_Tait_Bryan_Angles_Params &params)
 Sets the Tait-Bryan angles orientation representation.

virtual void setTaitBryanAngles (SRM_Long_Float roll, SRM_Long_Float pitch, SRM_Long_Float yaw)
 Sets the orientation using roll, pitch and yaw parameters.

virtual std::string toString () const
 Returns the string for the Tait-Bryan angles orientation representation.

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


Static Public Member Functions

bool isValidParams (const SRM_Tait_Bryan_Angles_Params &params)
 Returns true if the Tait-Bryan angles parameters represent a valid orientation.

OrientationTaitBryanAngles 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_Tait_Bryan_Angles_Params &params1, const SRM_Tait_Bryan_Angles_Params &params2, SRM_Long_Float tolerance=0.0)
 ref: Table 6


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_Tait_Bryan_Angles_Params _tait_bryan_angles

Detailed Description

The OrientationTaitBryanAngles class. The Orientation subclass in Tait-Bryan angles (XYZ) representation.

Author:
David Shen

Definition at line 611 of file Orientation.h.


Constructor & Destructor Documentation

srm::OrientationTaitBryanAngles::OrientationTaitBryanAngles  ) 
 

Default constructor.

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

srm::OrientationTaitBryanAngles::OrientationTaitBryanAngles const SRM_Tait_Bryan_Angles_Params params  ) 
 

Constructor using Tait-Bryan angles parameter.

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

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

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

Exceptions:
This method throws srm::Exception

srm::OrientationTaitBryanAngles::OrientationTaitBryanAngles SRM_Long_Float  roll,
SRM_Long_Float  pitch,
SRM_Long_Float  yaw
 

Constructor using roll, pitch and yaw parameters.

Parameters:
roll in: the roll angle, which is in radians in the range of [-2PI, 2PI]
pitch in: the pitch angle, which is in radians in the range of [-2PI, 2PI]
yaw in: the yaw angle, which is in radians in the range of [-2PI, 2PI]
Exceptions:
This method throws srm::Exception


Member Function Documentation

OrientationTaitBryanAngles srm::OrientationTaitBryanAngles::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::OrientationTaitBryanAngles::setTaitBryanAngles SRM_Long_Float  roll,
SRM_Long_Float  pitch,
SRM_Long_Float  yaw
[inline, virtual]
 

Sets the orientation using roll, pitch and yaw parameters.

Parameters:
roll in: the roll angle, which is in radians in the range of [-2PI, 2PI]
pitch in: the pitch angle, which is in radians in the range of [-2PI, 2PI]
yaw in: the yaw angle, which is in radians in the range of [-2PI, 2PI]
Exceptions:
This method throws srm::Exception

Reimplemented from srm::Orientation.

Definition at line 678 of file Orientation.h.

virtual void srm::OrientationTaitBryanAngles::setTaitBryanAngles const SRM_Tait_Bryan_Angles_Params params  )  [virtual]
 

Sets the Tait-Bryan angles orientation representation.

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

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

the yaw 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