makVrv::DtLocalElement Class Reference

Inheritance diagram for makVrv::DtLocalElement:

Public Member Functions
	DtLocalElement ()
virtual	~DtLocalElement ()
virtual unsigned int	encodedLength ()
	Get the encoded length of this metadata element.
virtual unsigned char *	encode (unsigned char *buffer)
	Encode the metadata element.
virtual void	decode (unsigned char *buffer, unsigned int length)
	Decode the metadata element; not curently implemented in VR-Vantage.
Public Member Functions inherited from makVrv::DtMetadataElement
	DtMetadataElement ()
	CTOR.
virtual	~DtMetadataElement ()
	DTOR.
virtual void	setPublisher (DtMetadataPublisher *publisher)
	Set the publisher that created this element.
virtual bool	timeForUpdate ()
	Get whether it is time to update this element.
virtual void	tick (double dt)
	Tick this element.
virtual void	setFrequency (double timeInSeconds)
	Specify the frequency at which this element is updated, in seconds.
virtual void	addChild (DtMetadataElement *element)
	Add a child metadata element.
virtual DtKlvKey &	key ()
	Get this metadata element's key.

Protected Member Functions
virtual void	update ()
	Update the metadata element.
Protected Member Functions inherited from makVrv::DtMetadataElement
virtual unsigned int	encodedLengthChildren ()
	Get the total encoded length of all the children of this metadata element.

Protected Attributes
unsigned char	mySequenceNumber
Protected Attributes inherited from makVrv::DtMetadataElement
DtMetadataElement *	myParent
std::vector< DtMetadataElement * >	myChildren
DtMetadataPublisher *	myPublisher
double	myLastUpdate
double	myNextUpdate
bool	myIsDirty
DtKlvKey	myKey
float	myFrequency
bool	myTimeToUpdate

Constructor & Destructor Documentation

makVrv::DtLocalElement::DtLocalElement

(

)

virtual makVrv::DtLocalElement::~DtLocalElement ( )

virtual

Member Function Documentation

virtual unsigned int makVrv::DtLocalElement::encodedLength ( )

virtual

Get the encoded length of this metadata element.

Implements makVrv::DtMetadataElement.

virtual unsigned char* makVrv::DtLocalElement::encode ( unsigned char *  buffer )

virtual

Encode the metadata element.

Implements makVrv::DtMetadataElement.

virtual void makVrv::DtLocalElement::decode ( unsigned char *  buffer, unsigned int  length  )

virtual

Decode the metadata element; not curently implemented in VR-Vantage.

Implements makVrv::DtMetadataElement.

virtual void makVrv::DtLocalElement::update ( )

protectedvirtual

Update the metadata element.

Called by tick() if timeForUpdate() is true.

Implements makVrv::DtMetadataElement.

Member Data Documentation

unsigned char makVrv::DtLocalElement::mySequenceNumber

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrvLocalMS/DtLocalElement.h