DtRwProperty< _RwType > Class Template Reference

Templated class that allows for the definition of a property. More...

Inheritance diagram for DtRwProperty< _RwType >:

Public Member Functions
	DtRwProperty (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	DtRwProperty (const DtString &name, const DtRwProperty &orig, DtReaderWriterRegistry *parentRegistry=0)
DtRwProperty &	operator= (const DtRwProperty &orig)
virtual	~DtRwProperty ()
virtual char *	encode (char *) const
	These methods are for network encoding/decoding for Hla encoding decoding reasons.
virtual const char *	decode (const char *)
	Decodes the variable bindings from the specified buffer.
virtual DtString	stringRep (const DtString &root="") const
virtual void	getSize (int &size) const
	Returns the size of this item, iterating over all types.
virtual int	hlaAlignment () const
	Returns hlaAlignment.
virtual const char *	propertyType () const
	Typically returns reader/writer type.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference())
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override to allow a variable to be assigned to a property of derived type.
virtual bool	merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >())
	In this case replace does not matter – will replace value regardless.
virtual void	recordUpdateTime () const
	Stamps the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Returns true if an update occurred since the specified time.
virtual void	reset ()
	Override to clear out variable value.
virtual DtReaderWriter *	readerWriter ()
virtual const DtReaderWriter *	readerWriter () const
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual bool	isPublished () const
	Whether this property should be published.
virtual void	setIsPublished (bool isPub)
virtual unsigned	disRecordType () const
	If this property is published, which DIS record type should it use.
virtual void	setDisRecordType (unsigned recType)
Public Member Functions inherited from DtPropertyInterface
virtual	~DtPropertyInterface ()
int	getSize () const
virtual bool	isSimilarProperty (const DtPropertyInterface *rhs) const
	Returns true if the readerWriterType is the same.
virtual bool	isPublishedArg (DtlObjPtr arg, unsigned &disVarRecType) const
	Tests whether the argument specified indicates this property should be published.

Protected Attributes
DtClock	myClock
DtTime	myUpdateTime
bool	myIsPublished
unsigned	myDisRecordType

Private Member Functions
	DtRwProperty ()
	Not implemented.

Additional Inherited Members
Public Types inherited from DtPropertyInterface
enum	MergeFlags {   Replace = 0x00000001, MinimalSimilarityCheck = 0x00000002, RollUp = 0x00000004, AddMissing = 0x00000008,   KeepIsPublished = 0x00000010 }

Detailed Description

template<typename _RwType>
class DtRwProperty< _RwType >

Templated class that allows for the definition of a property.

Only templates of this type can be added into the DtRwProperties class.

Constructor & Destructor Documentation

template<typename _RwType>

DtRwProperty< _RwType >::DtRwProperty ( )

private

Not implemented.

template<typename _RwType>

DtRwProperty< _RwType >::DtRwProperty	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

template<typename _RwType>

DtRwProperty< _RwType >::DtRwProperty	(	const DtString &	name,
		const DtRwProperty< _RwType > &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

template<typename _RwType>

virtual DtRwProperty< _RwType >::~DtRwProperty ( )

virtual

Member Function Documentation

template<typename _RwType>

DtRwProperty& DtRwProperty< _RwType >::operator=

(

const DtRwProperty< _RwType > &

orig

)

template<typename _RwType>

virtual char* DtRwProperty< _RwType >::encode ( char *  ) const

virtual

These methods are for network encoding/decoding for Hla encoding decoding reasons.

Implemented at templated rw level Encodes the variable bindings into the supplied buffer

Implements DtPropertyInterface.

Reimplemented in DtRwPropertyWithThreshold< _RwType >, DtRwPropertyWithThreshold< DtRwInt >, DtRwPropertyWithThreshold< DtRwInt8 >, DtRwPropertyWithThreshold< DtRwInt16 >, DtRwPropertyWithThreshold< DtRwReal >, DtRwPropertyWithThreshold< DtRwVector >, DtRwPropertyWithThreshold< DtRwReal64 >, DtRwPropertyWithThreshold< DtRwOffsetVector >, DtRwPropertyWithThreshold< DtRwInt32 >, and DtRwPropertyWithThreshold< DtRwReal32 >.

template<typename _RwType>

virtual const char* DtRwProperty< _RwType >::decode ( const char *  )

virtual

Decodes the variable bindings from the specified buffer.

Implements DtPropertyInterface.

template<typename _RwType>

virtual DtString DtRwProperty< _RwType >::stringRep ( const DtString &  root = "" ) const

virtual

Implements DtPropertyInterface.

template<typename _RwType>

virtual void DtRwProperty< _RwType >::getSize ( int &  size ) const

virtual

Returns the size of this item, iterating over all types.

Implements DtPropertyInterface.

template<typename _RwType>

virtual int DtRwProperty< _RwType >::hlaAlignment ( ) const

virtual

Returns hlaAlignment.

Implements DtPropertyInterface.

template<typename _RwType>

virtual const char* DtRwProperty< _RwType >::propertyType ( ) const

virtual

Typically returns reader/writer type.

Implements DtPropertyInterface.

Reimplemented in DtRwPropertiesRangeItem.

template<typename _RwType>

virtual void DtRwProperty< _RwType >::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  variableBindings = DtReaderWriter::nullVariableReference()  )

