makVrf::DtVrfSpotReportManager Class Reference

The Master Scenario Settings Dialog. More...

Inheritance diagram for makVrf::DtVrfSpotReportManager:

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, bool updateFilter=true)
	Emits signal to add FogOfWar filter with the new spot report settings.
virtual void	requestSpotReports ()
	Requests spot reports and sets internal id to make sure this gui is the only one that will handle them.
virtual void	requestSpotReportsFor (std::vector< int > forces)
	Request spot reports for the given forces.
virtual void	showPerspectiveForForce (const std::string &, bool autoSave=true)
	Shows the perspective (ground truth and spot reports) for the given force.
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	setDisplayContactRadius (bool)
bool	displayContactRadius () const
void	setDisplayContactRadiusIndicator (bool)
bool	displayContactRadiusIndicator () 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
void	setShowOnlyActiveEnvironmentals (bool)
bool	showOnlyActiveEnvironmentals () 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	setSpotReportGatherTime (double)
	The time (simulation) used to gather spot reports before reporting to the GUI. Default is 5 simulation seconds.
virtual double	spotReportGatherTime () 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::DtRecordSettingsBackupInterface *	settingsBackup ()
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 void	processReceiveSpotReports (const DtVrfObjectMessage *msg)
virtual bool	addOrUpdateSpotReport (const std::string &type, void *, const DtUUID &)
	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	passesFogOfWarFilters (makVrv::DtUniqueID) const
virtual bool	canShowScenarioEvent (makVrv::DtUniqueID) const
	Returns true if the scenario event can be shown given the current fog of war and scenario event settings.
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	removeSpotReport (makVrv::DtUniqueID)
	Given the spot report unique id, remove it.
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 int	certaintyLevelForTime (double d) const
	Given the time (in seconds) return the certainty level of the spot report.
virtual void	reset ()
	Resets forces requested for spot reports to allow for requesting again when spot report reporting changes.
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)
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
	Do nothing constructor.
virtual	~DtVirtualBaseClass ()
	Virtual do nothing destructor.

Static Public Member Functions
static DtVrfSpotReportManager &	instance (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, const makVrv::DtUnicode &unknownName=makVrv::DtUnicode::fromAscii("Unknown"))
	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
virtual void	enableDecoration (const std::string &, bool)
virtual bool	decorationIsEnabled (const std::string &) const

Protected Attributes
makVrv::DtDe &	myDe
makVrv::DtRecordSettingsBackupInterface *	mySettingsBackup
bool	mySignalsBlocked
DtVrfSpotReportsSettingsRecord	mySpotReportSettings
bool	mySpotReportsSelectable
std::set< unsigned long >	mySpotReportRequestIds
std::set< int >	myAlreadyRequested
std::map< std::string, DtVrfSelectionFilter * >	myModified
std::set< std::string >	myRemoved
DtVrfSelectionFilter *	myActiveEnvironmentalsFilter

Detailed Description

The Master Scenario Settings Dialog.

Constructor & Destructor Documentation

makVrf::DtVrfSpotReportManager::DtVrfSpotReportManager

(

makVrv::DtDe &

)

virtual makVrf::DtVrfSpotReportManager::~DtVrfSpotReportManager ( )

virtual

Member Function Documentation

static DtVrfSpotReportManager& makVrf::DtVrfSpotReportManager::instance ( makVrv::DtDe &  de )

static

Returns instance of the messager.

void makVrf::DtVrfSpotReportManager::setAutoSave

(

bool

b

)

bool makVrf::DtVrfSpotReportManager::autoSave

(

)

const

virtual void makVrf::DtVrfSpotReportManager::getRecord ( DtVrfSpotReportsSettingsRecord &  rec ) const

virtual

virtual void makVrf::DtVrfSpotReportManager::setFromRecord ( const DtVrfSpotReportsSettingsRecord &  rec, bool  updateFilter = true  )

virtual

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

virtual void makVrf::DtVrfSpotReportManager::requestSpotReports ( )

virtual

Requests spot reports and sets internal id to make sure this gui is the only one that will handle them.

virtual void makVrf::DtVrfSpotReportManager::requestSpotReportsFor ( std::vector< int >  forces )

