iso::space::SpaceProxyObject Class Reference

#include <iso_space_proxy_object.h>

Collaboration diagram for iso::space::SpaceProxyObject:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SpaceProxyObject (SpaceObject *pSpaceObject, NeighborGroup *pNeighborGroup)
 ~SpaceProxyObject ()
SpaceObjectspaceObject ()
const SpaceObjectspaceObject () const
NeighborGroupneighborGroup ()
const NeighborGroupneighborGroup () const
unsigned int dim () const
 return space object dimension
math::Vector< real > & position ()
 return space object position
bool visible () const
 check whether the space object is visible or not
bool canHaveNeighbors () const
 check whether this object can have neighbors
bool neighborListFull () const
 returns true if no more neighbors can be added to neighbor list
real neighborRadius () const
 return neighbor radius
int maxNeighborCount () const
 return maxmimum number of neighbors
void removeNeighbors ()
 remove neighbors
bool addNeighbor (SpaceObject *pNeighborObject)
 add neighbor object to neighbor list
bool addNeighbor (SpaceObject *pNeighborObject, real pDistance, const math::Vector< real > &pDirection)
 add neighbor object to neighbor list
bool addNeighbor (SpaceObject *pNeighborObject, const math::Vector< real > &pValue, const math::Vector< real > &pDirection, real pDistance)
 add neighbor object to neighbor list
virtual base::String info (int pPropagationLevel=0) const
 obtain textual space proxy object information

Protected Member Functions

 SpaceProxyObject ()

Protected Attributes

SpaceObjectmSpaceObject
NeighborGroupmNeighborGroup

Friends

std::ostream & operator<< (std::ostream &pOstream, const SpaceProxyObject &pSpaceProxyObject)
 retrieve textual space proxy object info

Constructor & Destructor Documentation

SpaceProxyObject::SpaceProxyObject ( SpaceObject pSpaceObject,
NeighborGroup pNeighborGroup 
)

SpaceProxyObject::~SpaceProxyObject (  ) 

SpaceProxyObject::SpaceProxyObject (  )  [protected]


Member Function Documentation

SpaceObject * iso::space::SpaceProxyObject::spaceObject (  )  [inline]

const SpaceObject * iso::space::SpaceProxyObject::spaceObject (  )  const [inline]

NeighborGroup * iso::space::SpaceProxyObject::neighborGroup (  )  [inline]

const NeighborGroup * iso::space::SpaceProxyObject::neighborGroup (  )  const [inline]

unsigned int iso::space::SpaceProxyObject::dim (  )  const [inline]

return space object dimension

Returns:
space object dimension

math::Vector< space::real > & iso::space::SpaceProxyObject::position (  )  [inline]

return space object position

Returns:
space object position

bool iso::space::SpaceProxyObject::visible (  )  const [inline]

check whether the space object is visible or not

Returns:
true: object is visible, false: otherwise
a visible object can be a neighbor for another object in the same space, an invisible can't

bool iso::space::SpaceProxyObject::canHaveNeighbors (  )  const [inline]

check whether this object can have neighbors

Returns:
true: object can have neighbors, false: object can't have neighbors

bool iso::space::SpaceProxyObject::neighborListFull (  )  const [inline]

returns true if no more neighbors can be added to neighbor list

space::real iso::space::SpaceProxyObject::neighborRadius (  )  const [inline]

return neighbor radius

Returns:
neighbor radius
Remarks:
fails if object can't have neighbors

int iso::space::SpaceProxyObject::maxNeighborCount (  )  const [inline]

return maxmimum number of neighbors

Returns:
return maxmimum number of neighbors
Remarks:
fails if object can't have neighbors

void iso::space::SpaceProxyObject::removeNeighbors (  )  [inline]

remove neighbors

bool iso::space::SpaceProxyObject::addNeighbor ( SpaceObject pNeighborObject  )  [inline]

add neighbor object to neighbor list

Parameters:
pNeighborObject neighbor space object
Returns:
true, if neighbor object could be added, false otherwise
creates new neighbor relation

bool iso::space::SpaceProxyObject::addNeighbor ( SpaceObject pNeighborObject,
real  pDistance,
const math::Vector< real > &  pDirection 
) [inline]

add neighbor object to neighbor list

Parameters:
pNeighborObject neighbor space object
pDistance distance
pDirection direction
Returns:
true, if neighbor object could be added, false otherwise
creates new neighbor relation

bool iso::space::SpaceProxyObject::addNeighbor ( SpaceObject pNeighborObject,
const math::Vector< real > &  pValue,
const math::Vector< real > &  pDirection,
real  pDistance 
) [inline]

add neighbor object to neighbor list

Parameters:
pNeighborObject neighbor space object
pValue value
pDirection direction
pDistance distance
Returns:
true, if neighbor object could be added, false otherwise
creates new neighbor relation

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

obtain textual space proxy object 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 SpaceProxyObject pSpaceProxyObject 
) [friend]

retrieve textual space proxy object info

Parameters:
pOstream output text stream
pSpaceProxyObject space proxy object


Member Data Documentation

SpaceObject* iso::space::SpaceProxyObject::mSpaceObject [protected]

NeighborGroup* iso::space::SpaceProxyObject::mNeighborGroup [protected]


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