virtual

template<typename _RwType>

virtual DtlObjPtr DtRwProperty< _RwType >::getData ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Override to allow a variable to be assigned to a property of derived type.

Implements DtPropertyInterface.

template<typename _RwType>

virtual bool DtRwProperty< _RwType >::merge ( const DtPropertyInterface &  target, MergeFlags  , const DtMergePath &  path = DtMergePath(), const std::set< DtString > &  ignore = std::set< DtString >()  )

virtual

In this case replace does not matter – will replace value regardless.

Implements DtPropertyInterface.

template<typename _RwType>

virtual DtReaderWriter* DtRwProperty< _RwType >::readerWriter ( )

virtual

Returns a ReaderWriter pointer of the property.

Implements DtPropertyInterface.

template<typename _RwType>

virtual const DtReaderWriter* DtRwProperty< _RwType >::readerWriter ( ) const

virtual

Implements DtPropertyInterface.

template<typename _RwType>

virtual DtPropertyInterface* DtRwProperty< _RwType >::property ( )

virtual

Returns a PropertyInterface pointer of the ReaderWriter.

template<typename _RwType>

virtual const DtPropertyInterface* DtRwProperty< _RwType >::property ( ) const

virtual

template<typename _RwType>

virtual void DtRwProperty< _RwType >::recordUpdateTime ( ) const

virtual

Stamps the time when updated.

template<typename _RwType>

virtual bool DtRwProperty< _RwType >::wasUpdatedSince ( DtTime  t ) const

virtual

Returns true if an update occurred since the specified time.

Reimplemented in DtRwPropertyWithThreshold< _RwType >, DtRwPropertyWithThreshold< DtRwInt >, DtRwPropertyWithThreshold< DtRwInt8 >, DtRwPropertyWithThreshold< DtRwInt16 >, DtRwPropertyWithThreshold< DtRwReal >, DtRwPropertyWithThreshold< DtRwVector >, DtRwPropertyWithThreshold< DtRwReal64 >, DtRwPropertyWithThreshold< DtRwOffsetVector >, DtRwPropertyWithThreshold< DtRwInt32 >, and DtRwPropertyWithThreshold< DtRwReal32 >.

template<typename _RwType>

virtual bool DtRwProperty< _RwType >::isPublished ( ) const

virtual

Whether this property should be published.

Implements DtPropertyInterface.

template<typename _RwType>

virtual void DtRwProperty< _RwType >::setIsPublished ( bool  isPub )

virtual

Implements DtPropertyInterface.

template<typename _RwType>

virtual unsigned DtRwProperty< _RwType >::disRecordType ( ) const

virtual

If this property is published, which DIS record type should it use.

Default is 0, which indicates that the normal VRF generic attribute record type should be used.

Implements DtPropertyInterface.

template<typename _RwType>

virtual void DtRwProperty< _RwType >::setDisRecordType ( unsigned  recType )

virtual

Implements DtPropertyInterface.

template<typename _RwType>

virtual void DtRwProperty< _RwType >::reset ( )

virtual

Override to clear out variable value.

Implements DtPropertyInterface.

Member Data Documentation

template<typename _RwType>

DtClock DtRwProperty< _RwType >::myClock

protected

template<typename _RwType>

DtTime DtRwProperty< _RwType >::myUpdateTime

mutableprotected

template<typename _RwType>

bool DtRwProperty< _RwType >::myIsPublished

protected

template<typename _RwType>

unsigned DtRwProperty< _RwType >::myDisRecordType

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-6-branch/include/vrfutil/propertyInterface.h