virtual

Request spot reports for the given forces.

virtual void makVrf::DtVrfSpotReportManager::showPerspectiveForForce ( const std::string &  , bool  autoSave = true  )

virtual

Shows the perspective (ground truth and spot reports) for the given force.

The autoSave flag will determine if these settings are saved

void makVrf::DtVrfSpotReportManager::setDisplayReportingName

(

bool

)

Calls to current settings record to store the values.

Will back up and auto save as necessary

bool makVrf::DtVrfSpotReportManager::displayReportingName

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayObservedName

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayObservedName

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayLastContact

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayLastContact

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayLocation

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayLocation

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayVelocity

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayVelocity

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayContactRadius

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayContactRadius

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayContactRadiusIndicator

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayContactRadiusIndicator

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayHeading

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayHeading

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayEntityType

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayEntityType

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayHeadingIndicator

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayHeadingIndicator

(

)

const

void makVrf::DtVrfSpotReportManager::setDisplayVelocityIndicator

(

bool

)

bool makVrf::DtVrfSpotReportManager::displayVelocityIndicator

(

)

const

void makVrf::DtVrfSpotReportManager::setApplyToEnvironmentals

(

bool

)

bool makVrf::DtVrfSpotReportManager::applyToEnvironmentals

(

)

const

void makVrf::DtVrfSpotReportManager::setShowOnlyActiveEnvironmentals

(

bool

)

bool makVrf::DtVrfSpotReportManager::showOnlyActiveEnvironmentals

(

)

const

const std::vector<int>& makVrf::DtVrfSpotReportManager::certaintyLevels

(

)

const

void makVrf::DtVrfSpotReportManager::setCertaintyLevels

(

const std::vector< int > &

)

void makVrf::DtVrfSpotReportManager::setCertaintyLevel	(	int	level,
		int	time
	)

virtual bool makVrf::DtVrfSpotReportManager::showSpotReportsForForce ( int  ) const

virtual

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 bool makVrf::DtVrfSpotReportManager::showGroundTruthForForce ( int  ) const

virtual

virtual void makVrf::DtVrfSpotReportManager::setSpotReportGatherTime ( double  )

virtual

The time (simulation) used to gather spot reports before reporting to the GUI. Default is 5 simulation seconds.

virtual double makVrf::DtVrfSpotReportManager::spotReportGatherTime ( ) const

virtual

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

virtual

Adds/removes items for the specified force items.

virtual void makVrf::DtVrfSpotReportManager::removeShowSpotReportFor ( int  )

virtual

void makVrf::DtVrfSpotReportManager::setShowSpotReportsForForce

(

const std::vector< int > &

)

const std::vector<int> makVrf::DtVrfSpotReportManager::spotReportsFor

(

)

const

virtual void makVrf::DtVrfSpotReportManager::addShowGroundTruthFor ( int  )

virtual

virtual void makVrf::DtVrfSpotReportManager::removeShowGroundTruthFor ( int  )

virtual

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.

virtual void makVrf::DtVrfSpotReportManager::setSpotReportsGloballyEnabled ( bool  enabled )

virtual

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

void makVrf::DtVrfSpotReportManager::setSystemEnabled

(

bool

)

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

bool makVrf::DtVrfSpotReportManager::systemEnabled

(

)

const

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

virtual

Loads default or factory record.

virtual void makVrf::DtVrfSpotReportManager::saveAsDefaults ( )

virtual

Saves record as default record.

const makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSpotReportManager::settingsBackup ( ) const

inline

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSpotReportManager::settingsBackup ( )

inline

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 void makVrf::DtVrfSpotReportManager::processReceiveSpotReport ( const DtVrfObjectMessage *  msg )

virtual

virtual void makVrf::DtVrfSpotReportManager::processReceiveSpotReports ( const DtVrfObjectMessage *  msg )

virtual

virtual bool makVrf::DtVrfSpotReportManager::addOrUpdateSpotReport ( const std::string &  type, void *  , const DtUUID &    )

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

virtual void makVrf::DtVrfSpotReportManager::addFogOfWarFilter ( const DtVrfSelectionFilter &  )

virtual

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

