DtCommModelManager Class Reference

Holds all radio networks for the current exercise. More...

Public Member Functions
virtual	~DtCommModelManager ()
virtual void	reset ()
	Resets the radio network manager to the state when no scenario is loaded. More...
virtual bool	initializeForScenario (const DtFilename &paramsFile)
	Sets up all radio networks for a new scenario. More...
virtual bool	loadCommModelFile (const DtFilename &paramsFile)
	Loads a comm model file into the descriptor list (which it will create if it does not exist). More...
virtual bool	setupCommModels ()
	Calls setupCommModels(*myDescriptorList) More...
virtual DtCommModel *	lookupCommModel (const DtString &networkName)
virtual void	tick ()
	Ticks all the contained DtCommModel instances. More...
virtual void	clearPendingRadioMessages ()
	Called to clear any pending radio messages in the comm model map that are waiting to be sent. More...

Static Public Member Functions
static DtCommModelManager *	create (DtSimManager *simManager)
	Call this method to create a new instance instead of using the constructor. More...
static void	tickCallback (void *usr)
	Static tick method that can be registered with DtSimManager callbacks. More...

Protected Types
typedef std::map< DtString, DtCommModel * >	DtCommModelMap

Protected Member Functions
	DtCommModelManager (DtSimManager *simManager)
	Use the create() method instead of calling the constructor. More...
virtual bool	init ()
	Virtual init. Called from the create method. More...
virtual bool	setupCommModels (const DtCommModelDescriptorList &descList)
	Creates all radio networks specified in the specified descriptor list. More...
void	clearCommModels ()
	Removes and deletes all radio networks. More...

Protected Attributes
DtSimManager *	mySimManager
DtCommModelMap	myCommModelMap
DtCommModelDescriptorList *	myDescriptorList

Private Member Functions
	DtCommModelManager ()
	Not implemented. More...
	DtCommModelManager (const DtCommModelManager &orig)
DtCommModelManager &	operator= (const DtCommModelManager &orig)

Detailed Description

Holds all radio networks for the current exercise.

The DtCommModelManager must be initialized with data about what radio networks to use in a scenario by calling the initializeForScenario() method.

Member Typedef Documentation

typedef std::map<DtString, DtCommModel*> DtCommModelManager::DtCommModelMap

protected

Constructor & Destructor Documentation

DtCommModelManager::DtCommModelManager ( )

private

Not implemented.

DtCommModelManager::DtCommModelManager ( const DtCommModelManager &  orig )

private

DtCommModelManager::DtCommModelManager ( DtSimManager *  simManager )

protected

Use the create() method instead of calling the constructor.

virtual DtCommModelManager::~DtCommModelManager ( )

virtual

Member Function Documentation

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

private

virtual bool DtCommModelManager::init ( )

protectedvirtual

Virtual init. Called from the create method.

static DtCommModelManager* DtCommModelManager::create ( DtSimManager *  simManager )

static

Call this method to create a new instance instead of using the constructor.

Calls the constructor, and then calls init() on the new instance before returning it.

virtual void DtCommModelManager::reset ( )

virtual

Resets the radio network manager to the state when no scenario is loaded.

All radio networks are removed from the system.

virtual bool DtCommModelManager::initializeForScenario ( const DtFilename &  paramsFile )

virtual

Sets up all radio networks for a new scenario.

The descriptorList specified indicates the radio networks for the scenario. After this call, the network manager is ready for a scenario run.

virtual bool DtCommModelManager::loadCommModelFile ( const DtFilename &  paramsFile )

virtual

Loads a comm model file into the descriptor list (which it will create if it does not exist).

Called from initialzeForScenario, but, can be used to load more than one comm model file into the system. If this routine is used and not initializeForScenario, make sure to call setupCommModels() after all loads are complete

virtual bool DtCommModelManager::setupCommModels ( )

virtual

Calls setupCommModels(*myDescriptorList)

virtual DtCommModel* DtCommModelManager::lookupCommModel ( const DtString &  networkName )

virtual

Returns

A pointer to the network with the specified name, if it exists in the manager.

static void DtCommModelManager::tickCallback ( void *  usr )

static

Static tick method that can be registered with DtSimManager callbacks.

Calls tick().

virtual void DtCommModelManager::tick ( )

virtual

Ticks all the contained DtCommModel instances.

virtual void DtCommModelManager::clearPendingRadioMessages ( )

virtual

Called to clear any pending radio messages in the comm model map that are waiting to be sent.

This method is called when a scenario is being rolled back/rewound

virtual bool DtCommModelManager::setupCommModels ( const DtCommModelDescriptorList &  descList )

protectedvirtual

Creates all radio networks specified in the specified descriptor list.

void DtCommModelManager::clearCommModels ( )

protected

Removes and deletes all radio networks.

Member Data Documentation

DtSimManager* DtCommModelManager::mySimManager

protected

DtCommModelMap DtCommModelManager::myCommModelMap

protected

DtCommModelDescriptorList* DtCommModelManager::myDescriptorList

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf4-10-branch/include/vrfobjcore/commModelManager.h