DtRangeRingsParametersPublisher Class Reference

Description: This class will look at parameter and state data to publish range rings (via the object data message) for each range ring item found. More...

Public Member Functions
	DtRangeRingsParametersPublisher (DtVrfObject *)
	CTOR.
virtual	~DtRangeRingsParametersPublisher ()
	DTOR.
virtual void	setTickRate (double, double varianceRange=1.0)
	Sets the tick rate to tick the publisher.
virtual double	tickRate () const
virtual void	tick ()
	Ticks the "publisher".
virtual void	rangeItemsFromProperties (const DtRwVariableBindings &, std::string prefix)
	Updates myRangeItems for all range item properties.

Protected Types
typedef std::map< DtString, DtRangeItem >	DtRangeItemMap

Protected Member Functions
virtual void	firstTickInit ()
	Called for first tick.
virtual void	updateRangeRings (DtRangeItemMap &, DtReaderWriter *, const DtRwPropertiesList *sectorSizes, std::string prefix)
	Adds range rings into the given vector. Prefixes names by the supplied prefix.
virtual int	fillInFrom (DtRangeItems::RangeItems &current, const DtRangeItemMap &from, int start) const
	Fills in the list from the give range rings, adding as needed.

Protected Attributes
DtRangeItemMap	myRangeItems
DtRangeItemMap	myPreviousRangeItems
bool	myFirstTick
double	myNextTickTime
double	myTickRate
DtVrfObject *	myOwner
DtClock	myClock
DtTime	myLastUpdateTime

Detailed Description

Description: This class will look at parameter and state data to publish range rings (via the object data message) for each range ring item found.

Member Typedef Documentation

typedef std::map<DtString, DtRangeItem> DtRangeRingsParametersPublisher::DtRangeItemMap

protected

Constructor & Destructor Documentation

DtRangeRingsParametersPublisher::DtRangeRingsParametersPublisher

(

DtVrfObject *

)

CTOR.

virtual DtRangeRingsParametersPublisher::~DtRangeRingsParametersPublisher ( )

virtual

DTOR.

Member Function Documentation

virtual void DtRangeRingsParametersPublisher::setTickRate ( double  , double  varianceRange = 1.0  )

virtual

Sets the tick rate to tick the publisher.

Default is -1 (fast as possible). Time is in simulation seconds

virtual double DtRangeRingsParametersPublisher::tickRate ( ) const

virtual

virtual void DtRangeRingsParametersPublisher::tick ( )

virtual

Ticks the "publisher".

Will iterate over parameter data (first time as parameter data does not change) and state data (each tick) to come up with a list of range rings.

virtual void DtRangeRingsParametersPublisher::rangeItemsFromProperties ( const DtRwVariableBindings &  , std::string  prefix  )

virtual

Updates myRangeItems for all range item properties.

virtual void DtRangeRingsParametersPublisher::firstTickInit ( )

protectedvirtual

Called for first tick.

virtual void DtRangeRingsParametersPublisher::updateRangeRings ( DtRangeItemMap &  , DtReaderWriter *  , const DtRwPropertiesList *  sectorSizes, std::string  prefix  )

protectedvirtual

Adds range rings into the given vector. Prefixes names by the supplied prefix.

virtual int DtRangeRingsParametersPublisher::fillInFrom ( DtRangeItems::RangeItems &  current, const DtRangeItemMap &  from, int  start  ) const

protectedvirtual

Fills in the list from the give range rings, adding as needed.

Member Data Documentation

DtRangeItemMap DtRangeRingsParametersPublisher::myRangeItems

protected

DtRangeItemMap DtRangeRingsParametersPublisher::myPreviousRangeItems

protected

bool DtRangeRingsParametersPublisher::myFirstTick

protected

double DtRangeRingsParametersPublisher::myNextTickTime

protected

double DtRangeRingsParametersPublisher::myTickRate

protected

DtVrfObject* DtRangeRingsParametersPublisher::myOwner

protected

DtClock DtRangeRingsParametersPublisher::myClock

protected

DtTime DtRangeRingsParametersPublisher::myLastUpdateTime

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/rangeRingsParametersPublisher.h