iso::space::GridAlg Class Reference

#include <iso_space_alg_grid.h>

Inherits iso::space::SpaceAlg.

Inheritance diagram for iso::space::GridAlg:

Inheritance graph
[legend]
Collaboration diagram for iso::space::GridAlg:

Collaboration graph
[legend]
List of all members.

Public Types

enum  GridUpdateMode {
  NoUpdateMode, NearestReplaceMode, NearestAddMode, AvgReplaceMode,
  AvgAddMode
}
enum  GridNeighborMode { CellLocationMode, GridLocationMode, AvgLocationMode, AvgRegionMode }

Public Member Functions

 GridAlg (unsigned int pValueDim, const math::Vector< unsigned int > &pSubdivisionCount, const math::Vector< real > &pMinPos, const math::Vector< real > &pMaxPos, GridNeighborMode pNeighborMode, GridUpdateMode pUpdateMode=NoUpdateMode)
 create grid alg
 GridAlg (SpaceGrid &pSpaceGrid, GridNeighborMode pNeighborMode, GridUpdateMode pUpdateMode=NoUpdateMode)
 create grid alg
 ~GridAlg ()
 destructor
bool gridOwner () const
GridNeighborMode neighborMode () const
GridUpdateMode updateMode () const
SpaceGridgrid ()
 return space grid
void setGrid (SpaceGrid &pSpaceGrid)
 set space grid
void updateStructure (QVector< SpaceProxyObject * > &pObjects) throw (SpaceException)
void updateNeighbors (QVector< SpaceProxyObject * > &pObjects) throw (SpaceException)
base::String info () const
 obtain textual ntree information

Protected Member Functions

 GridAlg ()

Protected Attributes

SpaceGridmGrid
bool mGridOwner
 grid
GridNeighborMode mNeighborMode
 flag indicating whether we're owner of the grid or not
GridUpdateMode mUpdateMode
 mode of grid space neighbor calculation
QVector< SpaceObject * > mTmpSpaceObjects
 mode of grid updating

Friends

std::ostream & operator<< (std::ostream &pOstream, const GridAlg &pAlg)
 retrieve textual ntree information

Member Enumeration Documentation

enum iso::space::GridAlg::GridUpdateMode

Enumerator:
NoUpdateMode 
NearestReplaceMode 
NearestAddMode 
AvgReplaceMode 
AvgAddMode 

enum iso::space::GridAlg::GridNeighborMode

Enumerator:
CellLocationMode 
GridLocationMode 
AvgLocationMode 
AvgRegionMode 


Constructor & Destructor Documentation

GridAlg::GridAlg ( unsigned int  pValueDim,
const math::Vector< unsigned int > &  pSubdivisionCount,
const math::Vector< real > &  pMinPos,
const math::Vector< real > &  pMaxPos,
GridNeighborMode  pNeighborMode,
GridUpdateMode  pUpdateMode = NoUpdateMode 
)

create grid alg

Parameters:
pValueDim dimension of values stored in grid
pSubdivisionCount number of grid subdivisions
pMinPos minimum position in grid space
pMaxPos maximum position in grid space
pNeighborMode neighbor calculation mode
pUpdateMode grid update mode

GridAlg::GridAlg ( SpaceGrid pSpaceGrid,
GridNeighborMode  pNeighborMode,
GridUpdateMode  pUpdateMode = NoUpdateMode 
)

create grid alg

Parameters:
pName space name
pSpaceGrid space grid
pNeighborMode neighbor calculation mode
pUpdateMode grid update mode

GridAlg::~GridAlg (  ) 

destructor

GridAlg::GridAlg (  )  [protected]


Member Function Documentation

bool GridAlg::gridOwner (  )  const

GridAlg::GridNeighborMode GridAlg::neighborMode (  )  const

GridAlg::GridUpdateMode GridAlg::updateMode (  )  const

SpaceGrid & GridAlg::grid (  ) 

return space grid

Returns:
space grid \

void GridAlg::setGrid ( SpaceGrid pSpaceGrid  ) 

set space grid

Parameters:
pSpaceGrid space grid \

void GridAlg::updateStructure ( QVector< SpaceProxyObject * > &  pObjects  )  throw (SpaceException) [virtual]

Reimplemented from iso::space::SpaceAlg.

void GridAlg::updateNeighbors ( QVector< SpaceProxyObject * > &  pObjects  )  throw (SpaceException) [virtual]

Reimplemented from iso::space::SpaceAlg.

base::String GridAlg::info (  )  const

obtain textual ntree information

Returns:
String containing textual ntree information

Reimplemented from iso::space::SpaceAlg.


Friends And Related Function Documentation

std::ostream& operator<< ( std::ostream &  pOstream,
const GridAlg pAlg 
) [friend]

retrieve textual ntree information

Parameters:
pOstream output stream
pTree ntree


Member Data Documentation

SpaceGrid* iso::space::GridAlg::mGrid [protected]

bool iso::space::GridAlg::mGridOwner [protected]

grid

GridNeighborMode iso::space::GridAlg::mNeighborMode [protected]

flag indicating whether we're owner of the grid or not

GridUpdateMode iso::space::GridAlg::mUpdateMode [protected]

mode of grid space neighbor calculation

QVector<SpaceObject*> iso::space::GridAlg::mTmpSpaceObjects [protected]

mode of grid updating


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