DtAssembliesReaderWriter::RwRootNode Class Reference

Inheritance diagram for DtAssembliesReaderWriter::RwRootNode:

Public Member Functions
	RwRootNode (const DtString &rwName="rootNode", DtReaderWriterRegistry *parentRegistry=0)
	default constructor
	RwRootNode (const RwRootNode &name, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~RwRootNode ()
bool	operator== (const RwRootNode &rhs) const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
RwRootNode &	operator= (const RwRootNode &)
virtual void	clear ()
virtual RwRootNode *	find (const DtString &keyword) const
	Looks in children for item by keyword. If cannot find by keyword looks by rw name.
virtual bool	collectAllItemsOfType (const std::string &, RwRootNode &) const
	Given the particular type search the myChildren member for those types (match by rw name) and fill in the supplied list's children with those types.
virtual RwRootNode *	findByRwName (const DtString &name) const
	Looks in children for item by rw name.
virtual std::map< DtString, RwRootNode * >	keywordMap () const
	Returns a map of keywords and root objects of children. Used for sorting purposes.
virtual std::map< DtString, RwRootNode * >	displayNameMap () const
	Returns a map of display names and root objectss of children. Used for sorting purposes.
virtual void	setAttributes (const std::map< std::string, std::string > &)
virtual std::map< std::string, std::string >	attributesMap () const
virtual RwRootNode *	findByNameAndKeyword (const DtString &rwName, const DtString &keyword) const
	Looks in children for the given rw name and keyword.
virtual DtString	findAttributeValue (const std::string &keyword) const
virtual void	addAttribute (const DtString &kw, const DtString &val)
virtual void	removeAttribute (const DtString &kw)
virtual void	getSelf (const DtEnvironmentSP env, const DtEnvValueSP root, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
int	count () const
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 (std::string &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 (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
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 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 void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
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)
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 ()
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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
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.

Static Public Member Functions
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
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 &, bool createAsProperty=false)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
	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 Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Public Attributes
DtRwString	myDisplayName
DtRwString	myKeyword
DtRwTemplatedStringList	myAttributes
RootNodeContainer *	myChildren

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 )()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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.
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
static bool	thePutIndent

Constructor & Destructor Documentation

DtAssembliesReaderWriter::RwRootNode::RwRootNode	(	const DtString &	rwName = "rootNode",
		DtReaderWriterRegistry *	parentRegistry = 0
	)

default constructor

DtAssembliesReaderWriter::RwRootNode::RwRootNode	(	const RwRootNode &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtAssembliesReaderWriter::RwRootNode::~RwRootNode ( )

virtual

Member Function Documentation

bool DtAssembliesReaderWriter::RwRootNode::operator==

(

const RwRootNode &

rhs

)

const

virtual const char* DtAssembliesReaderWriter::RwRootNode::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.

static const char* DtAssembliesReaderWriter::RwRootNode::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Reimplemented from DtReaderWriter.

virtual const char* DtAssembliesReaderWriter::RwRootNode::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

RwRootNode& DtAssembliesReaderWriter::RwRootNode::operator=

(

const RwRootNode &

)

virtual void DtAssembliesReaderWriter::RwRootNode::clear ( )

virtual

virtual RwRootNode* DtAssembliesReaderWriter::RwRootNode::find ( const DtString &  keyword ) const

virtual

Looks in children for item by keyword. If cannot find by keyword looks by rw name.

virtual bool DtAssembliesReaderWriter::RwRootNode::collectAllItemsOfType ( const std::string &  , RwRootNode &    ) const

virtual

Given the particular type search the myChildren member for those types (match by rw name) and fill in the supplied list's children with those types.

Note that the pointers added are the actual data so do not auto delete the list or delete any data returned by this method. Returns true if items are found

virtual RwRootNode* DtAssembliesReaderWriter::RwRootNode::findByRwName ( const DtString &  name ) const

virtual

Looks in children for item by rw name.

virtual std::map<DtString, RwRootNode*> DtAssembliesReaderWriter::RwRootNode::keywordMap ( ) const

virtual

Returns a map of keywords and root objects of children. Used for sorting purposes.

virtual std::map<DtString, RwRootNode*> DtAssembliesReaderWriter::RwRootNode::displayNameMap ( ) const

virtual

Returns a map of display names and root objectss of children. Used for sorting purposes.

virtual void DtAssembliesReaderWriter::RwRootNode::setAttributes ( const std::map< std::string, std::string > &  )

virtual

virtual std::map<std::string, std::string> DtAssembliesReaderWriter::RwRootNode::attributesMap ( ) const

virtual

virtual RwRootNode* DtAssembliesReaderWriter::RwRootNode::findByNameAndKeyword ( const DtString &  rwName, const DtString &  keyword  ) const

virtual

Looks in children for the given rw name and keyword.

virtual DtString DtAssembliesReaderWriter::RwRootNode::findAttributeValue ( const std::string &  keyword ) const

virtual

virtual void DtAssembliesReaderWriter::RwRootNode::addAttribute ( const DtString &  kw, const DtString &  val  )

virtual

virtual void DtAssembliesReaderWriter::RwRootNode::removeAttribute ( const DtString &  kw )

virtual

virtual void DtAssembliesReaderWriter::RwRootNode::getSelf ( const DtEnvironmentSP  env, const DtEnvValueSP  root, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  varBindings  )

virtual

virtual void DtAssembliesReaderWriter::RwRootNode::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

inlinevirtual

References DtReaderWriter::getSelf().

int DtAssembliesReaderWriter::RwRootNode::count ( ) const

inline

Member Data Documentation

DtRwString DtAssembliesReaderWriter::RwRootNode::myDisplayName

DtRwString DtAssembliesReaderWriter::RwRootNode::myKeyword

DtRwTemplatedStringList DtAssembliesReaderWriter::RwRootNode::myAttributes

RootNodeContainer* DtAssembliesReaderWriter::RwRootNode::myChildren

---

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

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