VR-Forces 4.0.4 Class Documentation
Public Member Functions | Static Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes
makVrf::DtVrfSpotReportManager Class Reference

The Master Scenario Settings Dialog. More...

Inheritance diagram for makVrf::DtVrfSpotReportManager:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtVrfSpotReportManager (makVrv::DtDe &)
virtual ~DtVrfSpotReportManager ()
void setAutoSave (bool b)
bool autoSave () const
virtual void getRecord (DtVrfSpotReportsSettingsRecord &rec) const
virtual void setFromRecord (const DtVrfSpotReportsSettingsRecord &rec)
 Emits signal to add FogOfWar filter with the new spot report settings.
void setDisplayReportingName (bool)
 Calls to current settings record to store the values.
bool displayReportingName () const
void setDisplayObservedName (bool)
bool displayObservedName () const
void setDisplayLastContact (bool)
bool displayLastContact () const
void setDisplayLocation (bool)
bool displayLocation () const
void setDisplayVelocity (bool)
bool displayVelocity () const
void setDisplayHeading (bool)
bool displayHeading () const
void setDisplayEntityType (bool)
bool displayEntityType () const
void setDisplayHeadingIndicator (bool)
bool displayHeadingIndicator () const
void setDisplayVelocityIndicator (bool)
bool displayVelocityIndicator () const
void setApplyToEnvironmentals (bool)
bool applyToEnvironmentals () const
const std::vector< int > & certaintyLevels () const
void setCertaintyLevels (const std::vector< int > &)
void setCertaintyLevel (int level, int time)
virtual bool showSpotReportsForForce (int) const
 Returns true/false the the specified force should be shown for either spot reports or ground truth.
virtual bool showGroundTruthForForce (int) const
virtual void addShowSpotReportFor (int)
 Adds/removes items for the specified force items.
virtual void removeShowSpotReportFor (int)
void setShowSpotReportsForForce (const std::vector< int > &)
const std::vector< int > spotReportsFor () const
virtual void addShowGroundTruthFor (int)
virtual void removeShowGroundTruthFor (int)
void setShowGroundTruthForForce (const std::vector< int > &)
const std::vector< int > groundTruthFor () const
virtual void setDisplayFlag (int, bool)
 Sets display flag to on/off.
virtual void setSpotReportsGloballyEnabled (bool enabled)
 Sets the global state of spot reports - all entities set to use the global setting (which is the default) will obey this value.
void setSystemEnabled (bool)
 Set to false to disable the spot report and ground truth display system.
bool systemEnabled () const
virtual void loadDefaults (bool fromFactory=false)
 Loads default or factory record.
virtual void saveAsDefaults ()
 Saves record as default record.
const
makVrv::DtRecordSettingsBackupInterface
settingsBackup () const
makVrv::DtRecordSettingsBackupInterfacesettingsBackup ()
void exportSettings (const std::string &fileName)
 Exports the current cache settings to a file.
void importSettings (const std::string &fileName)
 Import the current cache settings from a file.
virtual void processReceiveSpotReport (const DtVrfObjectMessage *msg)
virtual std::string addOrUpdateSpotReport (const std::string &type, void *, const std::string &key="")
 Calls to the spot report data processor to add a new type of supplied spot report or update it (if it exists).
virtual void addFogOfWarFilter (const DtVrfSelectionFilter &)
 Adds a new filter to the fog of war filters list, replacing one that is already there with the same name.
virtual void removeFogOfWarFilter (const std::string &)
 Removes fog of war filter with given name.
virtual bool passesFogOfWarFilters (const makVrv::DtVrlinkSimulatedBaseState *) const
 Returns true if this item passes the fog of war filters and should be visible.
virtual bool blockSignals (bool)
 Blocks the sending of any signals.
virtual void addSpotReportDataHandler (const std::string &s, DtSpotReportDataHandlerCreatorInterface *)
 Once added, the spot report data processor class will take ownership of the memory.
virtual void removeSpotReportDataHandler (const std::string &s)
virtual void setSpotReportsSelectable (bool)
 Set spot reports to be selectable. Default is false.
virtual bool spotReportsSelectable () const
virtual void addSpotReportVisualHandler (const std::string &s, DtSpotReportVisualHandlerCreatorInterface *)
 Once added, the spot report visuals manager class will take ownership of the memory.
virtual void removeSpotReportVisualHandler (const std::string &s)

Static Public Member Functions

static DtVrfSpotReportManagerinstance (makVrv::DtDe &de)
 Returns instance of the messager.

Public Attributes

boost::signal< void(const
DtVrfSpotReportsSettingsRecord &)> 
signal_spotReportOptionsChanged
 Sent after anything about the spot report options have changed.
boost::signal< void(bool)> signal_spotReportsSelectableChanged
 Sent after selectability of spot reports have changed. This is currently only able to be set via the API.
boost::signal< void(DtVrfSpotReportVisualizer *)> signal_spotReportCreated
 Signal sent when spot report visualizer is created.

Protected Member Functions

virtual void constructSpotReportDictionary ()
 Upgrade the current spot report dictionary to contain elements in the supplied dictionaries.
