Interface class used to define minimal interface for a property. More...

Inheritance diagram for DtPropertyInterface:

Public Types
enum	MergeFlags { Replace = 0x00000001, MinimalSimilarityCheck = 0x00000002, RollUp = 0x00000004, AddMissing = 0x00000008 }

Public Member Functions
virtual	~DtPropertyInterface ()
virtual char *	encode (char *) const =0
	These methods are for network encoding/decoding for Hla encoding decoding reasons.
virtual const char *	decode (const char *)=0
	Decodes the variable bindings from the specified buffer.
virtual void	getSize (int &size) const =0
	Returns the size of this item, iterating over all types.
virtual int	hlaAlignment () const =0
	Returns hlaAlignment.
virtual const char *	propertyType () const =0
	Typically returns reader/writer type.
virtual DtString	stringRep (const DtString &root="") const =0
int	getSize () const
virtual bool	isSimilarProperty (const DtPropertyInterface *rhs) const
	Returns true if the readerWriterType is the same.
virtual bool	merge (const DtPropertyInterface &target, MergeFlags, const DtMergePath &path=DtMergePath(), const std::set< DtString > &ignore=std::set< DtString >())=0
	Takes the contents of the supplied properties and merges with the following rules if replace is false: 1) If the same named property of the same type (and prototype and key) exists regardless of what the contents are in this property, it is replaced with the contents of the target 2) If a property in the target does not exist in source, it is not merged in 3) All other items are kept in the source.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)=0
	Override to allow a variable to be assigned to a property of derived type.
virtual void	reset ()=0
	Override to clear out variable value.

virtual DtReaderWriter *	readerWriter ()=0
virtual const DtReaderWriter *	readerWriter () const =0

Detailed Description

Interface class used to define minimal interface for a property.

Member Enumeration Documentation

enum DtPropertyInterface::MergeFlags

Enumerator:

Replace
MinimalSimilarityCheck	Replace contents wholesale.
RollUp	Do not do a stringent compare on items – allows for partial item replacement.
AddMissing	This will add up numerical items and keep string items if the values are similar, else it will remove. Any item that exists in the to be merged that does not exist in the source will be added as long as the structures are similar, else they will be ignored

Constructor & Destructor Documentation

virtual DtPropertyInterface::~DtPropertyInterface ( )

inlinevirtual

Member Function Documentation

virtual char* DtPropertyInterface::encode ( char * ) const

pure 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

Implemented in DtRwPropertyWithThreshold< _RwType >, DtRwPropertyWithThreshold< DtRwInt >, DtRwPropertyWithThreshold< DtRwReal >, DtRwPropertyWithThreshold< DtRwVector >, DtRwPropertyWithThreshold< DtRwOffsetVector >, DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, DtRwProperties, and DtRwPropertiesList.

Referenced by DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >::encodeProperties().

virtual const char* DtPropertyInterface::decode ( const char * )

pure virtual

Decodes the variable bindings from the specified buffer.

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, DtRwProperties, and DtRwPropertiesList.

Referenced by DtRemoteExtendedPropertiesNetInterface< DtVrfRemoteEnvironmentalNetInterface, DtControlObjectRepository >::updatePropertyAttributesFromNet().

virtual void DtPropertyInterface::getSize ( int & size ) const

pure virtual

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

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, DtRwPropertiesList, and DtRwProperties.

Referenced by DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >::encodeProperties().

virtual int DtPropertyInterface::hlaAlignment ( ) const

pure virtual

Returns hlaAlignment.

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, and DtRwProperties.

virtual const char* DtPropertyInterface::propertyType ( ) const

pure virtual

Typically returns reader/writer type.

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, DtRwProperties, and DtRwPropertiesRangeItem.

Referenced by isSimilarProperty().

virtual DtString DtPropertyInterface::stringRep ( const DtString & root = "" ) const

pure virtual

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, and DtRwProperties.

int DtPropertyInterface::getSize ( ) const

inline

virtual DtReaderWriter* DtPropertyInterface::readerWriter ( )

pure virtual

Returns a ReaderWriter pointer of the property. If property is not a ReaderWriter, this should be overridden to return 0.

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, and DtRwProperties.

Referenced by DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >::encodeProperties().

virtual const DtReaderWriter* DtPropertyInterface::readerWriter ( ) const

pure virtual

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, and DtRwProperties.

virtual bool DtPropertyInterface::isSimilarProperty ( const DtPropertyInterface * rhs ) const

inlinevirtual

Returns true if the readerWriterType is the same.

Subclasses can do extra checking

Reimplemented in DtRwPropertiesList, DtRwPropertiesMap, and DtRwPropertiesStructure.

References propertyType().

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

pure virtual

Takes the contents of the supplied properties and merges with the following rules if replace is false: 1) If the same named property of the same type (and prototype and key) exists regardless of what the contents are in this property, it is replaced with the contents of the target 2) If a property in the target does not exist in source, it is not merged in 3) All other items are kept in the source.

If replace is true, any matching items are replaced by their target. This will add/remove properties

This is a non-recursive function. It only looks at top level property items.

Returns true if merge was successful

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, and DtRwProperties.

virtual DtlObjPtr DtPropertyInterface::getData	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

pure virtual

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

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, DtRwPropertiesList, and DtRwProperties.

virtual void DtPropertyInterface::reset ( )

pure virtual

Override to clear out variable value.

Implemented in DtRwProperty< _RwType >, DtRwProperty< DtRwString >, DtRwProperty< DtRwInt >, DtRwProperty< DtRwReal >, DtRwProperty< DtRwVector >, DtRwProperty< DtRwBoolean >, DtRwProperty< DtRwOffsetVector >, and DtRwProperties.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/propertyInterface.h

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation