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

srm::Orientation Class Reference

The Orientation abstract contains a 3x3 matrix and a reference location. More...

#include <Orientation.h>

Collaboration diagram for srm::Orientation:

Collaboration graph
[legend]
List of all members.

Public Member Functions

BaseSRF * getSRF () const
 Returns the SRF this Orientation belongs to.

void getRefCoord (Coord3D &coord) const
 Gets the reference coordinate.

void getMatrix (Matrix3x3 mat) const
 Gets the orientation matrix.

void getDirectionComp1 (Direction &dir) const
 Gets the first Direction component of the Orientation.

void getDirectionComp2 (Direction &dir) const
 Gets the second Direction component of the Orientation.

void getDirectionComp3 (Direction &dir) const
 Gets the third Direction component of the Orientation.

void getDirectionComp (SRM_Integer index, Direction &dir) const
 Gets the nth Direction component of the Orientation.

void setDirectionComp (const Direction &dir1, const Direction &dir2, const Direction &dir3)
 Sets the Direction components of the Orientation.

void setDirectionComp (const SRM_Integer index, const Direction &dir)
 Sets the Direction components of the Orientation.

void setMatrix (const Matrix3x3 mat)
 Sets the orientation matrix values.

bool isEqual (const Orientation &ori) const
 Returns true if this has the same ref_coord and matrix.

Orientation * makeCopy () const
 Makes a shallow copy of this Orientation object.


Protected Member Functions

 Orientation (BaseSRF *srf, const Vector3 ref_coord, const Matrix3x3 matrix)
 Constructor, requires an SRF, 3 reference coordinate values, and a 3x3 matrix.

virtual ~Orientation ()
 Destructor, releases the SRF.

Orientation & operator= (const Orientation &)
 No copy constructor.


Protected Attributes

BaseSRF * _srf
 The SRF this Orientation belongs to.

Vector3 _ref_coord
 The reference coordinate values.

Matrix3x3 _mat
 The matrix values.


Friends

class BaseSRF_3D

Detailed Description

The Orientation abstract contains a 3x3 matrix and a reference location.

Author:
TBD
See also:
BaseSRF_3D

Definition at line 30 of file Orientation.h.

Member Function Documentation

void srm::Orientation::getDirectionComp (  SRM_Integer  index,
Direction &  dir
)  const
 

Gets the nth Direction component of the Orientation.

Exceptions:
This method throws srm::Exception
Note:
the index is [ 1, 2, 3 ]

void srm::Orientation::getDirectionComp1 (  Direction &  dir  )  const
 

Gets the first Direction component of the Orientation.

Exceptions:
This method throws srm::Exception

void srm::Orientation::getDirectionComp2 (  Direction &  dir  )  const
 

Gets the second Direction component of the Orientation.

Exceptions:
This method throws srm::Exception

void srm::Orientation::getDirectionComp3 (  Direction &  dir  )  const
 

Gets the third Direction component of the Orientation.

Exceptions:
This method throws srm::Exception

void srm::Orientation::getRefCoord (  Coord3D &  coord  )  const
 

Gets the reference coordinate.

Exceptions:
This method throws srm::Exception

void srm::Orientation::setDirectionComp (  const SRM_Integer  index,
const Direction &  dir
) 
 

Sets the Direction components of the Orientation.

Note:
the index is [ 1, 2, 3 ]
Exceptions:
This method throws srm::Exception

void srm::Orientation::setDirectionComp (  const Direction &  dir1,
const Direction &  dir2,
const Direction &  dir3
) 
 

Sets the Direction components of the Orientation.

Exceptions:
This method throws srm::Exception

The documentation for this class was generated from the following file:
Spatial Reference Model C++ API Version 4.1 - 26 Jun 2006
Copyright © 2006 SEDRIS™ Docs by Doxygen 1.3.2