PingPoint Class Reference
[Simulator/Common/C++]

The purpose of this class is to contain a ping point. More...

#include <PingPoint.h>

List of all members.

Public Member Functions
	PingPoint (int ping, double x, double y, double z, double heading, double pitch, double roll)
	Ctor.
	PingPoint (int ping)
	Ctor.
	PingPoint (const PingPoint &rhs)
	Copy ctor.
virtual	~PingPoint ()
	Dtor.
PingPoint &	operator= (const PingPoint &rhs)
	The copy operator.
bool	operator== (const PingPoint &rhs) const
	Equality operator.
bool	operator!= (const PingPoint &rhs) const
	Inequality operator.
bool	operator< (const PingPoint &rhs) const
	Less than operator.
bool	operator> (const PingPoint &rhs) const
	Greater than operator.
int	ping () const
	Give this object's ping index.
void	ping (int index)
	Change this object's ping index.
double	x () const
	Give this object's X coordinate.
void	x (double arg)
	Change this object's X coordinate.
double	y () const
	Give this object's Y coordinate.
void	y (double arg)
	Change this object's Y coordinate.
double	z () const
	Give this object's Z coordinate.
void	z (double arg)
	Change this object's Z coordinate.
void	heading (double arg)
	Change this object's heading value.
double	heading () const
	Give this object's heading value.
void	pitch (double arg)
	Change this object's pitch value.
double	pitch () const
	Give this object's pitch value.
void	roll (double arg)
	Change this object's roll value.
double	roll () const
	Give this object's roll value.
void	PrintSelf (ostream &os, vtkIndent indent)
	Print the internal state.

---

Detailed Description

The purpose of this class is to contain a ping point.

Definition at line 15 of file PingPoint.h.

---

Constructor & Destructor Documentation

PingPoint::PingPoint	(	int	ping,
		double	x,
		double	y,
		double	z,
		double	heading,
		double	pitch,
		double	roll
	)

Ctor.

Parameters:

	ping	The ping number.
	x	The X coordinate of the ping.
	y	The Y coordinate of the ping.
	z	The Z coordinate of the ping.
	heading	The heading for this ping.
	pitch	The pitch for this heading.
	roll	The roll for this heading.

PingPoint::PingPoint

(

int

ping

)

Ctor.

Parameters:

ping

The ping number.

PingPoint::PingPoint

(

const PingPoint &

rhs

)

Copy ctor.

Parameters:

rhs

The right hand side argument.

virtual PingPoint::~PingPoint

(

)

[virtual]

Dtor.

---

Member Function Documentation

PingPoint& PingPoint::operator=

(

const PingPoint &

rhs

)

The copy operator.

Parameters:

rhs

The right hand side argument.

Returns:

This object.

bool PingPoint::operator==

(

const PingPoint &

rhs

)

const

Equality operator.

Equality is defined as the ping() variable being equal. The variables x(), y() and z() are not considered.

Parameters:

rhs

The right hand side argument.

Returns:

If this object and the rhs are equal return true.

bool PingPoint::operator!=

(

const PingPoint &

rhs

)

const

Inequality operator.

Parameters:

rhs

The right hand side argument.

Returns:

If this object and the rhs are not equal return true.

bool PingPoint::operator<

(

const PingPoint &

rhs

)

const

Less than operator.

Parameters:

rhs

The right hand side argument.

Returns:

If this object's z() function returns less than rhs::z() return true.

bool PingPoint::operator>

(

const PingPoint &

rhs

)

const

Greater than operator.

The ordering is (in order of preference) ping.

Parameters:

rhs

The right hand side argument.

Returns:

If this object is "greater" than rhs return true.

int PingPoint::ping

(

)

const

Give this object's ping index.

Returns:

The index.

void PingPoint::ping

(

int

index

)

Change this object's ping index.

Parameters:

index

The index.

double PingPoint::x

(

)

const

Give this object's X coordinate.

Returns:

The X value.

void PingPoint::x

(

double

arg

)

Change this object's X coordinate.

Parameters:

arg

The argument.

double PingPoint::y

(

)

const

Give this object's Y coordinate.

Returns:

The Y value.

void PingPoint::y

(

double

arg

)

Change this object's Y coordinate.

Parameters:

arg

The argument.

double PingPoint::z

(

)

const

Give this object's Z coordinate.

Returns:

The Z value.

void PingPoint::z

(

double

arg

)

Change this object's Z coordinate.

Parameters:

arg

The argument.

void PingPoint::heading

(

double

arg

)

Change this object's heading value.

Parameters:

arg

The argument.

double PingPoint::heading

(

)

const

Give this object's heading value.

Returns:

The argument.

void PingPoint::pitch

(

double

arg

)

Change this object's pitch value.

Parameters:

arg

The argument.

double PingPoint::pitch

(

)

const

Give this object's pitch value.

Returns:

The argument.

void PingPoint::roll

(

double

arg

)

Change this object's roll value.

Parameters:

arg

The argument.

double PingPoint::roll

(

)

const

Give this object's roll value.

Returns:

The argument.

void PingPoint::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

Print the internal state.

Parameters:

	os	The destination stream.
	indent	The indentation to use.

---

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

• PingPoint.h

Generated on Sat Nov 22 12:37:36 2008 for Swath Sonar by Doxygen 1.5.1