The shared simulation settings. More...

Inheritance diagram for makVrv::DtSharedSimulationSettings:

Public Types
enum	MapperType { SIMSETTINGSMAPPERS }

Public Member Functions
virtual	~DtSharedSimulationSettings ()
	DTOR.
virtual void	setMapper (MapperType mapperType, const DtEntityTypeMapper &mapper)
	Set the mapper of the given type.
Methods for registering new mappings with the mappers.
void	setMapping (MapperType mapperType, const DtEntityType &type, const DtUnicode &definition)
	Adds the mapping to the mapper of the given type.
void	setEntityModelMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the entity model mapping.
void	setAggregateModelMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the aggregate model mapping.
void	setTacticalGraphicsMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the tactical graphics model mapping for an entity type.
void	setFireModelMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the fire model mapping.
void	setDetonationModelMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the detonation model mapping.
void	setRadioCommunicationsMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the radio communications model mapping for an entity type.
void	setRadioTransmissionsMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the radio transmissions model mapping for an entity type.
void	setTacticalSmokeMapping (const DtEntityType &type, const DtUnicode &definition)
	Set the tactical smoke model mapping for an entity type.
Methods for retrieving a mapping for the given type.
const std::vector< DtUnicode > &	mapDefinition (MapperType mapperType, const DtEntityType &type) const
	Get an element definition from the given mapper for the given entity type.
const std::vector< DtUnicode > &	mapEntityDefinition (const DtEntityType &type) const
	Get an element definition for an entity model based upon entity type.
const std::vector< DtUnicode > &	mapAggregateDefinition (const DtEntityType &type) const
	Get an element definition for an aggregate model based upon entity type.
const std::vector< DtUnicode > &	mapFireTypeDefinition (const DtEntityType &type) const
	Get an element definition for a fire effect based upon entity type.
const std::vector< DtUnicode > &	mapDetonationDefinition (const DtEntityType &type) const
	Get an element definition for a detonation effect based upon entity type.
const std::vector< DtUnicode > &	mapTacticalGraphicsDefinition (const DtEntityType &type) const
	Get an element definition for a tactical graphic based upon entity type.
const std::vector< DtUnicode > &	mapRadioCommunicationDefinition (const DtEntityType &type) const
	Get an element definition for a radio communication based on entity type.
const std::vector< DtUnicode > &	mapRadioTransmissionDefinition (const DtEntityType &type) const
	Get an element definition for a radio transmission based on entity type.
const std::vector< DtUnicode > &	mapTacticalSmokeDefinition (const DtEntityType &type) const
	Get an element definition for a tactical smoke based upon entity type.
Mapper Retrieval Methods
DtEntityTypeMapper *	findMapperByName (const std::string &name)
	Get a mapper by name.
const DtEntityTypeMapper *	findMapperByName (const std::string &name) const
	Get a mapper by name (const).
virtual void	mapperNames (std::vector< std::string > &names) const
	Get list of mapper names.
Mapper Accessors
DtEntityTypeMapper &	typeMapper (MapperType type)
	Mapper retrieval method.
const DtEntityTypeMapper &	typeMapper (MapperType type) const
	Mapper retrieval method (const).
DtEntityTypeMapper &	entityTypeMapper ()
	Entity type mapper.
const DtEntityTypeMapper &	entityTypeMapper () const
	Entity types mapper (const).
DtEntityTypeMapper &	aggregateTypeMapper ()
	Aggregate type mapper.
const DtEntityTypeMapper &	aggregateTypeMapper () const
	Aggregate type mapper (const).
DtEntityTypeMapper &	weaponFireMapper ()
	Fire mapper.
const DtEntityTypeMapper &	weaponFireMapper () const
	Fire mapper (const).
DtEntityTypeMapper &	detonationTypeMapper ()
	Detonation mapper.
const DtEntityTypeMapper &	detonationTypeMapper () const
	Detonation mapper (const).
DtEntityTypeMapper &	tacticalGraphicsMapper ()
	Tactical graphics mapper.
const DtEntityTypeMapper &	tacticalGraphicsMapper () const
	Tactical graphics mapper (const).
DtEntityTypeMapper &	radioCommunicationMapper ()
	Radio communication mapper.
const DtEntityTypeMapper &	radioCommunicationMapper () const
	Radio communication mapper (const).
DtEntityTypeMapper &	radioTransmissionMapper ()
	Radio transmission mapper.
const DtEntityTypeMapper &	radioTransmissionMapper () const
	Radio transmission mapper (const).
DtEntityTypeMapper &	tacticalSmokeMapper ()
	Tactical Smoke mapper.
const DtEntityTypeMapper &	tacticalSmokeMapper () const
	Tactical Smoke mapper (const).
