makVrf::DtRadarModeRequestor Class Reference

The class that is the interface between the GUI and the back-end. More...

Inheritance diagram for makVrf::DtRadarModeRequestor:

List of all members.

Classes
struct	DtRadarModeDataRecord
	Data structure used by this class to store entity data. More...
Public Member Functions
virtual	~DtRadarModeRequestor ()
	Destructor.
virtual std::string	currentModeFor (std::string entityName, int emitterId) const
	Gets the cached current mode for an entity given an emitter id for that entity.
virtual std::vector< int >	emitterIdsFor (std::string entityName) const
	Gets the cached emitter ids for all emitters on an entity.
virtual std::vector< std::string >	radarModesFor (std::string entityName, int emitterId) const
	Gets all the cached radar modes for an entity given an emitter id for that entity.
virtual bool	hasRadarModesFor (std::string entityName) const
	Checks to see if there are radar modes in the cache for an entity.
virtual int	groupIdsAndModes (std::vector< std::string > entities, std::vector< int > &returnIds, std::vector< std::string > &returnModes)
	Given a list of entities, gets the intersection of emitter ids and those id's modes and returns them in single lists.
virtual int	groupModes (std::vector< std::string > entities, int emitterId, std::vector< std::string > &returnModes)
	Given a list of entities, gets the intersection of the specified id's modes and returns them in a single list.
virtual void	updateRadarModes (std::string entityName)
	Request an update to the cached data from the sim for a specific entity.
Static Public Member Functions
static DtRadarModeRequestor &	instance (makVrv::DtDe &de)
	Returns instance of the DtRadarModeRequestor.
static void	registerInstance (makVrv::DtDe &de, DtRadarModeRequestor *object)
	Register a subclass version of this class.
Public Attributes
boost::signal< void(std::string, int)>	signal_radarModesReceived
	Signal sent when new data has arrived for a particular entity and its emitter id.
Protected Member Functions
	DtRadarModeRequestor (makVrv::DtDe &)
	Class constructor is protected, use instance function instead.
virtual void	slot_onSimDataRemoved (makVrv::DtSimObjectEntry &)
	Handles the removal of the cache data when an entity is removed.
virtual void	processRadarModes (const DtVrfObjectMessage *msg)
	Handles radar mode updates either requested by updateRadarModes() or from general state updates occuring from the sim.
Protected Attributes
makVrv::DtDe &	myDe
std::map< std::string, DtRadarModeDataRecord >	myEntitiesTable

---

Detailed Description

The class that is the interface between the GUI and the back-end.

---

Constructor & Destructor Documentation

virtual makVrf::DtRadarModeRequestor::~DtRadarModeRequestor

(

)

[virtual]

Destructor.

makVrf::DtRadarModeRequestor::DtRadarModeRequestor

(

makVrv::DtDe &

)

[protected]

Class constructor is protected, use instance function instead.

---

Member Function Documentation

static DtRadarModeRequestor& makVrf::DtRadarModeRequestor::instance

(

makVrv::DtDe &

de

)

[static]

Returns instance of the DtRadarModeRequestor.

static void makVrf::DtRadarModeRequestor::registerInstance	(	makVrv::DtDe &	de,
		DtRadarModeRequestor *	object
	)		[static]

Register a subclass version of this class.

the instance() function will return the newly registered version once this has been called.

virtual std::string makVrf::DtRadarModeRequestor::currentModeFor	(	std::string	entityName,
		int	emitterId
	)		const [virtual]

Gets the cached current mode for an entity given an emitter id for that entity.

virtual std::vector<int> makVrf::DtRadarModeRequestor::emitterIdsFor

(

std::string

entityName

)

const [virtual]

Gets the cached emitter ids for all emitters on an entity.

virtual std::vector<std::string> makVrf::DtRadarModeRequestor::radarModesFor	(	std::string	entityName,
		int	emitterId
	)		const [virtual]

Gets all the cached radar modes for an entity given an emitter id for that entity.

virtual bool makVrf::DtRadarModeRequestor::hasRadarModesFor

(

std::string

entityName

)

const [virtual]

Checks to see if there are radar modes in the cache for an entity.

virtual int makVrf::DtRadarModeRequestor::groupIdsAndModes	(	std::vector< std::string >	entities,
		std::vector< int > &	returnIds,
		std::vector< std::string > &	returnModes
	)		[virtual]

Given a list of entities, gets the intersection of emitter ids and those id's modes and returns them in single lists.

Intersection meaning commonality between the entities in cache.

virtual int makVrf::DtRadarModeRequestor::groupModes	(	std::vector< std::string >	entities,
		int	emitterId,
		std::vector< std::string > &	returnModes
	)		[virtual]

Given a list of entities, gets the intersection of the specified id's modes and returns them in a single list.

Intersection meaning commonality between the entities in cache.

virtual void makVrf::DtRadarModeRequestor::updateRadarModes

(

std::string

entityName

)

[virtual]

Request an update to the cached data from the sim for a specific entity.

virtual void makVrf::DtRadarModeRequestor::slot_onSimDataRemoved

(

makVrv::DtSimObjectEntry &

)

[protected, virtual]

Handles the removal of the cache data when an entity is removed.

virtual void makVrf::DtRadarModeRequestor::processRadarModes

(

const DtVrfObjectMessage *

msg

)

[protected, virtual]

Handles radar mode updates either requested by updateRadarModes() or from general state updates occuring from the sim.

---

Member Data Documentation

boost::signal<void (std::string, int)> makVrf::DtRadarModeRequestor::signal_radarModesReceived

Signal sent when new data has arrived for a particular entity and its emitter id.

makVrv::DtDe& makVrf::DtRadarModeRequestor::myDe [protected]

std::map<std::string, DtRadarModeDataRecord> makVrf::DtRadarModeRequestor::myEntitiesTable [protected]

---

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

• include/vrfGuiCore/radarModeRequestor.h