LRAUV  revA
Public Member Functions | Protected Attributes | List of all members
Point3D Class Reference
Data and Slate

Wraps three double precision (8-byte) floating point numbers. More...

#include <Point3D.h>

Inheritance diagram for Point3D:
Inheritance graph
[legend]
Collaboration diagram for Point3D:
Collaboration graph
[legend]

Public Member Functions

void setX (const double x)
 X positive along the vehicle axis, starting at the nose. More...
 
double getX () const
 
void setY (const double y)
 Y. More...
 
double getY () const
 
void setZ (const double z)
 Z. More...
 
double getZ () const
 
void setU (const double u)
 U – shares storage with X, alias for dX/dt. More...
 
double getU () const
 
void setV (const double v)
 V – shares storage with Y, alias for dY/dt. More...
 
double getV () const
 
void setW (const double w)
 W – shares storage with Z, alias for dZ/dt. More...
 
double getW () const
 
 Point3D ()
 Default constructior. More...
 
 Point3D (const double &init)
 Single value constructior. More...
 
 Point3D (const double &x, const double &y, const double &z)
 Multi value constructior. More...
 
 Point3D (const Point3D &value)
 Copy Constructor. More...
 
virtual ~Point3D ()
 Destructor. More...
 
Point3D * copy () const
 Return a pointer to a new copy. More...
 
virtual Str toString () const
 
Point3D & operator= (const Point3D &rhs)
 
Point3D & operator= (const double rhs)
 
Point3D & operator+= (const Point3D &rhs)
 
Point3D & operator+= (const double rhs)
 
Point3D operator+ (const Point3D &rhs)
 
Point3D & operator-= (const Point3D &rhs)
 
Point3D operator- (const Point3D &rhs)
 
Point3D & operator-= (const double rhs)
 
Point3D & operator*= (const Point3D &rhs)
 
Point3D operator* (const double rhs)
 
Point3D & operator*= (const double rhs)
 
Point3D & addProduct (Matrix3x3 &lhs, Point3D &rhs)
 
Point3D & toAbs ()
 
double getMagnitude () const
 
double & operator[] (int index)
 
const double sum () const
 
const double sumSquared () const
 
virtual double * getPtr1d ()
 Implement abstract I1D method. More...
 
virtual int getM () const
 Implement abstract I2D method. More...
 
- Public Member Functions inherited from I1D< double >
virtual ~I1D ()
 

Protected Attributes

double value_ [3]
 

Additional Inherited Members

- Static Public Member Functions inherited from I1D< double >
static double * New1D (int m, bool extra=false)
 
static void Delete1D (double *array)
 
- Protected Member Functions inherited from I1D< double >
 I1D ()
 
 I1D (const I1D &)
 

Detailed Description

Wraps three double precision (8-byte) floating point numbers.

The 3 numbers are normally accessed as

  • x, y, and z
    -OR-
  • u, v, and w

Constructor & Destructor Documentation

Point3D::Point3D ( )

Default constructior.

References setX(), setY(), and setZ().

Referenced by copy().

Point3D::Point3D ( const double &  init)

Single value constructior.

References setX(), setY(), and setZ().

Point3D::Point3D ( const double &  x,
const double &  y,
const double &  z 
)

Multi value constructior.

References setX(), setY(), and setZ().

Point3D::Point3D ( const Point3D &  value)

Copy Constructor.

References getX(), getY(), getZ(), setX(), setY(), and setZ().

virtual Point3D::~Point3D ( )
inlinevirtual

Destructor.

Member Function Documentation

Point3D & Point3D::addProduct ( Matrix3x3 &  lhs,
Point3D &  rhs 
)

References Matrix3x3::getPtr1d(), getPtr1d(), getX(), getY(), getZ(), setX(), setY(), and setZ().

Referenced by DeadReckonUsingCompactModelForecast::deadReckon(), DeadReckoner::deadReckon(), DAT::getSimulatedMeasurements(), DAT::phasesToDirectionInVehicleFrame(), Rowe_600::processEnsemble(), Tracking::processFromDAT(), ExternalSim::publishState(), Rowe_600::readBottomTrackMatrix(), and Rowe_600::rotateDataIntoVehicleFrame().

