#include <iso_space_neighbor_relation.h>
Collaboration diagram for iso::space::SpaceNeighborRelation:
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 | |
SpaceObject * | neighbor () |
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 | |
SpaceObject * | mObject |
space object | |
SpaceObject * | mNeighborObject |
neighboring space object | |
math::Vector< real > | mValue |
value of neighbor relation | |
math::Vector< real > | mDirection |
direction of neighbor relation | |
real | mDistance |
distance of neighbor relation | |
Friends | |
std::ostream & | operator<< (std::ostream &pOstream, const SpaceNeighborRelation &pNeighbor) |
retrieve textual neighbor info |
SpaceNeighborRelation::SpaceNeighborRelation | ( | unsigned int | pDim | ) |
create space neighbor relation
pDim | dimension of space neighbor (> 0) |
SpaceNeighborRelation::SpaceNeighborRelation | ( | SpaceObject * | pObject, | |
SpaceObject * | pNeighborObject | |||
) |
create space neighbor relation (automated distance and direction calculation)
pObject | space object | |
pNeighborObject | neighboring space object |
SpaceNeighborRelation::SpaceNeighborRelation | ( | SpaceObject * | pObject, | |
SpaceObject * | pNeighborObject, | |||
real | pDistance, | |||
const math::Vector< real > & | pDirection | |||
) |
create space neighbor relation (manually set distance and direction)
pObject | space object | |
pNeighborObject | neighboring space object | |
pDistance | distance | |
pDirection | direction |
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)
pObject | space object | |
pNeighborObject | neighboring space object | |
pValue | value | |
pDirection | direction | |
pDistance | distance |
SpaceNeighborRelation::~SpaceNeighborRelation | ( | ) |
destructor
SpaceNeighborRelation::SpaceNeighborRelation | ( | ) | [protected] |
default constructor
SpaceObject * SpaceNeighborRelation::neighbor | ( | ) |
return neighbor
const math::Vector< space::real > & SpaceNeighborRelation::value | ( | ) | const |
return value of neighbor relation
const math::Vector< space::real > & SpaceNeighborRelation::direction | ( | ) | const |
return direction vector pointing to neighbor
space::real SpaceNeighborRelation::distance | ( | ) | const |
return distance to neighbor
void SpaceNeighborRelation::setNeighbor | ( | SpaceObject * | pNeighborObject | ) |
manually set neighbor space object
pNeighborObject | neighbor space object |
void SpaceNeighborRelation::setValue | ( | const math::Vector< real > | pValue | ) |
manually set value
pValue | value |
void SpaceNeighborRelation::setDirection | ( | const math::Vector< real > | pDirection | ) |
manually set direction
pDirection | direction |
void SpaceNeighborRelation::setDistance | ( | real | pDistance | ) |
manually set distance
pDistance | distance |
void SpaceNeighborRelation::set | ( | SpaceObject * | pObject, | |
SpaceObject * | pNeighborObject | |||
) |
set new space object and neighbor object
pObject | space object | |
pNeighborObject | neighboring space object |
base::String SpaceNeighborRelation::info | ( | int | pPropagationLevel = 0 |
) | const [virtual] |
print neighbor information
pPropagationLevel | how far the propagation method proceeds through composite classes (-1: unlimited, 0: no proceeding, >0: limited proceeding) |
std::ostream& operator<< | ( | std::ostream & | pOstream, | |
const SpaceNeighborRelation & | pNeighbor | |||
) | [friend] |
retrieve textual neighbor info
pOstream | output text stream | |
pNeighbor | neighbor |
const base::String SpaceNeighborRelation::sClassName [static] |
class name
SpaceObject* iso::space::SpaceNeighborRelation::mObject [protected] |
space object
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