virtual bool makVrf::DtVrfSpotReportManager::passesFogOfWarFilters ( const makVrv::DtVrlinkSimulatedBaseState *  ) const

virtual

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

virtual bool makVrf::DtVrfSpotReportManager::passesFogOfWarFilters ( makVrv::DtUniqueID  ) const

virtual

virtual bool makVrf::DtVrfSpotReportManager::canShowScenarioEvent ( makVrv::DtUniqueID  ) const

virtual

Returns true if the scenario event can be shown given the current fog of war and scenario event settings.

virtual bool makVrf::DtVrfSpotReportManager::blockSignals ( bool  )

virtual

Blocks the sending of any signals.

virtual void makVrf::DtVrfSpotReportManager::addSpotReportDataHandler ( const std::string &  s, DtSpotReportDataHandlerCreatorInterface *    )

virtual

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::removeSpotReport ( makVrv::DtUniqueID  )

virtual

Given the spot report unique id, remove it.

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

virtual

virtual void makVrf::DtVrfSpotReportManager::setSpotReportsSelectable ( bool  )

virtual

Set spot reports to be selectable. Default is false.

virtual bool makVrf::DtVrfSpotReportManager::spotReportsSelectable ( ) const

virtual

virtual int makVrf::DtVrfSpotReportManager::certaintyLevelForTime ( double  d ) const

virtual

Given the time (in seconds) return the certainty level of the spot report.

Return of -1 means that no level was found

virtual void makVrf::DtVrfSpotReportManager::reset ( )

virtual

Resets forces requested for spot reports to allow for requesting again when spot report reporting changes.

virtual void makVrf::DtVrfSpotReportManager::addSpotReportVisualHandler ( const std::string &  s, DtSpotReportVisualHandlerCreatorInterface *    )

virtual

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

virtual void makVrf::DtVrfSpotReportManager::constructSpotReportDictionary ( )

protectedvirtual

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

virtual bool makVrf::DtVrfSpotReportManager::upgradeFromDictionary ( makVrv::DtElementDefinitionTypeManager::ElementDefinitionType  dictType, bool  force = false, const makVrv::DtUnicode &  unknownName = makVrv::DtUnicode::fromAscii("Unknown")  )

protectedvirtual

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  )

protectedvirtual

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

virtual bool makVrf::DtVrfSpotReportManager::isUnusedVisualizer ( const makVrv::DtVisualizerDefinition *  ) const

protectedvirtual

virtual void makVrf::DtVrfSpotReportManager::enableDecoration ( const std::string &  , bool    )

protectedvirtual

virtual bool makVrf::DtVrfSpotReportManager::decorationIsEnabled ( const std::string &  ) const

protectedvirtual

Member Data Documentation

boost::signal<void (const DtVrfSpotReportsSettingsRecord&)> makVrf::DtVrfSpotReportManager::signal_spotReportOptionsChanged

Sent after anything about the spot report options have changed.

boost::signal<void (bool)> makVrf::DtVrfSpotReportManager::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*)> makVrf::DtVrfSpotReportManager::signal_spotReportCreated

Signal sent when spot report visualizer is created.

makVrv::DtDe& makVrf::DtVrfSpotReportManager::myDe

protected

makVrv::DtRecordSettingsBackupInterface* makVrf::DtVrfSpotReportManager::mySettingsBackup

protected

bool makVrf::DtVrfSpotReportManager::mySignalsBlocked

protected

DtVrfSpotReportsSettingsRecord makVrf::DtVrfSpotReportManager::mySpotReportSettings

protected

bool makVrf::DtVrfSpotReportManager::mySpotReportsSelectable

protected

std::set<unsigned long> makVrf::DtVrfSpotReportManager::mySpotReportRequestIds

protected

std::set<int> makVrf::DtVrfSpotReportManager::myAlreadyRequested

protected

std::map<std::string, DtVrfSelectionFilter*> makVrf::DtVrfSpotReportManager::myModified

protected

std::set<std::string> makVrf::DtVrfSpotReportManager::myRemoved

protected

DtVrfSelectionFilter* makVrf::DtVrfSpotReportManager::myActiveEnvironmentalsFilter

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfGuiCore/vrfSpotReportManager.h