DtHazardAreaManager Class Reference

The scenario event manager will keep track of all hazard area objects and their state. More...

Public Member Functions
	DtHazardAreaManager (DtSimManager *)
	CTOR.
virtual	~DtHazardAreaManager ()
	DTOR.
virtual bool	loadHazardAreaInformationFile (const DtFilename &filename, bool clear)
	Loads hazard area information file from given directory.
virtual DtSimManager *	simManager () const
virtual void	addHazardAreaType (const DtEntityType &)
	Adds a new hazard area to watch. Will redo internal list to contain new area.
virtual void	removeHazardAreaType (const DtEntityType &)
	Removes a hazard area to watch.
virtual std::vector < DtVrfObject * >	hazardAreas (const DtEntityType &)
	Returns a list of hazard areas that match the given type.
virtual const std::vector < DtEntityType > &	hazardAreaTypes () const
virtual const std::set < DtVrfObject * > &	hazardAreas () const
	Returns all hazard areas.
virtual const DtRwHazardAreaInformation &	hazardAreaInformation () const
	Returns the full hazard area information.

Protected Member Functions
virtual void	processHazardAreaInformation (DtSimMessage *msg)
virtual void	processHazardAreaAdded (DtVrfObject *)
virtual void	processHazardAreaRemoved (DtVrfObject *)

Static Protected Member Functions
static void	requestHazardAreaInformationCallback (DtSimMessage *msg, void *usr)
static void	hazardAreaAddedCallback (DtVrfObject *, void *)
	Called when a hazard area is added via the object manager.
static void	hazardAreaRemovedCallback (DtVrfObject *, void *)
	Called when a hazard area is removed from the object manager.

Protected Attributes
DtSimManager *	mySimManager
DtRwHazardAreaInformation	myHazardAreaInformation
std::vector< DtEntityType >	myHazardAreaTypes
std::set< DtVrfObject * >	myHazardAreas

Private Member Functions
	DtHazardAreaManager (const DtHazardAreaManager &orig)
	copy constructor
DtHazardAreaManager &	operator= (const DtHazardAreaManager &orig)
	assignment operator

Detailed Description

The scenario event manager will keep track of all hazard area objects and their state.

Hazard areas are predefined as part of this class. Call the add/remove methods to add or remove areas to watch

Constructor & Destructor Documentation

DtHazardAreaManager::DtHazardAreaManager

(

DtSimManager *

)

CTOR.

virtual DtHazardAreaManager::~DtHazardAreaManager ( )

virtual

DTOR.

DtHazardAreaManager::DtHazardAreaManager ( const DtHazardAreaManager &  orig )

private

copy constructor

Member Function Documentation

virtual bool DtHazardAreaManager::loadHazardAreaInformationFile ( const DtFilename &  filename, bool  clear  )

virtual

Loads hazard area information file from given directory.

DtHazardAreaManager& DtHazardAreaManager::operator= ( const DtHazardAreaManager &  orig )

private

assignment operator

virtual DtSimManager* DtHazardAreaManager::simManager ( ) const

virtual

virtual void DtHazardAreaManager::addHazardAreaType ( const DtEntityType &  )

virtual

Adds a new hazard area to watch. Will redo internal list to contain new area.

virtual void DtHazardAreaManager::removeHazardAreaType ( const DtEntityType &  )

virtual

Removes a hazard area to watch.

Will redo internal list to contain correct areas. Note that if a wildcarded type is supplied, all types that match that type will be removed

virtual std::vector<DtVrfObject*> DtHazardAreaManager::hazardAreas ( const DtEntityType &  )

virtual

Returns a list of hazard areas that match the given type.

virtual const std::vector<DtEntityType>& DtHazardAreaManager::hazardAreaTypes ( ) const

virtual

virtual const std::set<DtVrfObject*>& DtHazardAreaManager::hazardAreas ( ) const

virtual

Returns all hazard areas.

virtual const DtRwHazardAreaInformation& DtHazardAreaManager::hazardAreaInformation ( ) const

virtual

Returns the full hazard area information.

static void DtHazardAreaManager::requestHazardAreaInformationCallback ( DtSimMessage *  msg, void *  usr  )

staticprotected

virtual void DtHazardAreaManager::processHazardAreaInformation ( DtSimMessage *  msg )

protectedvirtual

static void DtHazardAreaManager::hazardAreaAddedCallback ( DtVrfObject *  , void *    )

staticprotected

Called when a hazard area is added via the object manager.

virtual void DtHazardAreaManager::processHazardAreaAdded ( DtVrfObject *  )

protectedvirtual

static void DtHazardAreaManager::hazardAreaRemovedCallback ( DtVrfObject *  , void *    )

staticprotected

Called when a hazard area is removed from the object manager.

virtual void DtHazardAreaManager::processHazardAreaRemoved ( DtVrfObject *  )

protectedvirtual

Member Data Documentation

DtSimManager* DtHazardAreaManager::mySimManager

protected

DtRwHazardAreaInformation DtHazardAreaManager::myHazardAreaInformation

protected

std::vector<DtEntityType> DtHazardAreaManager::myHazardAreaTypes

protected

std::set<DtVrfObject*> DtHazardAreaManager::myHazardAreas

protected

---

The documentation for this class was generated from the following file:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfobjcore/hazardAreaManager.h