afl::PointT< V > Class Template Reference

#include <point.h>

List of all members.

Public Member Functions

 PointT ()
 PointT (const PointT< V > &p)
PointT< V > & operator= (const PointT< V > &p)
 PointT (V x)
 PointT (V x, V y)
 PointT (V x, V y, V z)
 PointT (V x, V y, V z, V t)
getX () const
getY () const
getZ () const
getT () const
void setX (const V &x)
void setY (const V &y)
void setZ (const V &z)
void setT (const V &t)
size_t getDimension () const
operator[] (size_t t) const
V & operator[] (size_t t)
bool operator== (const PointT< V > &other) const
bool operator!= (const PointT< V > &other) const


Detailed Description

template<typename V>
class afl::PointT< V >

class PointT describes a point in 1,2,3 or 4 D space


Constructor & Destructor Documentation

template<typename V>
afl::PointT< V >::PointT  )  [inline]
 

default constructor

template<typename V>
afl::PointT< V >::PointT const PointT< V > &  p  )  [inline]
 

copy constructor

Parameters:
p the point to copy

template<typename V>
afl::PointT< V >::PointT x  )  [inline]
 

constructs a new 1D point object

Parameters:
x the location of the point along the axis

template<typename V>
afl::PointT< V >::PointT x,
y
[inline]
 

constructs a new 2D point object

Parameters:
x the location of the point along the x axis
y the location of the point along the y axis

template<typename V>
afl::PointT< V >::PointT x,
y,
z
[inline]
 

constructs a new 3D point object

Parameters:
x the location of the point along the x axis
y the location of the point along the y axis
z the location of the point along the z axis

template<typename V>
afl::PointT< V >::PointT x,
y,
z,
t
[inline]
 

constructs a new 4D point object

Parameters:
x the location of the point along the x axis
y the location of the point along the y axis
z the location of the point along the z axis
t the location of the point along the t axis


Member Function Documentation

template<typename V>
size_t afl::PointT< V >::getDimension  )  const [inline]
 

Returns:
the dimension of the node (1,2,3 or 4)

template<typename V>
V afl::PointT< V >::getT  )  const [inline]
 

Returns:
the location of the Point along the T axis

template<typename V>
V afl::PointT< V >::getX  )  const [inline]
 

Returns:
the location of the Point along the X axis

template<typename V>
V afl::PointT< V >::getY  )  const [inline]
 

Returns:
the location of the Point along the Y axis

template<typename V>
V afl::PointT< V >::getZ  )  const [inline]
 

Returns:
the location of the Point along the Z axis

template<typename V>
bool afl::PointT< V >::operator!= const PointT< V > &  other  )  const [inline]
 

Parameters:
other the point to compare this point with
Returns:
true iff operator == would have returned false

template<typename V>
PointT<V>& afl::PointT< V >::operator= const PointT< V > &  p  )  [inline]
 

assignment operator

Parameters:
p the point to copy
Returns:
a reference to this PointT

template<typename V>
bool afl::PointT< V >::operator== const PointT< V > &  other  )  const [inline]
 

Parameters:
other the point to compare this point with
Returns:
true iff the points are at the same place in the same space

template<typename V>
V& afl::PointT< V >::operator[] size_t  t  )  [inline]
 

Parameters:
t the axis to get the value of the point along, 0 is X, 1 is Y, 2 is Z and 3 is T
Returns:
a mutable reference to one of the values of the point

template<typename V>
V afl::PointT< V >::operator[] size_t  t  )  const [inline]
 

Parameters:
t the axis to get the value of the point along, 0 is X, 1 is Y, 2 is Z and 3 is T
Returns:
one of the values of the point

template<typename V>
void afl::PointT< V >::setT const V &  t  )  [inline]
 

modifies the location of the Point along the t axis

Parameters:
t the new location along the t axis

template<typename V>
void afl::PointT< V >::setX const V &  x  )  [inline]
 

modifies the location of the Point along the x axis

Parameters:
x the new location along the x axis

template<typename V>
void afl::PointT< V >::setY const V &  y  )  [inline]
 

modifies the location of the Point along the y axis

Parameters:
y the new location along the y axis

template<typename V>
void afl::PointT< V >::setZ const V &  z  )  [inline]
 

modifies the location of the Point along the z axis

Parameters:
z the new location along the z axis


The documentation for this class was generated from the following file:
Generated on Fri Dec 22 07:17:51 2006 for afl by  doxygen 1.4.6