Point3D * Point3D::copy ( ) const

Return a pointer to a new copy.

References Point3D().

virtual int Point3D::getM ( ) const
inlinevirtual

Implement abstract I2D method.

Implements I1D< double >.

double Point3D::getMagnitude ( ) const

References value_.

Referenced by AHRS_sp3003D::AHRS_sp3003D(), DeadReckonUsingCompactModelForecast::deadReckon(), DVL_micro::DVL_micro(), DAT::phaseToUnitVector(), PNI_TCM::PNI_TCM(), Rowe_600::preprocessData(), DeadReckonUsingDVLWaterTrack::readVehicleVelocity(), DeadReckonWithRespectToSeafloor::readVehicleVelocity(), DeadReckonUsingMultipleVelocitySources::readVehicleVelocity(), and Rowe_600::reportBottomTrackComponents().

virtual double* Point3D::getPtr1d ( void  )
inlinevirtual

Implement abstract I1D method.

Implements I1D< double >.

References value_.

Referenced by addProduct(), and Matrix3x3::mult().

double Point3D::getU ( ) const
inline

References value_.

Referenced by Simulator::calcFinForces(), Rowe_600::processEnsemble(), Simulator::publishState(), Rowe_600::readBottomTrackMatrix(), Rowe_600::reportBottomTrackComponents(), and Universal_Test::test1DUniversalBlobReadWrite().

double Point3D::getV ( ) const
inline

References value_.

Referenced by Simulator::calcFinForces(), Rowe_600::processEnsemble(), Simulator::publishState(), Rowe_600::readBottomTrackMatrix(), Rowe_600::reportBottomTrackComponents(), and Universal_Test::test1DUniversalBlobReadWrite().

double Point3D::getW ( ) const
inline

References value_.

Referenced by Simulator::calcFinForces(), Rowe_600::processEnsemble(), Simulator::publishState(), Rowe_600::readBottomTrackMatrix(), Rowe_600::reportBottomTrackComponents(), and Universal_Test::test1DUniversalBlobReadWrite().

double Point3D::getX ( ) const
inline

References value_.

Referenced by addProduct(), Point6D::addProduct(), Simulator::calcForce(), DeadReckonUsingCompactModelForecast::deadReckon(), DeadReckoner::deadReckon(), Simulator::invertMass(), operator*(), operator*=(), operator+(), operator+=(), Point6D::operator+=(), operator-(), operator-=(), operator=(), DAT::phasesToDirectionInVehicleFrame(), Point3D(), Tracking::processFromDAT(), ExternalSim::publishState(), Tracking::readFromDAT(), sum(), sumSquared(), toAbs(), and Tracking::writeData().

double Point3D::getY ( ) const
inline

References value_.

Referenced by addProduct(), Point6D::addProduct(), Simulator::calcForce(), DeadReckonUsingCompactModelForecast::deadReckon(), DeadReckoner::deadReckon(), Simulator::invertMass(), operator*(), operator*=(), operator+(), operator+=(), Point6D::operator+=(), operator-(), operator-=(), operator=(), DAT::phasesToDirectionInVehicleFrame(), Point3D(), Tracking::processFromDAT(), ExternalSim::publishState(), Tracking::readFromDAT(), sum(), sumSquared(), toAbs(), and Tracking::writeData().

double Point3D::getZ ( ) const
inline

References value_.

Referenced by addProduct(), Point6D::addProduct(), Simulator::calcForce(), DeadReckonUsingCompactModelForecast::deadReckon(), DeadReckoner::deadReckon(), Simulator::invertMass(), operator*(), operator*=(), operator+(), operator+=(), Point6D::operator+=(), operator-(), operator-=(), operator=(), DAT::phasesToDirectionInVehicleFrame(), Point3D(), Tracking::processFromDAT(), ExternalSim::publishState(), Tracking::readFromDAT(), sum(), sumSquared(), and toAbs().

