makVrf::DtVrfSpotReportManager Class Reference

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	getSplitRecord (std::vector< DtVrfSpotReportsSettingsRecord > &rec, std::vector< std::string > &fileNames)
virtual void	addRecords (DtVrfSpotReportsSettingsRecord &recs, DtVrfSpotReportsSettingsRecord &combinedRec)
virtual void	setFromRecord (const DtVrfSpotReportsSettingsRecord &rec, bool updateFilter=true)
virtual void	requestSpotReports ()
virtual void	requestSpotReportsFor (std::vector< int > forces)
virtual void	showPerspectiveForForce (const std::string &, bool autoSave=true)
virtual void	setDisplayReportingName (bool)
virtual bool	displayReportingName () const
virtual void	setDisplayObservedName (bool)
virtual bool	displayObservedName () const
virtual void	setDisplayTimeSinceLastReport (bool)
virtual bool	displayTimeSinceLastReport () const
virtual void	setDisplayLastContact (bool)
virtual bool	displayLastContact () const
virtual void	setDisplayLocation (bool)
virtual bool	displayLocation () const
virtual void	setDisplayVelocity (bool)
virtual bool	displayVelocity () const
virtual void	setDisplayContactRadius (bool)
virtual bool	displayContactRadius () const
virtual void	setDisplayContactRadiusIndicator (bool)
virtual bool	displayContactRadiusIndicator () const
virtual void	setDisplayHeading (bool)
virtual bool	displayHeading () const
virtual void	setDisplayEntityType (bool)
virtual bool	displayEntityType () const
virtual void	setDisplayHeadingIndicator (bool)
virtual bool	displayHeadingIndicator () const
virtual void	setDisplayVelocityIndicator (bool)
virtual bool	displayVelocityIndicator () const
virtual void	setApplyToEnvironmentals (bool)
virtual bool	applyToEnvironmentals () const
virtual void	setShowOnlyActiveEnvironmentals (bool)
virtual bool	showOnlyActiveEnvironmentals () const
virtual void	setShowTrackHistories (bool)
virtual bool	showTrackHistories () const
virtual void	setShowTrackHistoriesForSelected (bool)
virtual bool	showTrackHistoriesForSelected () const
virtual void	setNumberOfTrackReports (int)
virtual int	numberOfTrackReports () const
const std::vector< int > &	certaintyLevels () const
void	setCertaintyLevels (const std::vector< int > &)
void	setCertaintyLevel (int level, int time)
virtual bool	showSpotReportsForForce (int) const
virtual bool	showGroundTruthForForce (int) const
virtual void	setSpotReportGatherTime (double)
virtual double	spotReportGatherTime () const
virtual void	setKeepReportsForTimePeriod (bool)
virtual bool	keepReportsForTimePeriod () const
virtual void	setKeepReportsForTime (int)
virtual int	keepReportsForTime () const
virtual void	addShowSpotReportFor (int)
virtual void	removeShowSpotReportFor (int)
void	setShowSpotReportsForForce (const std::vector< int > &)
const std::vector< int >	spotReportsFor () const
virtual bool	isSpotReport (makVrv::DtUniqueID id) 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)
virtual void	setSpotReportsGloballyEnabled (bool enabled)
void	setSystemEnabled (bool)
bool	systemEnabled () const
virtual void	loadDefaults (bool fromFactory=false)
virtual void	saveAsDefaults ()
const makVrv::DtRecordSettingsBackupInterface *	settingsBackup () const
makVrv::DtRecordSettingsBackupInterface *	settingsBackup ()
void	exportSettings (const std::string &fileName)
void	importSettings (const std::string &fileName)
virtual void	processReceiveSpotReport (const DtVrfObjectMessage *msg)
virtual void	processReceiveSpotReports (const DtVrfObjectMessage *msg)
virtual bool	addOrUpdateSpotReport (const std::string &type, void *, const DtUUID &)
virtual void	addFogOfWarFilter (const DtVrfSelectionFilter &)
virtual void	removeFogOfWarFilter (const std::string &)
virtual bool	passesFogOfWarFilters (const makVrv::DtVrlinkSimulatedBaseState *, const DtVrfObjectDataState *objState=0) const
virtual bool	passesFogOfWarFilters (makVrv::DtUniqueID) const
virtual bool	passesFogOfWarFilters (const DtUUID &) const
virtual bool	canShowScenarioEvent (makVrv::DtUniqueID) const
virtual bool	blockSignals (bool)
virtual void	addSpotReportDataHandler (const std::string &s, DtSpotReportDataHandlerCreatorInterface *)
virtual void	removeSpotReport (makVrv::DtUniqueID)
virtual void	removeSpotReportDataHandler (const std::string &s)
virtual void	setSpotReportsSelectable (bool)
virtual bool	spotReportsSelectable () const
virtual int	certaintyLevelForTime (double d) const
virtual void	reset ()
virtual void	addSpotReportVisualHandler (const std::string &s, DtExternalDataVisualHandlerCreatorInterface *)
virtual void	removeSpotReportVisualHandler (const std::string &s)
virtual bool	passesAllFilters (const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *s) const
virtual bool	passesAllFilters (makVrv::DtUniqueID id) const
Public Member Functions inherited from makVrv::DtVirtualBaseClass
	DtVirtualBaseClass ()
