MAKVrExchange::DtStatisticsManager Class Reference

Manages statistics gathering and reporting for the broker. More...

Public Types
typedef DtStatisticsManager *(*	DtStatisticsManagerCreator )(DtPortalConnection *)

Public Member Functions
virtual	~DtStatisticsManager ()
	Virtual DTOR. More...
virtual void	setReportingInterval (DtTime interval)
	Set the reporting interval to use. More...
virtual void	setPrintStatisticsToLog (bool doit)
	Set whether statistics reports should be written to the logfile. More...
virtual void	setInteractionCount (unsigned int count)
	Set the number of interactions processed during this frame. More...
virtual unsigned int	interactionCount () const
	Get the number of interactions processed during this frame. More...
virtual void	setObjectCount (unsigned int count)
	Set the number of objects present during this frame. More...
virtual unsigned int	objectCount () const
	Get the number of objects present during this frame. More...
virtual void	tick ()
	Performs reporting if interval has elapsed. More...
Passthrough methods for the frame timer.
virtual void	startFrame ()
	Calls DtFrameTimer::markFrameStart() More...
virtual void	endFrame ()
	Calls DtFrameTimer::markFrameEnd() More...
virtual void	startSection (DtFrameTimer::FrameSectionType type)
	Calls DtFrameTimer::markStart( DtFrameTimer::FrameSectionType ) More...
virtual void	endSection (DtFrameTimer::FrameSectionType type)
	Calls DtFrameTimer::markEnd( DtFrameTimer::FrameSectionType ) More...

Static Public Member Functions
static DtStatisticsManager *	create (DtPortalConnection *pConn)
	Static creation method. More...

Static Public Attributes
static DtStatisticsManagerCreator	theStatisticsManagerCreator
	Storage for the method used to create the statistics manager. More...

Protected Types
typedef std::map < DtFrameTimer::FrameSectionType, DtString >	DisplayNamesMap
typedef std::map < DtFrameTimer::FrameSectionType, DtString >	UnitsMap

Protected Member Functions
	DtStatisticsManager (DtPortalConnection *portalConn)
	Protected CTOR (Use create()). More...
virtual DtStatisticsReportMessage	generateInitializationMessage ()
	Constructs a report for initializing the units and descriptions. More...
virtual DtStatisticsReportMessage	generateReportMessage ()
	Constructs a statistics report and sends it to the portal. More...

Protected Attributes
DisplayNamesMap	myDisplayNamesMap
UnitsMap	myUnitsMap
DtTime	myLastReportTime
DtTime	myReportingInterval
unsigned int	myObjectCount
unsigned int	myInteractionCount
bool	myPrintStatisticsToLogFlag
DtPortalConnection *	myPortalConn
DtFrameTimer *	myFrameTimer

Detailed Description

Manages statistics gathering and reporting for the broker.

Member Typedef Documentation

typedef std::map<DtFrameTimer::FrameSectionType,DtString> MAKVrExchange::DtStatisticsManager::DisplayNamesMap

protected

typedef DtStatisticsManager*(* MAKVrExchange::DtStatisticsManager::DtStatisticsManagerCreator)(DtPortalConnection *)

typedef std::map<DtFrameTimer::FrameSectionType,DtString> MAKVrExchange::DtStatisticsManager::UnitsMap

protected

Constructor & Destructor Documentation

virtual MAKVrExchange::DtStatisticsManager::~DtStatisticsManager ( )

virtual

Virtual DTOR.

MAKVrExchange::DtStatisticsManager::DtStatisticsManager ( DtPortalConnection *  portalConn )

protected

Protected CTOR (Use create()).

Use create() to ensure initialization message is properly sent.

Member Function Documentation

static DtStatisticsManager* MAKVrExchange::DtStatisticsManager::create ( DtPortalConnection *  pConn )

static

Static creation method.

Instantiates a new statistics manager and sends initialization message.

virtual void MAKVrExchange::DtStatisticsManager::endFrame ( )

virtual

Calls DtFrameTimer::markFrameEnd()

virtual void MAKVrExchange::DtStatisticsManager::endSection ( DtFrameTimer::FrameSectionType  type )

virtual

Calls DtFrameTimer::markEnd( DtFrameTimer::FrameSectionType )

virtual DtStatisticsReportMessage MAKVrExchange::DtStatisticsManager::generateInitializationMessage ( )

protectedvirtual

Constructs a report for initializing the units and descriptions.

All values in this report are initialized to zero.

virtual DtStatisticsReportMessage MAKVrExchange::DtStatisticsManager::generateReportMessage ( )

protectedvirtual

Constructs a statistics report and sends it to the portal.

Units and descriptions are not initialized in this message. The portal will interpret the empty string as an unchanged units or description.

virtual unsigned int MAKVrExchange::DtStatisticsManager::interactionCount ( ) const

virtual

Get the number of interactions processed during this frame.

virtual unsigned int MAKVrExchange::DtStatisticsManager::objectCount ( ) const

virtual

Get the number of objects present during this frame.

virtual void MAKVrExchange::DtStatisticsManager::setInteractionCount ( unsigned int  count )

virtual

Set the number of interactions processed during this frame.

Used to determine the avg interaction rate for the frame.

virtual void MAKVrExchange::DtStatisticsManager::setObjectCount ( unsigned int  count )

virtual

Set the number of objects present during this frame.

virtual void MAKVrExchange::DtStatisticsManager::setPrintStatisticsToLog ( bool  doit )

virtual

Set whether statistics reports should be written to the logfile.

virtual void MAKVrExchange::DtStatisticsManager::setReportingInterval ( DtTime  interval )

virtual

Set the reporting interval to use.

This is the amount of time between report generation and reporting to the graph in the portal.

virtual void MAKVrExchange::DtStatisticsManager::startFrame ( )

virtual

Calls DtFrameTimer::markFrameStart()

virtual void MAKVrExchange::DtStatisticsManager::startSection ( DtFrameTimer::FrameSectionType  type )

virtual

Calls DtFrameTimer::markStart( DtFrameTimer::FrameSectionType )

virtual void MAKVrExchange::DtStatisticsManager::tick ( )

virtual

Performs reporting if interval has elapsed.

Member Data Documentation

DisplayNamesMap MAKVrExchange::DtStatisticsManager::myDisplayNamesMap

protected

DtFrameTimer* MAKVrExchange::DtStatisticsManager::myFrameTimer

protected

unsigned int MAKVrExchange::DtStatisticsManager::myInteractionCount

protected

DtTime MAKVrExchange::DtStatisticsManager::myLastReportTime

protected

unsigned int MAKVrExchange::DtStatisticsManager::myObjectCount

protected

DtPortalConnection* MAKVrExchange::DtStatisticsManager::myPortalConn

protected

bool MAKVrExchange::DtStatisticsManager::myPrintStatisticsToLogFlag

protected

DtTime MAKVrExchange::DtStatisticsManager::myReportingInterval

protected

UnitsMap MAKVrExchange::DtStatisticsManager::myUnitsMap

protected

DtStatisticsManagerCreator MAKVrExchange::DtStatisticsManager::theStatisticsManagerCreator

static

Storage for the method used to create the statistics manager.

Overridden statistics manager creators can be set here in order to use a customized statistics manager. Make sure the creator is set here before the broker begins processing messages to ensure it is used.

---

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

• statisticsManager.h