TupleSixD Class Reference

The purpose of this class is to provide operations on three domain objects. More...

#include <TupleSixD.h>

Collaboration diagram for TupleSixD:

[legend]List of all members.

Public Member Functions
	TupleSixD ()
	Ctor.
	TupleSixD (const TupleThreeD &p0, const TupleThreeD &p1)
	Ctor.
	TupleSixD (const TupleSixD &rhs)
	Copy ctor.
virtual	~TupleSixD ()
	Dtor.
TupleSixD &	operator= (const TupleSixD &rhs)
	Assignment operator.
bool	operator== (const TupleSixD &rhs) const
	Equality operator.
bool	operator!= (const TupleSixD &rhs) const
	Inequality operator.
const TupleSixD &	value (const TupleThreeD &p0, const TupleThreeD &p1)
	Specify a value directly.
const TupleSixD &	value () const
	Give the value of this object.
const TupleThreeD &	P0 () const
	Give the value of the p0 point.
const TupleThreeD &	P1 () const
	Give the value of the y domain.
double	operator * (const TupleSixD &rhs) const
	Dot product operator.
TupleSixD	operator+ (const TupleSixD &rhs) const
	Addition operator.
TupleSixD	operator- (const TupleSixD &rhs) const
	Subtraction operator.

---

Detailed Description

The purpose of this class is to provide operations on three domain objects.

Definition at line 12 of file TupleSixD.h.

---

Constructor & Destructor Documentation

TupleSixD::TupleSixD

(

)

Ctor.

TupleSixD::TupleSixD	(	const TupleThreeD &	p0,
		const TupleThreeD &	p1
	)

Ctor.

Parameters:

	p0	The initial p0 point value.
	p1	The initial p1 point value.

TupleSixD::TupleSixD

(

const TupleSixD &

rhs

)

Copy ctor.

Parameters:

rhs

The reference object.

virtual TupleSixD::~TupleSixD

(

)

[virtual]

Dtor.

---

Member Function Documentation

TupleSixD& TupleSixD::operator=

(

const TupleSixD &

rhs

)

Assignment operator.

Parameters:

rhs

The reference object.

Returns:

The value of this object.

bool TupleSixD::operator==

(

const TupleSixD &

rhs

)

const

Equality operator.

Parameters:

rhs

The reference object.

Returns:

If this object and the reference object are equal then true.

bool TupleSixD::operator!=

(

const TupleSixD &

rhs

)

const

Inequality operator.

Parameters:

rhs

The reference object.

Returns:

If this object and the reference object are equal then true.

const TupleSixD& TupleSixD::value	(	const TupleThreeD &	p0,
		const TupleThreeD &	p1
	)

Specify a value directly.

Parameters:

	p0	The p0 point.
	p1	The p1 point.

Returns:

The new value of this object.

const TupleSixD& TupleSixD::value

(

)

const

Give the value of this object.

Returns:

The new value of this object.

const TupleThreeD& TupleSixD::P0

(

)

const

Give the value of the p0 point.

Returns:

P0 point.

const TupleThreeD& TupleSixD::P1

(

)

const

Give the value of the y domain.

Returns:

P0 point.

double TupleSixD::operator *

(

const TupleSixD &

rhs

)

const

Dot product operator.

Parameters:

rhs

The argument to be multiplied with this object.

Returns:

The product scalar.

TupleSixD TupleSixD::operator+

(

const TupleSixD &

rhs

)

const

Addition operator.

Parameters:

rhs

The argument to be added with this object.

Returns:

The result vector.

TupleSixD TupleSixD::operator-

(

const TupleSixD &

rhs

)

const

Subtraction operator.

Parameters:

rhs

The argument to be subtracted from this object.

Returns:

The result vector.

---

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

• TupleSixD.h

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