virtual bool upgradeFromDictionary (makVrv::DtElementDefinitionTypeManager::ElementDefinitionType dictType, bool force=false)
 Upgrades the spot report dictionary from the specified dictionary.
virtual void mergeItemsFrom (const makVrv::DtElementDefinitionNew *source, makVrv::DtElementDefinitionNew *spotReport, const std::vector< int > &supportedSets)
 Merges in element definitions from the source set, only using the 2D model set.
virtual bool isUnusedVisualizer (const makVrv::DtVisualizerDefinition *) const

Protected Attributes

makVrv::DtDemyDe
makVrv::DtRecordSettingsBackupInterfacemySettingsBackup
bool mySignalsBlocked
DtVrfSpotReportsSettingsRecord mySpotReportSettings
bool mySpotReportsSelectable

Detailed Description

The Master Scenario Settings Dialog.


Constructor & Destructor Documentation


Member Function Documentation

Returns instance of the messager.

Emits signal to add FogOfWar filter with the new spot report settings.

Calls to current settings record to store the values.

Will back up and auto save as necessary

const std::vector<int>& makVrf::DtVrfSpotReportManager::certaintyLevels ( ) const
void makVrf::DtVrfSpotReportManager::setCertaintyLevels ( const std::vector< int > &  )
void makVrf::DtVrfSpotReportManager::setCertaintyLevel ( int  level,
int  time 
)

Returns true/false the the specified force should be shown for either spot reports or ground truth.

If the internal list is empty will return true

virtual void makVrf::DtVrfSpotReportManager::addShowSpotReportFor ( int  ) [virtual]

Adds/removes items for the specified force items.

void makVrf::DtVrfSpotReportManager::setShowSpotReportsForForce ( const std::vector< int > &  )
const std::vector<int> makVrf::DtVrfSpotReportManager::spotReportsFor ( ) const
void makVrf::DtVrfSpotReportManager::setShowGroundTruthForForce ( const std::vector< int > &  )
const std::vector<int> makVrf::DtVrfSpotReportManager::groundTruthFor ( ) const
virtual void makVrf::DtVrfSpotReportManager::setDisplayFlag ( int  ,
bool   
) [virtual]

Sets display flag to on/off.

Sets the global state of spot reports - all entities set to use the global setting (which is the default) will obey this value.

Set to false to disable the spot report and ground truth display system.

If false, spot reports will not be displayed and ground truth will be displayed for all entities. Default is true

virtual void makVrf::DtVrfSpotReportManager::loadDefaults ( bool  fromFactory = false) [virtual]

Loads default or factory record.

Saves record as default record.

void makVrf::DtVrfSpotReportManager::exportSettings ( const std::string &  fileName)

Exports the current cache settings to a file.

void makVrf::DtVrfSpotReportManager::importSettings ( const std::string &  fileName)

Import the current cache settings from a file.

virtual std::string makVrf::DtVrfSpotReportManager::addOrUpdateSpotReport ( const std::string &  type,
void *  ,
const std::string &  key = "" 
) [virtual]

Calls to the spot report data processor to add a new type of supplied spot report or update it (if it exists).

The spot report data processor will look up the appropriate type of spot report manager object based on the supplied type. See the DtSpotReportDataProcessor class for more information

Adds a new filter to the fog of war filters list, replacing one that is already there with the same name.

Emits signal_addFogOfWarFilter via the shared signaler

virtual void makVrf::DtVrfSpotReportManager::removeFogOfWarFilter ( const std::string &  ) [virtual]

Removes fog of war filter with given name.

Emits signal_removeFogOfWarFilter with given name, even if filter does not exist in list

Returns true if this item passes the fog of war filters and should be visible.

Blocks the sending of any signals.

Once added, the spot report data processor class will take ownership of the memory.

If an existing handler is there for the supplied string, it will be replaced

virtual void makVrf::DtVrfSpotReportManager::removeSpotReportDataHandler ( const std::string &  s) [virtual]

Set spot reports to be selectable. Default is false.

Once added, the spot report visuals manager class will take ownership of the memory.

If an existing handler is there for the supplied string, it will be replaced

virtual void makVrf::DtVrfSpotReportManager::removeSpotReportVisualHandler ( const std::string &  s) [virtual]

Upgrade the current spot report dictionary to contain elements in the supplied dictionaries.

Will do this for the entity element dictionary and the tactical graphic dictionary

Upgrades the spot report dictionary from the specified dictionary.

Will add new paths to contain spot report visual elements. If root nodes exist in the source and spot report dictionary, but, the spot report dictionary contains those roots in a different path, the spot report dictionary will be changed to match

virtual void makVrf::DtVrfSpotReportManager::mergeItemsFrom ( const makVrv::DtElementDefinitionNew source,
makVrv::DtElementDefinitionNew spotReport,
const std::vector< int > &  supportedSets 
) [protected, virtual]

Merges in element definitions from the source set, only using the 2D model set.


Member Data Documentation

Sent after anything about the spot report options have changed.

Sent after selectability of spot reports have changed. This is currently only able to be set via the API.

Signal sent when spot report visualizer is created.


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)