Point3D Point3D::operator* ( const double  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator*= ( const Point3D &  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator*= ( const double  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D Point3D::operator+ ( const Point3D &  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator+= ( const Point3D &  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator+= ( const double  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D Point3D::operator- ( const Point3D &  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator-= ( const Point3D &  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator-= ( const double  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator= ( const Point3D &  rhs)

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Point3D & Point3D::operator= ( const double  rhs)

References setX(), setY(), and setZ().

double & Point3D::operator[] ( int  index)

References value_.

void Point3D::setU ( const double  u)
inline

U – shares storage with X, alias for dX/dt.

References value_.

Referenced by Simulator::calcFinForces(), DVL_micro::processNQ1(), Simulator::publishState(), DeadReckonUsingSpeedCalculator::readVehicleVelocity(), DeadReckonWithRespectToWater::readVehicleVelocity(), DeadReckonUsingCompactModelForecast::readVehicleVelocity(), DeadReckonUsingMultipleVelocitySources::readVehicleVelocity(), Rowe_600LCM::runnable(), and EnvSimulator::simulateSensors().

void Point3D::setV ( const double  v)
inline

V – shares storage with Y, alias for dY/dt.

References value_.

Referenced by Simulator::calcFinForces(), DVL_micro::processNQ1(), Simulator::publishState(), DeadReckonUsingSpeedCalculator::readVehicleVelocity(), DeadReckonWithRespectToWater::readVehicleVelocity(), DeadReckonUsingCompactModelForecast::readVehicleVelocity(), DeadReckonUsingMultipleVelocitySources::readVehicleVelocity(), Rowe_600LCM::runnable(), and EnvSimulator::simulateSensors().

void Point3D::setW ( const double  w)
inline

W – shares storage with Z, alias for dZ/dt.

References value_.

Referenced by Simulator::calcFinForces(), DVL_micro::processNQ1(), DeadReckonUsingSpeedCalculator::readVehicleVelocity(), DeadReckonWithRespectToWater::readVehicleVelocity(), DeadReckonUsingCompactModelForecast::readVehicleVelocity(), DeadReckonUsingMultipleVelocitySources::readVehicleVelocity(), Rowe_600LCM::runnable(), and EnvSimulator::simulateSensors().

void Point3D::setX ( const double  x)
inline

X positive along the vehicle axis, starting at the nose.

References value_.

Referenced by addProduct(), AuvMath::AzimuthAndElevationToUnitVector(), Simulator::calcFinForces(), Simulator::calcForce(), Simulator::loadParams(), Matrix3x3::mult(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator=(), Point3D(), and toAbs().

void Point3D::setY ( const double  y)
inline

Y.

References value_.

Referenced by addProduct(), AuvMath::AzimuthAndElevationToUnitVector(), Simulator::calcFinForces(), Simulator::calcForce(), Simulator::loadParams(), Matrix3x3::mult(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator=(), Point3D(), and toAbs().

void Point3D::setZ ( const double  z)
inline

Z.

References value_.

Referenced by addProduct(), AuvMath::AzimuthAndElevationToUnitVector(), Simulator::calcFinForces(), Simulator::calcForce(), Simulator::loadParams(), Matrix3x3::mult(), operator*(), operator*=(), operator+(), operator+=(), operator-(), operator-=(), operator=(), Point3D(), and toAbs().

const double Point3D::sum ( ) const

References getX(), getY(), and getZ().

const double Point3D::sumSquared ( ) const

References getX(), getY(), and getZ().

Point3D & Point3D::toAbs ( )

References getX(), getY(), getZ(), setX(), setY(), and setZ().

Str Point3D::toString ( ) const
virtual

References value_.

Member Data Documentation

double Point3D::value_[3]
protected

Referenced by getMagnitude(), getPtr1d(), getU(), getV(), getW(), getX(), getY(), getZ(), operator[](), setU(), setV(), setW(), setX(), setY(), setZ(), and toString().

The documentation for this class was generated from the following files: