iso::space::SpaceNeighborRelation Class Reference

#include <iso_space_neighbor_relation.h>

Collaboration diagram for iso::space::SpaceNeighborRelation:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SpaceNeighborRelation (unsigned int pDim)
 create space neighbor relation
 SpaceNeighborRelation (SpaceObject *pObject, SpaceObject *pNeighborObject)
 create space neighbor relation (automated distance and direction calculation)
 SpaceNeighborRelation (SpaceObject *pObject, SpaceObject *pNeighborObject, real pDistance, const math::Vector< real > &pDirection)
 create space neighbor relation (manually set distance and direction)
 SpaceNeighborRelation (SpaceObject *pObject, SpaceObject *pNeighborObject, const math::Vector< real > &pValue, const math::Vector< real > &pDirection, real pDistance)
 create space neighbor relation (manually set distance and direction)
 ~SpaceNeighborRelation ()
 destructor
SpaceObjectneighbor ()
 return neighbor
const math::Vector< real > & value () const
 return value of neighbor relation
const math::Vector< real > & direction () const
 return direction vector pointing to neighbor
real distance () const
 return distance to neighbor
void setNeighbor (SpaceObject *pNeighborObject)
 manually set neighbor space object
void setValue (const math::Vector< real > pValue)
 manually set value
void setDirection (const math::Vector< real > pDirection)
 manually set direction
void setDistance (real pDistance)
 manually set distance
void set (SpaceObject *pObject, SpaceObject *pNeighborObject)
 set new space object and neighbor object
virtual base::String info (int pPropagationLevel=0) const
 print neighbor information

Static Public Attributes

static const base::String sClassName
 class name

Protected Member Functions

 SpaceNeighborRelation ()
 default constructor

Protected Attributes

SpaceObjectmObject
 space object
SpaceObjectmNeighborObject
 neighboring space object
math::Vector< realmValue
 value of neighbor relation
math::Vector< realmDirection
 direction of neighbor relation
real mDistance
 distance of neighbor relation

Friends

std::ostream & operator<< (std::ostream &pOstream, const SpaceNeighborRelation &pNeighbor)
 retrieve textual neighbor info

Constructor & Destructor Documentation

SpaceNeighborRelation::SpaceNeighborRelation ( unsigned int  pDim  ) 

create space neighbor relation

Parameters:
pDim dimension of space neighbor (> 0)

SpaceNeighborRelation::SpaceNeighborRelation ( SpaceObject pObject,
SpaceObject pNeighborObject 
)

create space neighbor relation (automated distance and direction calculation)

Parameters:
pObject space object
pNeighborObject neighboring space object
Remarks:
fails if either the two objects are identical are if they differ in their respective dimensions

SpaceNeighborRelation::SpaceNeighborRelation ( SpaceObject pObject,
SpaceObject pNeighborObject,
real  pDistance,
const math::Vector< real > &  pDirection 
)

create space neighbor relation (manually set distance and direction)

Parameters:
pObject space object
pNeighborObject neighboring space object
pDistance distance
pDirection direction
Remarks:
fails if either the two objects are identical are if they differ in their respective dimensions

SpaceNeighborRelation::SpaceNeighborRelation ( SpaceObject pObject,
SpaceObject pNeighborObject,
const math::Vector< real > &  pValue,
const math::Vector< real > &  pDirection,
real  pDistance 
)

create space neighbor relation (manually set distance and direction)

Parameters:
pObject space object
pNeighborObject neighboring space object
pValue value
pDirection direction
pDistance distance
Remarks:
fails if either the two objects are identical are if they differ in their respective dimensions

SpaceNeighborRelation::~SpaceNeighborRelation (  ) 

destructor

SpaceNeighborRelation::SpaceNeighborRelation (  )  [protected]

default constructor


Member Function Documentation

SpaceObject * SpaceNeighborRelation::neighbor (  ) 

return neighbor

const math::Vector< space::real > & SpaceNeighborRelation::value (  )  const

return value of neighbor relation

Returns:
value of neighbor relation

const math::Vector< space::real > & SpaceNeighborRelation::direction (  )  const

return direction vector pointing to neighbor

Returns:
direction vector pointing to neighbor

space::real SpaceNeighborRelation::distance (  )  const

return distance to neighbor

Returns:
distance to neighbor

void SpaceNeighborRelation::setNeighbor ( SpaceObject pNeighborObject  ) 

manually set neighbor space object

Parameters:
pNeighborObject neighbor space object
Remarks:
fails if space object dimension is wrong

void SpaceNeighborRelation::setValue ( const math::Vector< real pValue  ) 

manually set value

Parameters:
pValue value
Remarks:
fails if value dimension is wrong

void SpaceNeighborRelation::setDirection ( const math::Vector< real pDirection  ) 

manually set direction

Parameters:
pDirection direction
Remarks:
fails if direction dimension is wrong

void SpaceNeighborRelation::setDistance ( real  pDistance  ) 

manually set distance

Parameters:
pDistance distance

void SpaceNeighborRelation::set ( SpaceObject pObject,
SpaceObject pNeighborObject 
)

set new space object and neighbor object

Parameters:
pObject space object
pNeighborObject neighboring space object
Remarks:
fails if either the two objects are identical are if they differ in their respective dimensions

base::String SpaceNeighborRelation::info ( int  pPropagationLevel = 0  )  const [virtual]

print neighbor information

Parameters:
pPropagationLevel how far the propagation method proceeds through composite classes (-1: unlimited, 0: no proceeding, >0: limited proceeding)


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  pOstream,
const SpaceNeighborRelation pNeighbor 
) [friend]

retrieve textual neighbor info

Parameters:
pOstream output text stream
pNeighbor neighbor


Member Data Documentation

const base::String SpaceNeighborRelation::sClassName [static]

class name

SpaceObject* iso::space::SpaceNeighborRelation::mObject [protected]

space object

SpaceObject* iso::space::SpaceNeighborRelation::mNeighborObject [protected]

neighboring space object

math::Vector<real> iso::space::SpaceNeighborRelation::mValue [protected]

value of neighbor relation

usually the same value as mDirection

math::Vector<real> iso::space::SpaceNeighborRelation::mDirection [protected]

direction of neighbor relation

usually vector pointing from position of mObject to position of mNeighborObject

real iso::space::SpaceNeighborRelation::mDistance [protected]

distance of neighbor relation

usually length of mDirection


The documentation for this class was generated from the following files:
Generated on Fri Feb 25 14:08:15 2011 for iso_space by  doxygen 1.5.1