virtual	~DtVirtualBaseClass ()

Static Public Member Functions
static DtVrfSpotReportManager &	instance (makVrv::DtDe &de)

Public Attributes
boost::signals2::signal< void(const DtVrfSpotReportsSettingsRecord &)>	signal_spotReportOptionsChanged
boost::signals2::signal< void(bool)>	signal_spotReportsSelectableChanged
boost::signals2::signal< void(bool)>	signal_showTrackHistoryForSelectedItemsChanged
boost::signals2::signal< void(int)>	signal_numberOfTrackReportsChanged
boost::signals2::signal< void(bool)>	signal_keepReportsForTimePeriodChanged
boost::signals2::signal< void(int)>	signal_keepReportsForTimeChanged

Protected Member Functions
virtual void	enableDecoration (const std::string &, bool)
virtual bool	decorationIsEnabled (const std::string &) const
virtual void	slot_observerModeAdded (int)
virtual void	setTrackHistoriesVisible (bool)
virtual void	slot_organizedCategoriesInitialized ()
virtual void	showOnlyActiveEnvironmentalsChanged ()

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
boost::signals2::scoped_connection	myShowOnlyActiveEnvironmentalsChangedConnection
DtVrfSelectionFilter *	myActiveEnvironmentalsFilter
makVrv::DtSignalConnectionManager	myConnections
DtEntityType	myStealthType

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::getSplitRecord ( std::vector< DtVrfSpotReportsSettingsRecord > &  rec, std::vector< std::string > &  fileNames  )

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

virtual void makVrf::DtVrfSpotReportManager::addRecords ( DtVrfSpotReportsSettingsRecord &  recs, DtVrfSpotReportsSettingsRecord &  combinedRec  )

inlinevirtual

To support writing element definitions in folders as multiple files not implemented.

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.

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

virtual

Calls to current settings record to store the values. Will back up and auto save as necessary.

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

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

virtual

Whether or not to show track histories.

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

virtual

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

virtual

Whether or not to show track history lines for objects that are selected. Except for length, settings for track history are the same as entity track history lines.

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

virtual

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

virtual

The number of track reports to keep in memory for the track report history (default is 10)

virtual int makVrf::DtVrfSpotReportManager::numberOfTrackReports ( ) const

virtual

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::setKeepReportsForTimePeriod ( bool  )

virtual

Whether or not to keep track reports for a given length of time.

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

virtual

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

virtual

If keeping reports for a time period, how long (in seconds) to keep the report around for. Default is 2 minutes.

virtual int makVrf::DtVrfSpotReportManager::keepReportsForTime ( ) 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 bool makVrf::DtVrfSpotReportManager::isSpotReport ( makVrv::DtUniqueID  id ) const

virtual

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 DtVrfObjectDataState *  objState = 0  ) 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::passesFogOfWarFilters ( const DtUUID &  ) 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, DtExternalDataVisualHandlerCreatorInterface *    )

virtual

Once added, the external data 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 bool makVrf::DtVrfSpotReportManager::passesAllFilters ( const makVrv::DtStateView< makVrv::DtVrlinkSimulatedBaseState > *  s ) const

virtual

Checks global filters and accounts for spot/tdl reports.

virtual bool makVrf::DtVrfSpotReportManager::passesAllFilters ( makVrv::DtUniqueID  id ) const

virtual

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

protectedvirtual

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

protectedvirtual

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

protectedvirtual

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

protectedvirtual

If you call this directly it will not change flags internally, so, if new modes are added and this is true, that mode will not show track histories.

virtual void makVrf::DtVrfSpotReportManager::slot_organizedCategoriesInitialized ( )

protectedvirtual

virtual void makVrf::DtVrfSpotReportManager::showOnlyActiveEnvironmentalsChanged ( )

protectedvirtual

Member Data Documentation

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

Sent after anything about the spot report options have changed.

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

Sent when whether or not track history for selected items have changed.

boost::signals2::signal<void (int)> makVrf::DtVrfSpotReportManager::signal_numberOfTrackReportsChanged

Sent when when the number of track reports to store have changed.

boost::signals2::signal<void (bool)> makVrf::DtVrfSpotReportManager::signal_keepReportsForTimePeriodChanged

Sent when when the way to time out reports have changed.

boost::signals2::signal<void (int)> makVrf::DtVrfSpotReportManager::signal_keepReportsForTimeChanged

Sent when when the time to keep reports has changed. Only sent if keeping reports for time period.

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

boost::signals2::scoped_connection makVrf::DtVrfSpotReportManager::myShowOnlyActiveEnvironmentalsChangedConnection

protected

DtVrfSelectionFilter* makVrf::DtVrfSpotReportManager::myActiveEnvironmentalsFilter

protected

makVrv::DtSignalConnectionManager makVrf::DtVrfSpotReportManager::myConnections

protected

DtEntityType makVrf::DtVrfSpotReportManager::myStealthType

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfGuiCore/vrfSpotReportManager.h