Public Member Functions inherited from makVrv::DtSharedSettings
	DtSharedSettings (const DtSharedSettingsManager &manager)
	CTOR.
virtual	~DtSharedSettings ()
	DTOR.
boost::shared_mutex &	mutex ()
	Get the mutex for the settings object.
SafetyKey	safeToEmitSignals ()
	Create a safety key for the function, see above example.
void	setCurrentWriteLock (boost::unique_lock< boost::shared_mutex > *currentWriteLock)
	No need to call, set by the DtWriteSettingLock object.
virtual const DtSettingsBackup *	settingsBackup () const
	Accessor for the settings backup (const).
virtual DtSettingsBackup *	settingsBackup ()
	Accessor for the settings backup.
virtual void	backup ()
	Called to back up the settings.
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static std::string	className ()
	The class name of the settings object.

Protected Types
typedef boost::unordered_map < MapperType, DtEntityTypeMapper * >	MappersMap

Protected Member Functions
	DtSharedSimulationSettings (DtSharedSettingsManager &manager)
	CTOR.
virtual void	connectMapper (DtEntityTypeMapper &mapper)
	Connects mapper signals to update slot.
virtual void	disconnectMapper (DtEntityTypeMapper &mapper)
	Disconnects mapper signals.
virtual void	mapperChanged (const DtEntityType &type, const DtUnicode &value, DtEntityTypeMapper &mapper)
	Slot called when mapper changes.

Protected Attributes
std::vector< DtUnicode >	myEmptyMappings
	Empty vector, for returning the reference which will always be empty.
MappersMap	myMappers

Static Protected Attributes
static char *	theMapperNames []

Private Member Functions
void	initializeMapper (MapperType mapperType, const std::string &backupName)
	Creates a new mapper and connects to changed signals.

Friends
class	DtReadSettingsLock< DtSharedSimulationSettings >
	Use the DtReadSettingsLock to read the object.
class	DtWriteSettingsLock< DtSharedSimulationSettings >
	Use the DtWriteSettingsLock to write to the object.

Detailed Description

The shared simulation settings.

Member Typedef Documentation

typedef boost::unordered_map<MapperType,DtEntityTypeMapper*> makVrv::DtSharedSimulationSettings::MappersMap

protected

Member Enumeration Documentation

enum makVrv::DtSharedSimulationSettings::MapperType

Enumerator:

SIMSETTINGSMAPPERS

Constructor & Destructor Documentation

virtual makVrv::DtSharedSimulationSettings::~DtSharedSimulationSettings ( )

virtual

DTOR.

makVrv::DtSharedSimulationSettings::DtSharedSimulationSettings ( DtSharedSettingsManager & manager )

protected

CTOR.

Member Function Documentation

virtual void makVrv::DtSharedSimulationSettings::setMapper	(	MapperType	mapperType,
		const DtEntityTypeMapper &	mapper
	)

virtual

Set the mapper of the given type.

void makVrv::DtSharedSimulationSettings::setMapping	(	MapperType	mapperType,
		const DtEntityType &	type,
		const DtUnicode &	definition
	)

Adds the mapping to the mapper of the given type.

void makVrv::DtSharedSimulationSettings::setEntityModelMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the entity model mapping.

void makVrv::DtSharedSimulationSettings::setAggregateModelMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the aggregate model mapping.

void makVrv::DtSharedSimulationSettings::setTacticalGraphicsMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the tactical graphics model mapping for an entity type.

void makVrv::DtSharedSimulationSettings::setFireModelMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the fire model mapping.

void makVrv::DtSharedSimulationSettings::setDetonationModelMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the detonation model mapping.

void makVrv::DtSharedSimulationSettings::setRadioCommunicationsMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the radio communications model mapping for an entity type.

void makVrv::DtSharedSimulationSettings::setRadioTransmissionsMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the radio transmissions model mapping for an entity type.

void makVrv::DtSharedSimulationSettings::setTacticalSmokeMapping	(	const DtEntityType &	type,
		const DtUnicode &	definition
	)

Set the tactical smoke model mapping for an entity type.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapDefinition	(	MapperType	mapperType,
		const DtEntityType &	type
	)		const

Get an element definition from the given mapper for the given entity type.

Maps the DtEntityType to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapEntityDefinition ( const DtEntityType & type ) const

Get an element definition for an entity model based upon entity type.

Maps the entity's type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapAggregateDefinition ( const DtEntityType & type ) const

Get an element definition for an aggregate model based upon entity type.

Maps the aggregate's type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapFireTypeDefinition ( const DtEntityType & type ) const

Get an element definition for a fire effect based upon entity type.

Maps the munition's type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapDetonationDefinition ( const DtEntityType & type ) const

Get an element definition for a detonation effect based upon entity type.

