TestStateRepository Class Reference

Define the TestStateRepository class. More...

Inheritance diagram for TestStateRepository:

Collaboration diagram for TestStateRepository:

Public Member Functions
	TestStateRepository ()
	Default constructor.
virtual	~TestStateRepository ()
	Destructor.
	TestStateRepository (const TestStateRepository &orig)
	Copy constructor.
TestStateRepository &	operator= (const TestStateRepository &orig)
	Assignment operator.
virtual DtStateRepository *	clone (bool copy) const
	Return a copy/empty object of the same type as this. Required.
virtual void	printData () const
	Prints the internal representation of the attributes to the DtInfo stream.
virtual void	printDataToStream (std::ostream &stream) const
	prints the internal representation of the attributes to the specified stream.
virtual void	setNumber (int num)
	Inspector and mutator functions for the object's state data.
virtual int	number () const
virtual void	setVector (const DtVector &vec)
	Set/Get the attribute named "Vector".
virtual const DtVector &	vector () const
Public Member Functions inherited from DtStateRepository
	DtStateRepository ()
	default constructor
	DtStateRepository (const DtStateRepository &orig)
	copy constructor
virtual	~DtStateRepository ()
	destructor
DtStateRepository &	operator= (const DtStateRepository &orig)
	assignment operator
virtual void	setGlobalId (const DtString &id)
	Get/Set global identifier, or name.
virtual const DtString &	globalId () const
virtual void	setLocalId (const DtObjectId &id)
	Get/Set local identifier, or handle.
virtual const DtObjectId &	localId () const
virtual bool	publishesAttribute (const RTI::AttributeHandle &val) const
	Returns true if the attribute is published.
virtual void	setAttributeByHandle (const RTI::AttributeHandle &attrHdl, const char *attrValue, unsigned size)
	Set the attribute with the given handle.
virtual const char *	getAttributeByHandle (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle.
virtual void	setAttributeByName (const DtString &attrName, const char *attrValue, unsigned size, DtHlaObject *hlaObj)
	Set the attribute with the given name. Note that in order to do this you must provide a DtHlaObject.
virtual const char *	getAttributeByName (const DtString &attrName, unsigned &size, DtHlaObject *hlaObj) const
	Get a pointer to attribute value for the attribute with the given name.
virtual const char *	getAttributeByHandleIfUpdated (const RTI::AttributeHandle &attrHdl, unsigned &size) const
	Get a pointer to attribute value for the attribute with the given handle, but only if it's been updated since the last time we read it.
virtual DtStateRepositoryExtension *	stateRepositoryExtension (DtString srExtName) const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.
virtual std::vector< DtString >	stateRepositoryExtensionNames () const
	Returns a set of the registered state repository extension names.
virtual void	setStateRepositoryExtensions (std::map< DtString, DtStateRepositoryExtension * > extensions)
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.
virtual const std::map < DtString, DtStateRepositoryExtension * >	stateRepositoryExtensions () const
	Returns pointer to a DtStateRepositoryExtension object with the given name Returns 0 if no extension with given name is found.

Static Public Member Functions
static DtStateRepository *	create ()
	Create and return a new TestStateRepository.
Static Public Member Functions inherited from DtStateRepository
static bool	addStateRepositoryExtension (DtString srExtName, DtSrExtCreatorFnc fnc)
	The following functions are for extending state repositories through State Repository Extension classes.

Protected Attributes
int	myNum
	Here, we store the actual data values, in native representation.
DtVector	myVec

Additional Inherited Members
Public Types inherited from DtStateRepository
typedef std::map< DtString, DtStateRepositoryExtension * >	DtStateRepositoryExtensionMap
Public Attributes inherited from DtStateRepository
DtString	myGlobalId
DtObjectId	myLocalId
std::map< RTI::AttributeHandle, DtGenericAttributeInfo * >	myAttributesByHandle
	Attributes by handle.
DtStateRepositoryExtensionMap	myStateRepositoryExtensionMap
Static Public Attributes inherited from DtStateRepository
static std::map< DtString, DtSrExtCreatorFnc >	theStateRepositoryExtensionCreatorMap

Detailed Description

Define the TestStateRepository class.

Instances of this class will be used to store the state of a "Test" object. It has two attributes: "Number", which is represented by a 32-bit integer, and "Vector", which is represented by an array of three 64-bit floating point numbers (doubles).

Constructor & Destructor Documentation

TestStateRepository::TestStateRepository

(

)

Default constructor.

virtual TestStateRepository::~TestStateRepository ( )

virtual

Destructor.

TestStateRepository::TestStateRepository

(

const TestStateRepository &

orig

)

Copy constructor.

Member Function Documentation

virtual DtStateRepository* TestStateRepository::clone ( bool  copy ) const

virtual

Return a copy/empty object of the same type as this. Required.

Reimplemented from DtStateRepository.

static DtStateRepository* TestStateRepository::create ( )

static

Create and return a new TestStateRepository.

Basically a wrapper around the constructor, since constructors can not be passed around as function pointers.

virtual int TestStateRepository::number ( ) const

virtual

TestStateRepository& TestStateRepository::operator=

(

const TestStateRepository &

orig

)

Assignment operator.

virtual void TestStateRepository::printData ( ) const

virtual

Prints the internal representation of the attributes to the DtInfo stream.

Reimplemented from DtStateRepository.

virtual void TestStateRepository::printDataToStream ( std::ostream &  stream ) const

virtual

prints the internal representation of the attributes to the specified stream.

Reimplemented from DtStateRepository.

virtual void TestStateRepository::setNumber ( int  num )

virtual

---

Inspector and mutator functions for the object's state data.

These will look different for each DtStateRepository subclass. None are required by VR-Link, but the class will not be particularly useful without a way to get data in and out in a typesafe manner.

---

Set/Get the attribute named "Number"

virtual void TestStateRepository::setVector ( const DtVector &  vec )

virtual

Set/Get the attribute named "Vector".

virtual const DtVector& TestStateRepository::vector ( ) const

virtual

Member Data Documentation

int TestStateRepository::myNum

protected

Here, we store the actual data values, in native representation.

DtVector TestStateRepository::myVec

protected

---

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

• testSR.h