DtReaderWriterRegistry Class Reference

Public Member Functions
	DtReaderWriterRegistry ()
	default and real constructor
	DtReaderWriterRegistry (const DtReaderWriterRegistry &orig)
	copy constructor; copies localDataFlag only.
DtReaderWriterRegistry &	operator= (const DtReaderWriterRegistry &orig)
	assignment operator
	~DtReaderWriterRegistry ()
	destructor
bool	localData () const
	Indicates whether or not there is any local data; clear (false) by default.
void	setLocalData ()
void	clearLocalData ()
void	addEntry (const DtSymbolString &keyword, DtReaderWriter *const rw)
	Adds an entry with a DtReaderWriter for the given keyword.
void	insertEntry (int index, DtReaderWriter *const rw)
void	addEntryBefore (const DtSymbolString &keyword, DtReaderWriter *const rw, const DtString &addBefore)
void	addEntryBefore (const DtSymbolString &keyword, DtReaderWriter *const rw, DtReaderWriter *const addBefore)
void	addEntryAfter (const DtSymbolString &keyword, DtReaderWriter *const rw, const DtString &addAfter)
void	addEntryAfter (const DtSymbolString &keyword, DtReaderWriter *const rw, DtReaderWriter *const addAfter)
void	removeEntry (const DtSymbolString &keyword)
	Removes the entry for the given keyword.
void	removeEntry (DtReaderWriter *const rw)
void	removeEntry (const DtReaderWriter *const rw)
void	removeEntry (int)
DtReaderWriter *const	readerWriter (const DtString &keyword)
	Returns the DtReaderWriter for the indicated keyword.
void	putSelf (FILE *fp, int indentLevel, bool writeUnspecified, const DtFilename &path)
void	getSelf (DtlObjPtr args, const std::vector< DtFilename > &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse)
	Iterates over list of entries and calls setValueSpecified() on each item.
const std::vector < DtReaderWriterRegistryData * > &	registryData () const
std::vector < DtReaderWriterRegistryData * > &	registryData ()
virtual DtReaderWriterRegistryData *	find (const DtString &keyword) const
	Given a keyword, returns the registry item that matches that keyword.
virtual DtReaderWriterRegistryData *	findByName (const DtString &name) const
	Given a name, returns the registry item that has a name that matches that name.
virtual void	clear ()
	Clears out all registry and variable bindings data.
virtual DtRwVariableBindings *	variableBindings ()
virtual const DtRwVariableBindings *	variableBindings () const
virtual const DtReaderWriter *	findVariableBinding (const DtString &rwType, const DtString &variableName) const
virtual DtReaderWriter *	findVariableBinding (const DtString &rwType, const DtString &variableName)
virtual void	setVariableBindings (const DtRwVariableBindings *newBindings)
	Sets local variable bindings to the specified value.
virtual DtReaderWriter *	addVariableBinding (const DtString &variableType, const DtString &variableName)
	Adds a new variable binding to this registry.
bool	operator== (const DtReaderWriterRegistry &) const
bool	operator!= (const DtReaderWriterRegistry &) const

Static Public Attributes
static const DtString	theVariableBindingsName

Protected Attributes
std::vector < DtReaderWriterRegistryData * >	myData
	virtual DtListItem * lookup(const DtSymbolString &keyword); virtual DtListItem * lookup(DtReaderWriter * const rw);
bool	myLocalDataFlag
DtRwVariableBindings *	myVariableBindings

Detailed Description

Examples using DtReaderWriterRegistry include

• addEntity
• addPSR
• addSimCommandSim
• decideToGiveUpTask
• extendStateRepository

Constructor & Destructor Documentation

DtReaderWriterRegistry::DtReaderWriterRegistry

(

)

default and real constructor

DtReaderWriterRegistry::DtReaderWriterRegistry

(

const DtReaderWriterRegistry &

orig

)

copy constructor; copies localDataFlag only.

DtReaderWriterRegistry::~DtReaderWriterRegistry

(

)

destructor

Member Function Documentation

DtReaderWriterRegistry& DtReaderWriterRegistry::operator=

(

const DtReaderWriterRegistry &

orig

)

assignment operator

bool DtReaderWriterRegistry::localData

(

)

const

Indicates whether or not there is any local data; clear (false) by default.

When true, including DtReaderWriter will call putData/getData. Otherwise, will just call putSelf/getSelf for each registered item.

void DtReaderWriterRegistry::setLocalData

(

)

void DtReaderWriterRegistry::clearLocalData

(

)

void DtReaderWriterRegistry::addEntry	(	const DtSymbolString &	keyword,
		DtReaderWriter *const	rw
	)

Adds an entry with a DtReaderWriter for the given keyword.

An optional DtList of DtString* keyword aliases may be specified.

Referenced by DtVariableParameterReaderWriter< _Container >::createRwStructure().

void DtReaderWriterRegistry::insertEntry	(	int	index,
		DtReaderWriter *const	rw
	)

void DtReaderWriterRegistry::addEntryBefore	(	const DtSymbolString &	keyword,
		DtReaderWriter *const	rw,
		const DtString &	addBefore
	)