Maps the munition's type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapTacticalGraphicsDefinition ( const DtEntityType & type ) const

Get an element definition for a tactical graphic based upon entity type.

Maps the tactical graphic's type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapRadioCommunicationDefinition ( const DtEntityType & type ) const

Get an element definition for a radio communication based on entity type.

Maps the radio communication's sender's entity type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapRadioTransmissionDefinition ( const DtEntityType & type ) const

Get an element definition for a radio transmission based on entity type.

Maps the radio transmission's sender's entity type to the corresponding element definition.

const std::vector<DtUnicode>& makVrv::DtSharedSimulationSettings::mapTacticalSmokeDefinition ( const DtEntityType & type ) const

Get an element definition for a tactical smoke based upon entity type.

Maps the tactical smoke's type to the corresponding element definition.

DtEntityTypeMapper* makVrv::DtSharedSimulationSettings::findMapperByName ( const std::string & name )

Get a mapper by name.

const DtEntityTypeMapper* makVrv::DtSharedSimulationSettings::findMapperByName ( const std::string & name ) const

Get a mapper by name (const).

virtual void makVrv::DtSharedSimulationSettings::mapperNames ( std::vector< std::string > & names ) const

virtual

Get list of mapper names.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::typeMapper ( MapperType type )

Mapper retrieval method.

Returns: the mapper of the given type.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::typeMapper ( MapperType type ) const

Mapper retrieval method (const).

Returns: the mapper of the given type.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::entityTypeMapper ( )

Entity type mapper.

Maps entity types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::entityTypeMapper ( ) const

Entity types mapper (const).

Maps entity types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::aggregateTypeMapper ( )

Aggregate type mapper.

Maps aggregate types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::aggregateTypeMapper ( ) const

Aggregate type mapper (const).

Maps aggregate types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::weaponFireMapper ( )

Fire mapper.

Maps munition types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::weaponFireMapper ( ) const

Fire mapper (const).

Maps munition types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::detonationTypeMapper ( )

Detonation mapper.

Maps munition types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::detonationTypeMapper ( ) const

Detonation mapper (const).

Maps munition types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::tacticalGraphicsMapper ( )

Tactical graphics mapper.

Maps tactical graphics types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::tacticalGraphicsMapper ( ) const

Tactical graphics mapper (const).

Maps tactical graphics types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::radioCommunicationMapper ( )

Radio communication mapper.

Maps radio communication sender entity types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::radioCommunicationMapper ( ) const

Radio communication mapper (const).

Maps radio communication sender entity types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::radioTransmissionMapper ( )

Radio transmission mapper.

Maps radio transmission sender entity types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::radioTransmissionMapper ( ) const

Radio transmission mapper (const).

Maps radio transmission sender entity types to element definitions.

DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::tacticalSmokeMapper ( )

Tactical Smoke mapper.

Maps tactical smoke types to element definitions.

const DtEntityTypeMapper& makVrv::DtSharedSimulationSettings::tacticalSmokeMapper ( ) const

Tactical Smoke mapper (const).

Maps tactical smoke types to element definitions.

static std::string makVrv::DtSharedSimulationSettings::className ( )

static

The class name of the settings object.

virtual void makVrv::DtSharedSimulationSettings::connectMapper ( DtEntityTypeMapper & mapper )

protectedvirtual

Connects mapper signals to update slot.

Update slot will use shared message signaler to send out signal that something about a mapper has changed.

virtual void makVrv::DtSharedSimulationSettings::disconnectMapper ( DtEntityTypeMapper & mapper )

protectedvirtual

Disconnects mapper signals.

virtual void makVrv::DtSharedSimulationSettings::mapperChanged	(	const DtEntityType &	type,
		const DtUnicode &	value,
		DtEntityTypeMapper &	mapper
	)

protectedvirtual

Slot called when mapper changes.

Uses shared message signaler to send out a mapperUpdated signal.

void makVrv::DtSharedSimulationSettings::initializeMapper	(	MapperType	mapperType,
		const std::string &	backupName
	)

private

Creates a new mapper and connects to changed signals.

Non-virtual (Called from CTOR).

Friends And Related Function Documentation

friend class DtReadSettingsLock< DtSharedSimulationSettings >

friend

Use the DtReadSettingsLock to read the object.

friend class DtWriteSettingsLock< DtSharedSimulationSettings >

friend

Use the DtWriteSettingsLock to write to the object.

Member Data Documentation

std::vector<DtUnicode> makVrv::DtSharedSimulationSettings::myEmptyMappings

protected

Empty vector, for returning the reference which will always be empty.

char* makVrv::DtSharedSimulationSettings::theMapperNames[]

staticprotected

MappersMap makVrv::DtSharedSimulationSettings::myMappers

protected

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Friends

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation