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

The purpose of this class is to contain a beam strike. More...

#include <BeamPoint.h>

List of all members.

Public Member Functions
	BeamPoint (int ping, int beam, double x, double y, double z)
	Ctor.
	BeamPoint (double x, double y, double z)
	Ctor.
	BeamPoint (const BeamPoint &rhs)
	Copy ctor.
virtual	~BeamPoint ()
	Dtor.
BeamPoint &	operator= (const BeamPoint &rhs)
	The copy operator.
bool	operator== (const BeamPoint &rhs) const
	Equality operator.
bool	operator!= (const BeamPoint &rhs) const
	Inequality operator.
bool	operator< (const BeamPoint &rhs) const
	Less than operator.
bool	operator> (const BeamPoint &rhs) const
	Greater than operator.
int	ping () const
	Give this object's ping index.
void	ping (int index)
	Change this object's ping index.
int	beam () const
	Give the beam number.
void	beam (int arg)
	Change this object's beam number.
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	PrintSelf (ostream &os, vtkIndent indent)
	Print the internal state.

---

Detailed Description

The purpose of this class is to contain a beam strike.

Definition at line 15 of file BeamPoint.h.

---

Constructor & Destructor Documentation

BeamPoint::BeamPoint	(	int	ping,
		int	beam,
		double	x,
		double	y,
		double	z
	)

Ctor.

Parameters:

	ping	The ping number from which this strike originates.
	beam	The beam number from which this strike originates.
	x	The X coordinate of the strike.
	y	The Y coordinate of the strike.
	z	The Z coordinate of the strike.

BeamPoint::BeamPoint	(	double	x,
		double	y,
		double	z
	)

Ctor.

Parameters:

	x	The X coordinate of the strike.
	y	The Y coordinate of the strike.
	z	The Z coordinate of the strike.

BeamPoint::BeamPoint

(

const BeamPoint &

rhs

)

Copy ctor.

Parameters:

rhs

The right hand side argument.

virtual BeamPoint::~BeamPoint

(

)

[virtual]

Dtor.

---

Member Function Documentation

BeamPoint& BeamPoint::operator=

(

const BeamPoint &

rhs

)

The copy operator.

Parameters:

rhs

The right hand side argument.

Returns:

This object.

bool BeamPoint::operator==

(

const BeamPoint &

rhs

)

const

Equality operator.

Equality is defined as both the ping() and beam() variables 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 BeamPoint::operator!=

(

const BeamPoint &

rhs

)

const

Inequality operator.

Parameters:

rhs

The right hand side argument.

Returns:

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

bool BeamPoint::operator<

(

const BeamPoint &

rhs

)

const

Less than operator.

The basis for comparison is the value of ping() and beam() with the former taking precedence.

Parameters:

rhs

The right hand side argument.

Returns:

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

bool BeamPoint::operator>

(

const BeamPoint &

rhs

)

const

Greater than operator.

The basis for comparison is the value of ping() and beam() with the former taking precedence.

Parameters:

rhs

The right hand side argument.

Returns:

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

int BeamPoint::ping

(

)

const

Give this object's ping index.

Returns:

The index.

void BeamPoint::ping

(

int

index

)

Change this object's ping index.

Parameters:

index

The index.

int BeamPoint::beam

(

)

const

Give the beam number.

Returns:

The beam number.

void BeamPoint::beam

(

int

arg

)

Change this object's beam number.

Parameters:

arg

The beam.

double BeamPoint::x

(

)

const

Give this object's X coordinate.

Returns:

The X value.

void BeamPoint::x

(

double

arg

)

Change this object's X coordinate.

Parameters:

arg

The argument.

double BeamPoint::y

(

)

const

Give this object's Y coordinate.

Returns:

The Y value.

void BeamPoint::y

(

double

arg

)

Change this object's Y coordinate.

Parameters:

arg

The argument.

double BeamPoint::z

(

)

const

Give this object's Z coordinate.

Returns:

The Z value.

void BeamPoint::z

(

double

arg

)

Change this object's Z coordinate.

Parameters:

arg

The argument.

void BeamPoint::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:

• BeamPoint.h

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