VR-Forces 4.0.4 Class Documentation
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Private Member Functions | Friends
makVrv::DtSharedSimulationSettings Class Reference

The shared simulation settings. More...

Inheritance diagram for makVrv::DtSharedSimulationSettings:
Inheritance graph
[legend]

List of all members.

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.
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.
Mapper Retrieval Methods
DtEntityTypeMapperfindMapperByName (const std::string &name)
 Get a mapper by name.
const DtEntityTypeMapperfindMapperByName (const std::string &name) const
 Get a mapper by name (const).
Mapper Accessors
DtEntityTypeMappertypeMapper (MapperType type)
 Mapper retrieval method.
const DtEntityTypeMappertypeMapper (MapperType type) const
 Mapper retrieval method (const).
DtEntityTypeMapperentityTypeMapper ()
 Entity type mapper.
const DtEntityTypeMapperentityTypeMapper () const
 Entity types mapper (const).
DtEntityTypeMapperaggregateTypeMapper ()
 Aggregate type mapper.
const DtEntityTypeMapperaggregateTypeMapper () const
 Aggregate type mapper (const).
DtEntityTypeMapperweaponFireMapper ()
 Fire mapper.
const DtEntityTypeMapperweaponFireMapper () const
 Fire mapper (const).
DtEntityTypeMapperdetonationTypeMapper ()
 Detonation mapper.
const DtEntityTypeMapperdetonationTypeMapper () const
 Detonation mapper (const).
DtEntityTypeMappertacticalGraphicsMapper ()
 Tactical graphics mapper.
const DtEntityTypeMappertacticalGraphicsMapper () const
 Tactical graphics mapper (const).
DtEntityTypeMapperradioCommunicationMapper ()
 Radio communication mapper.
const DtEntityTypeMapperradioCommunicationMapper () const
 Radio communication mapper (const).
DtEntityTypeMapperradioTransmissionMapper ()
 Radio transmission mapper.
const DtEntityTypeMapperradioTransmissionMapper () const
 Radio transmission mapper (const).

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< DtUnicodemyEmptyMappings
 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


Member Enumeration Documentation

Enumerator:
SIMSETTINGSMAPPERS 

Constructor & Destructor Documentation

DTOR.

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.

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.

Get a mapper by name.

Get a mapper by name (const).

Mapper retrieval method.

Returns:
the mapper of the given type.

Mapper retrieval method (const).

Returns:
the mapper of the given type.

Entity type mapper.

Maps entity types to element definitions.

Entity types mapper (const).

Maps entity types to element definitions.

Aggregate type mapper.

Maps aggregate types to element definitions.

Aggregate type mapper (const).

Maps aggregate types to element definitions.

Fire mapper.

Maps munition types to element definitions.

Fire mapper (const).

Maps munition types to element definitions.

Detonation mapper.

Maps munition types to element definitions.

Detonation mapper (const).

Maps munition types to element definitions.

Tactical graphics mapper.

Maps tactical graphics types to element definitions.

Tactical graphics mapper (const).

Maps tactical graphics types to element definitions.

Radio communication mapper.

Maps radio communication sender entity types to element definitions.

Radio communication mapper (const).

Maps radio communication sender entity types to element definitions.

Radio transmission mapper.

Maps radio transmission sender entity types to element definitions.

Radio transmission mapper (const).

Maps radio transmission sender entity 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) [protected, virtual]

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) [protected, virtual]

Disconnects mapper signals.

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

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

Use the DtReadSettingsLock to read the object.

Use the DtWriteSettingsLock to write to the object.


Member Data Documentation

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


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)