makVrv::DtVrlinkDetonationResultMapper Class Reference

DtVrlinkDetonationResultMapper is the specialization of the DtDetonationResultMapper templated class using DtDetonationResult for the template argument. More...

Public Types
typedef boost::unordered_set < std::string >	DetonationCategorySet
	The set of all detonation categories to which results are mapped are represented in an object of this type.

Public Member Functions
	DtVrlinkDetonationResultMapper ()
	CTOR.
virtual	~DtVrlinkDetonationResultMapper ()
	DTOR.
virtual void	setDefaultMappings ()
	Set up the default detonationResult to detonationCategory mappings for use with VR-Limk connections.
virtual void	addMapping (DtDetonationResult detonationResult, const std::string &detonationCategory)
	Add a mapping.
virtual void	removeMapping (DtDetonationResult detonationResult)
	Remove a mapping.
virtual const std::string &	detonationCategory (DtDetonationResult detonationResult) const
	Return the detonation category mapped to the indicated detonation result.
virtual const DetonationCategorySet &	detonationCategories () const
	Get the list of detonation categories to which results are mapped.

Static Public Attributes
static const std::string	theObjectDetonationResultCategory
	Strings that represent detonation categories.
static const std::string	theGroundDetonationResultCategory
static const std::string	theAirDetonationResultCategory
static const std::string	theWaterDetonationResultCategory
static const std::string	theGenericDetonationResultCategory
static const std::string	theUnusedDetonationResultCategory

Protected Types
typedef boost::unordered_map < DtDetonationResult, std::string >	DetonationResultMap

Protected Attributes
DetonationResultMap	myDetonationResultMap
DetonationCategorySet	myDetonationCategorySet

Detailed Description

DtVrlinkDetonationResultMapper is the specialization of the DtDetonationResultMapper templated class using DtDetonationResult for the template argument.

Member Typedef Documentation

typedef boost::unordered_set<std::string> makVrv::DtVrlinkDetonationResultMapper::DetonationCategorySet

The set of all detonation categories to which results are mapped are represented in an object of this type.

typedef boost::unordered_map<DtDetonationResult, std::string> makVrv::DtVrlinkDetonationResultMapper::DetonationResultMap

protected

Constructor & Destructor Documentation

makVrv::DtVrlinkDetonationResultMapper::DtVrlinkDetonationResultMapper

(

)

CTOR.

virtual makVrv::DtVrlinkDetonationResultMapper::~DtVrlinkDetonationResultMapper ( )

virtual

DTOR.

Member Function Documentation

virtual void makVrv::DtVrlinkDetonationResultMapper::setDefaultMappings ( )

virtual

Set up the default detonationResult to detonationCategory mappings for use with VR-Limk connections.

virtual void makVrv::DtVrlinkDetonationResultMapper::addMapping ( DtDetonationResult  detonationResult, const std::string &  detonationCategory  )

virtual

Add a mapping.

If the detonationCategory has not been mapped to already, it will be added to the DtDetonationResultMapperBase's Detonation Category Set.

virtual void makVrv::DtVrlinkDetonationResultMapper::removeMapping ( DtDetonationResult  detonationResult )

virtual

Remove a mapping.

If the detonationCategory is no longer mapped to to any detonation result, it will be removed from the DtDetonationResultMapperBase's Detonation Category Set.

virtual const std::string& makVrv::DtVrlinkDetonationResultMapper::detonationCategory ( DtDetonationResult  detonationResult ) const

virtual

Return the detonation category mapped to the indicated detonation result.

virtual const DetonationCategorySet& makVrv::DtVrlinkDetonationResultMapper::detonationCategories ( ) const

virtual

Get the list of detonation categories to which results are mapped.

Member Data Documentation

const std::string makVrv::DtVrlinkDetonationResultMapper::theObjectDetonationResultCategory

static

Strings that represent detonation categories.

const std::string makVrv::DtVrlinkDetonationResultMapper::theGroundDetonationResultCategory

static

const std::string makVrv::DtVrlinkDetonationResultMapper::theAirDetonationResultCategory

static

const std::string makVrv::DtVrlinkDetonationResultMapper::theWaterDetonationResultCategory

static

const std::string makVrv::DtVrlinkDetonationResultMapper::theGenericDetonationResultCategory

static

const std::string makVrv::DtVrlinkDetonationResultMapper::theUnusedDetonationResultCategory

static

DetonationResultMap makVrv::DtVrlinkDetonationResultMapper::myDetonationResultMap

protected

DetonationCategorySet makVrv::DtVrlinkDetonationResultMapper::myDetonationCategorySet

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvVrl/DtVrlinkDetonationResultMapper.h