void DtReaderWriterRegistry::addEntryBefore	(	const DtSymbolString &	keyword,
		DtReaderWriter *const	rw,
		DtReaderWriter *const	addBefore
	)

void DtReaderWriterRegistry::addEntryAfter	(	const DtSymbolString &	keyword,
		DtReaderWriter *const	rw,
		const DtString &	addAfter
	)

void DtReaderWriterRegistry::addEntryAfter	(	const DtSymbolString &	keyword,
		DtReaderWriter *const	rw,
		DtReaderWriter *const	addAfter
	)

void DtReaderWriterRegistry::removeEntry

(

const DtSymbolString &

keyword

)

Removes the entry for the given keyword.

Referenced by DtVariableParameterReaderWriter< _Container >::createRwStructure().

void DtReaderWriterRegistry::removeEntry

(

DtReaderWriter *const

rw

)

void DtReaderWriterRegistry::removeEntry

(

const DtReaderWriter *const

rw

)

void DtReaderWriterRegistry::removeEntry

(

int

)

DtReaderWriter* const DtReaderWriterRegistry::readerWriter

(

const DtString &

keyword

)

Returns the DtReaderWriter for the indicated keyword.

void DtReaderWriterRegistry::putSelf	(	FILE *	fp,
		int	indentLevel,
		bool	writeUnspecified,
		const DtFilename &	path
	)

void DtReaderWriterRegistry::getSelf	(	DtlObjPtr	args,
		const std::vector< DtFilename > &	searchPaths,
		const DtVariableBindingsList &	variableBindings
	)

virtual void DtReaderWriterRegistry::setValueSpecified ( bool  specified, bool  recurse  )

virtual

Iterates over list of entries and calls setValueSpecified() on each item.

The specified flags are used for optional values. Objects are marked as specified if read (by getSelf) or set through a mutator and unspecified objects are not written. If recurse is true, it will recursively call setValueSpecified() over the structure. If recurse is false, the specified flag is only set the specified flag in the immediate members in myData.

const std::vector< DtReaderWriterRegistryData * > & DtReaderWriterRegistry::registryData ( ) const

inline

References myData.

Referenced by DtVariableParameterReaderWriter< _Container >::createRwStructure(), DtLocalExtendedPropertiesNetInterface< DtSimLocalControlObjectNetInterface, DtControlObjectRepository >::encodeProperties(), makVrf::DtSetStatePropertyDialog::setupGui(), and DtRemoteExtendedPropertiesNetInterface< DtVrfRemoteEnvironmentalNetInterface, DtControlObjectRepository >::updatePropertyAttributesFromNet().

std::vector< DtReaderWriterRegistryData * > & DtReaderWriterRegistry::registryData ( )

inline

References myData.

virtual DtReaderWriterRegistryData* DtReaderWriterRegistry::find ( const DtString &  keyword ) const

virtual

Given a keyword, returns the registry item that matches that keyword.

virtual DtReaderWriterRegistryData* DtReaderWriterRegistry::findByName ( const DtString &  name ) const

virtual

Given a name, returns the registry item that has a name that matches that name.

virtual void DtReaderWriterRegistry::clear ( )

virtual

Clears out all registry and variable bindings data.

virtual DtRwVariableBindings* DtReaderWriterRegistry::variableBindings ( )

virtual

virtual const DtRwVariableBindings* DtReaderWriterRegistry::variableBindings ( ) const

virtual

virtual const DtReaderWriter* DtReaderWriterRegistry::findVariableBinding ( const DtString &  rwType, const DtString &  variableName  ) const

virtual

virtual DtReaderWriter* DtReaderWriterRegistry::findVariableBinding ( const DtString &  rwType, const DtString &  variableName  )

virtual

virtual void DtReaderWriterRegistry::setVariableBindings ( const DtRwVariableBindings *  newBindings )

virtual

Sets local variable bindings to the specified value.

The bindings are copied to this registry, and the pointer is not needed after this call. NULL is a valid input to this method.

virtual DtReaderWriter* DtReaderWriterRegistry::addVariableBinding ( const DtString &  variableType, const DtString &  variableName  )

virtual

Adds a new variable binding to this registry.

This call will create a new DtReaderWriter subclass based on the type string specified. It will have the default value for this type. The newly create entry is returned. A variableBindings class for this registry will be created if it doesn't already have one.

bool DtReaderWriterRegistry::operator==

(

const DtReaderWriterRegistry &

)

const

bool DtReaderWriterRegistry::operator!=

(

const DtReaderWriterRegistry &

)

const

Member Data Documentation

const DtString DtReaderWriterRegistry::theVariableBindingsName

static

std::vector<DtReaderWriterRegistryData*> DtReaderWriterRegistry::myData

protected

virtual DtListItem * lookup(const DtSymbolString &keyword); virtual DtListItem * lookup(DtReaderWriter * const rw);

Referenced by registryData().

bool DtReaderWriterRegistry::myLocalDataFlag

protected

DtRwVariableBindings* DtReaderWriterRegistry::myVariableBindings

protected

---

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

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