Inheritance diagram for DtReaderWriterMember:

Public Member Functions
	DtReaderWriterMember (void *parent=NULL)
	Default constructor.
	DtReaderWriterMember (void *parent, DtRwPutDataHook putHook, DtRwGetDataHook getHook)
	Other constructors.
	DtReaderWriterMember (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriterMember (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriterMember (const DtString &name, void parent, DtReaderWriterRegistry parentRegistry=NULL)
	DtReaderWriterMember (const DtSymbolString &name, void parent, DtReaderWriterRegistry parentRegistry=NULL)
	DtReaderWriterMember (const DtString &name, void parent, DtRwPutDataHook putHook, DtRwGetDataHook getHook, DtReaderWriterRegistry parentRegistry=NULL)
	DtReaderWriterMember (const DtSymbolString &name, void parent, DtRwPutDataHook putHook, DtRwGetDataHook getHook, DtReaderWriterRegistry parentRegistry=NULL)
	DtReaderWriterMember (const DtString &name, const DtReaderWriterMember &orig, void parent=NULL, DtReaderWriterRegistry parentRegistry=NULL)
	Copy constructor.
	DtReaderWriterMember (const DtSymbolString &name, const DtReaderWriterMember &orig, void parent=NULL, DtReaderWriterRegistry parentRegistry=NULL)
const DtReaderWriterMember &	operator= (const DtReaderWriterMember &orig)
	Assignment operator.
virtual	~DtReaderWriterMember ()
	Destructor.
virtual void *	parent () const
	these are the top level put/get calls
virtual void	setParent (void *arg)
DtReaderWriterRegistry *	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
const DtReaderWriterRegistry *	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
virtual bool	localData () const
	Shortcuts to some common registry functions.
virtual void	setLocalData (bool value=true)
virtual void	clearLocalData ()
virtual void	setPutDataHook (DtRwPutDataHook hook)
	the setPutDataHook function sets the function to call when putData would normally be called by a DtReaderWriter.
virtual void	setGetDataHook (DtRwGetDataHook hook)
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
bool	operator== (const DtReaderWriterMember &) const
	Always returns true.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Member Functions
virtual void	putData (FILE *fp, int indentLevel=0)
	A deriving class can override these to get/put class specific data but normally these will just call through the hooks, if provided.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
void *	myParent
DtRwPutDataHook	myPutDataHook
DtRwGetDataHook	myGetDataHook
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue
static DtGetSelfCallbackInfo	thePostGetSelfCallback
static DtPutSelfCallbackInfo	thePrePutSelfCallback
static const DtVariableBindingsList	theEmptyVariableBindingsList
static bool	theCreatorFcnSet
static DtReaderWriterFactory *	theFactory
static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

Detailed Description

class DtReaderWriterMember:

Instances of DtReaderWriterMember allow objects that are not derived from a DtReaderWriter to act as if they are for reading and writing purposes. This can be useful if you want to avoid the problems associated with multiple inheritance, and are willing to do a little extra work to do so.

This object is provided as a convenience to our customers, however THIS FEATURE IS NOT OFFICIALLY RECOMMENDED, DOCUMENTED OR SUPPORTED.

To use this class, add a DtReaderWriterMember as a normal member of your class, and then:

In constructors, pass the "this" pointer into the DtReaderWriterMember object (or use setParent).
In constructors, construct any other RW member data passing the DtReaderWriterMember's registry() as the parentRegistry argument.
Declare and implement one or two static functions (putDataHook/getDataHook) that match the examples below. (optional if no "localData" is needed)
Add a name() function that returns myRwMemb->name(). (optional)
Add putSelf/getSelf functions that just call through to the same functions on the DtReaderWriterMember. (recommended) These should not be virtual functions! NOTE: if you really need to override getSelf/putSelf, then you should derive from DtReaderWriterMember and override them there. Any getSelf/putSelf functions on your container class will not be called by its parent's registry.

An example class:

#include <vlutil/vlString.h> #include "rwMember.h" #include "rwInt.h" #include "someClass.h"

class MyClass : public SomeOtherClass { public: //! Constructors MyClass(const DtString& name, DtReaderWriterRegistry* parentRegistry = NULL); MyClass(const DtString& name, int otherData, DtReaderWriterRegistry* parentRegistry = NULL); MyClass(const DtString& name, const MyClass& orig, DtReaderWriterRegistry* parentRegistry = NULL); const MyClass& operator=(const MyClass& orig);

//! Destructor virtual ~MyClass();

//! A redirector for the name function const DtString& name() const { return myRwMemb->name(); }

//! Redirectors for the putSelf and getSelf functions void putSelf(FILE *fp, int indentLevel = 0, bool writeUnspecified = false, const DtFilename& path = DtReaderWriter::appPath()) { myRwMemb->putSelf(fp, indentLevel); } void getSelf(DtlObjPtr args) { myRwMemb->getSelf(args); }

//! Redirectors for the valueSpecified functions void setValueSpecified(bool specified) { myRwMemb->setValueSpecified(specified); } bool valueSpecified() const { return myRwMemb->valueSpecified(); }

//! The Hook static functions static void putDataHook(void* obj, FILE* fp, int indentLevel); static DtlObjPtr getDataHook(void* obj, DtlObjPtr args);

protected: //! The REAL putData and getData functions virtual void putData(FILE* fp, int indentLevel = 0); virtual DtlObjPtr getData(DtlObjPtr args);

DtReaderWriterMember* myRwMemb; DtRwInt* myOtherData; }; MyClass::MyClass(const DtString & name, DtReaderWriterRegistry* parentRegistry = NULL) { myRwMemb = new DtReaderWriterMember(name, this, parentRegistry); myRwMemb->setPutDataHook(putDataHook); myRwMemb->setGetDataHook(getDataHook); //! NOTE: pass DtReaderWriterMember's registry as if our own myOtherData = new DtRwInt("other-data", myRwMemb->registry()); } MyClass::MyClass(const DtString & name, int otherData, DtReaderWriterRegistry* parentRegistry = NULL) { myRwMemb = new DtReaderWriterMember(name, this, putDataHook, getDataHook, parentRegistry); //! NOTE: pass DtReaderWriterMember's registry as if our own myOtherData = new DtRwInt("other-data", myRwMemb->registry()); myOtherData = otherData; } MyClass::MyClass(const DtString& name, const MyClass& orig, DtReaderWriterRegistry parentRegistry) { myRwMemb = new DtReaderWriterMember(name, orig.myRwMemb, this, parentRegistry); myOtherData = new DtRwInt(*orig.myOtherData); myRwMemb->registry()->addEntry(myOtherData->name(), myOtherData); } const MyClass& MyClass::operator=(const MyClass& orig) { *myRwMemb = *(orig.myRwMemb); *myOtherData = *(orig.myOtherData); } MyClass::~MyClass() { delete myRwMemb; delete myOtherData; } void MyClass::putDataHook(void obj, FILE* fp, int indentLevel) { ((MyClass*) obj)->putData(fp, indentLevel); } DtlObjPtr MyClass::getDataHook(void* obj, DtlObjPtr args) { return ((MyClass*) obj)->getData(args); }

NOTE: this technique makes your class act similar to a class derived from DtReaderWriter in many ways, but NOT ALL. For example, DO NOT ATTEMPT to add classes that are not derived from DtReaderWriter to DtRwLists! Of course, it should be possible to put the myRwMemb variables in the list and then access the REAL objects of the list by using the myRwMemb->parent() function. The actual code for doing this is left as an exercise to the reader.

Constructor & Destructor Documentation

DtReaderWriterMember::DtReaderWriterMember ( void * parent = NULL )

Default constructor.

DtReaderWriterMember::DtReaderWriterMember	(	void *	parent,
		DtRwPutDataHook	putHook,
		DtRwGetDataHook	getHook
	)

Other constructors.

DtReaderWriterMember::DtReaderWriterMember	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtReaderWriterMember::DtReaderWriterMember	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtReaderWriterMember::DtReaderWriterMember	(	const DtString &	name,
		void *	parent,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtReaderWriterMember::DtReaderWriterMember	(	const DtSymbolString &	name,
		void *	parent,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtReaderWriterMember::DtReaderWriterMember	(	const DtString &	name,
		void *	parent,
		DtRwPutDataHook	putHook,
		DtRwGetDataHook	getHook,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtReaderWriterMember::DtReaderWriterMember	(	const DtSymbolString &	name,
		void *	parent,
		DtRwPutDataHook	putHook,
		DtRwGetDataHook	getHook,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtReaderWriterMember::DtReaderWriterMember	(	const DtString &	name,
		const DtReaderWriterMember &	orig,
		void *	parent = `NULL`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

Copy constructor.

DtReaderWriterMember::DtReaderWriterMember	(	const DtSymbolString &	name,
		const DtReaderWriterMember &	orig,
		void *	parent = `NULL`,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

virtual DtReaderWriterMember::~DtReaderWriterMember ( )

virtual

Destructor.

Member Function Documentation

const DtReaderWriterMember& DtReaderWriterMember::operator= ( const DtReaderWriterMember & orig )

Assignment operator.

virtual void* DtReaderWriterMember::parent ( ) const

virtual

these are the top level put/get calls

virtual void DtReaderWriterMember::setParent ( void * arg )

virtual

DtReaderWriterRegistry* DtReaderWriterMember::registry ( )

Collection of child DtReaderWriter nodes owned by this object.

Reimplemented from DtReaderWriter.

const DtReaderWriterRegistry* DtReaderWriterMember::registry ( ) const

Collection of child DtReaderWriter nodes owned by this object.

Reimplemented from DtReaderWriter.

virtual bool DtReaderWriterMember::localData ( ) const

virtual

Shortcuts to some common registry functions.

virtual void DtReaderWriterMember::setLocalData ( bool value = true )

virtual

virtual void DtReaderWriterMember::clearLocalData ( )

virtual

virtual void DtReaderWriterMember::setPutDataHook ( DtRwPutDataHook hook )

virtual

the setPutDataHook function sets the function to call when putData would normally be called by a DtReaderWriter.

virtual void DtReaderWriterMember::setGetDataHook ( DtRwGetDataHook hook )

virtual

virtual const char* DtReaderWriterMember::readerWriterType ( ) const

virtual

Used to supply a string type that this reader writer type is.

This can be used in place of dynamic-casting. Also used by the opd editor to determine which type of control to create

Reimplemented from DtReaderWriter.

bool DtReaderWriterMember::operator== ( const DtReaderWriterMember & ) const

Always returns true.

virtual void DtReaderWriterMember::putData	(	FILE *	fp,
		int	indentLevel = `0`
	)

protectedvirtual

A deriving class can override these to get/put class specific data but normally these will just call through the hooks, if provided.

When the hooks are called, the first argument will be the myParent pointer.

Reimplemented from DtReaderWriter.

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

protectedvirtual

Member Data Documentation

void* DtReaderWriterMember::myParent

protected

DtRwPutDataHook DtReaderWriterMember::myPutDataHook

protected

DtRwGetDataHook DtReaderWriterMember::myGetDataHook

protected

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfutil/readerWriterMember.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation