DtCommModelManager Class Reference

Holds all radio networks (comm models, implemented by DtCommModel) 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. See the documentation on DtCommModel for more details on comm models.

Public Member Functions
virtual	~DtCommModelManager ()
virtual void	reset ()
virtual bool	initializeForScenario (const DtFilename &paramsFile)
virtual bool	loadCommModelFile (const DtFilename &paramsFile)
virtual bool	setupCommModels ()
virtual DtCommModel *	lookupCommModel (const DtString &networkName)
virtual void	tick ()
virtual void	clearPendingRadioMessages ()

Static Public Member Functions
static DtCommModelManager *	create (DtSimulationServices *simManager)
static void	tickCallback (void *usr)

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

Protected Member Functions
	DtCommModelManager (DtSimulationServices *simManager)
virtual bool	init ()
virtual bool	setupCommModels (const DtCommModelDescriptorList &descList)
void	clearCommModels ()

Protected Attributes
DtSimulationServices *	mySimulationServices
DtCommModelMap	myCommModelMap
DtCommModelDescriptorList *	myDescriptorList

Private Member Functions
	DtCommModelManager ()
	DtCommModelManager (const DtCommModelManager &orig)
DtCommModelManager &	operator= (const DtCommModelManager &orig)

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

Not implemented.

DtCommModelManager::DtCommModelManager ( DtSimulationServices *  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

Not implemented.

virtual bool DtCommModelManager::init ( )

protectedvirtual

Virtual init. Called from the create method.

static DtCommModelManager* DtCommModelManager::create ( DtSimulationServices *  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 DtSimulationServices 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

DtSimulationServices* DtCommModelManager::mySimulationServices

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.vrf5-0-branch/include/vrfobjcore/commModelManager.h