iso::space::SpaceManager Class Reference

space manager More...

#include <iso_space_manager.h>

Collaboration diagram for iso::space::SpaceManager:

Collaboration graph
[legend]
List of all members.

Public Member Functions

QList< base::String > spaceNames () const
 return space names
Spacespace (const base::String &pSpaceName) throw (SpaceException)
 return space
bool checkSpace (const base::String &pSpaceName)
 check if space exists
void addSpace (Space *pSpace) throw (SpaceException)
 add space to space manager
void removeSpace (const base::String &pSpaceName) throw (SpaceException)
 remove space
void removeSpaces ()
 remove all spaces
virtual void addObject (const base::String &pSpaceName, SpaceObject *pObject, bool pVisible, NeighborGroupAlg *pNeighborGroupAlg=NULL) throw (SpaceException)
 add space object to space
virtual void removeObject (const base::String &pSpaceName, SpaceObject *pObject) throw (SpaceException)
 remove single space object handle object
void update ()
 update all parameters
virtual base::String info (int pPropagationLevel=0) const
 print space manager information

Static Public Member Functions

static SpaceManagerget ()
 get singleton instance
static void destroy ()
 destroy singleton instance

Static Public Attributes

static const base::String sClassName

Protected Member Functions

 SpaceManager ()
 default constructor
 ~SpaceManager ()
 destructor

Protected Attributes

data::IndexHash< base::String,
Space
mSpaces
 spaces

Static Protected Attributes

static SpaceManagersSpaceManager
 singleton instance

Friends

std::ostream & operator<< (std::ostream &pOstream, const SpaceManager &pSpaceManager)
 retrieve textual space manager info

Detailed Description

space manager

handles all agent parameters that need neighborhood calculation

Created by Daniel Bisig on 3/29/07. Copyright 2006 Daniel Bisig All rights reserved.


Constructor & Destructor Documentation

SpaceManager::SpaceManager (  )  [protected]

default constructor

SpaceManager::~SpaceManager (  )  [protected]

destructor


Member Function Documentation

SpaceManager & SpaceManager::get (  )  [static]

get singleton instance

Returns:
space manager

void SpaceManager::destroy (  )  [static]

destroy singleton instance

QList< base::String > SpaceManager::spaceNames (  )  const

return space names

Returns:
space names

Space & SpaceManager::space ( const base::String &  pSpaceName  )  throw (SpaceException)

return space

Parameters:
pSpaceName space nme
Exceptions:
SpaceException space doesn't exist

bool SpaceManager::checkSpace ( const base::String &  pSpaceName  ) 

check if space exists

Parameters:
pSpaceName space name
Returns:
true if space exists, false otherwise

void SpaceManager::addSpace ( Space pSpace  )  throw (SpaceException)

add space to space manager

Parameters:
pSpace space
Exceptions:
SpaceException space already exists

void SpaceManager::removeSpace ( const base::String &  pSpaceName  )  throw (SpaceException)

remove space

Parameters:
pSpaceName name of space
Exceptions:
SpaceException space does not exist

void SpaceManager::removeSpaces (  ) 

remove all spaces

void SpaceManager::addObject ( const base::String &  pSpaceName,
SpaceObject pObject,
bool  pVisible,
NeighborGroupAlg pNeighborGroupAlg = NULL 
) throw (SpaceException) [virtual]

add space object to space

Parameters:
pSpaceName name of space to add space object to
pObject space object
pVisible visibility in neighbor space
pNeighborGroupAlg neighbor group algorithm
Exceptions:
SpaceException space not found or space dimension and space object dimension don't match or space is of wrong type

void SpaceManager::removeObject ( const base::String &  pSpaceName,
SpaceObject pObject 
) throw (SpaceException) [virtual]

remove single space object handle object

Parameters:
pSpaceName name of space to add space object to
pObject single space object handle to remove
Exceptions:
SpaceException space and or space object not found or space of wrong type

void SpaceManager::update (  ) 

update all parameters

update parameter spaces

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

print space manager 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 SpaceManager pSpaceManager 
) [friend]

retrieve textual space manager info

Parameters:
pOstream output text stream
pSpaceManager space manager


Member Data Documentation

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

SpaceManager * SpaceManager::sSpaceManager [static, protected]

singleton instance

data::IndexHash<base::String, Space> iso::space::SpaceManager::mSpaces [protected]

spaces


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