A Readable, Writable version of DtList. More...

Inherits DtReaderWriter, and DtList.

Classes
struct	RwObjectAdder

Public Member Functions
	DtRwList ()
	default constructor
	DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtRwList ()
const DtRwList &	operator= (const DtRwList &orig)
	Calls down to DtReaderWriter::operator=(). List elements are not copied.
virtual DtListItem *	add (DtReaderWriter *data)
	Add element to the end of the list.
virtual DtListItem *	addWithAlternateName (DtReaderWriter *data, const DtString &name)
	Add element to the end of the list, but use the provided name in place of the object name on the data object.
virtual DtListItem *	addToStart (DtReaderWriter *data)
	Add element to the beginning of the list.
virtual DtListItem *	addToEnd (DtReaderWriter *data)
	Add element to the end of the list.
virtual void *	remove (DtReaderWriter data, DtListItem item)
	Remove an element from the list.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)=0
	This method must be overridden by a subclass.
virtual DtlObjPtr	getLocalData (DtlObjPtr args)
	Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)
	Add element to the list just after the indicated item.
virtual void	removeAll ()
	Removes all the items in the list.
virtual void	removeAndDeleteAll ()
	Removes and deletes all items in the list.
virtual void	reset ()
	Calls removeAndDeleteAll.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
bool	operator== (const DtRwList &rhs) const
	Iterates over all items and calls the factory to compare.
bool	operator!= (const DtRwList &rhs) const
virtual void	populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
virtual void	populateListByType (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtString &bindingType, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)

	DtRwList (const DtString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	Invokes DtReaderWriter copy constructor.
	DtRwList (const DtSymbolString &name, const DtRwList &orig, DtReaderWriterRegistry *parentRegistry=NULL)

virtual DtListItem *	addBefore (DtReaderWriter *data, const DtString &before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addBefore (DtReaderWriter *data, const DtSymbolString &before)

virtual DtListItem *	addAfter (DtReaderWriter *data, const DtString &after)
	Add element to the list just after the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter *data, const DtSymbolString &after)
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 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	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 DtListItem *	addBefore (DtReaderWriter data, DtListItem before)
	Add element to the list just before the indicated item.
virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)
	Add element to the list just after the indicated item.
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 ()
virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP value, const DtReaderWriter::SearchPaths &searchPaths=DtReaderWriter::SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual const char *	xmlType () const
virtual std::set< DtString >	supportedXmlTypes () const
	Returns the list of xml types supported by this list. Default is all.
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

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 (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.
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

Detailed Description

A Readable, Writable version of DtList.

This class cannot be used directly, but must be inherited to work with a specific DtReaderWriter subclass (or set of subclasses) as the data elements. The derived class must override the getData() method.

Note: All items in DtRwList must have a non-NULL. Most ReaderWriter objects take a name as the first argument to their constructor.

Constructor & Destructor Documentation

DtRwList::DtRwList ( )

default constructor

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

real constructor

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

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

Invokes DtReaderWriter copy constructor.

This is a shallow copy, and elements are not copied. subclasses may (and often do) opt to do a deep copy in their copy constructors.

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

virtual DtRwList::~DtRwList ( )

virtual

Member Function Documentation

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

Calls down to DtReaderWriter::operator=(). List elements are not copied.

virtual DtListItem* DtRwList::add ( DtReaderWriter * data )

virtual

Add element to the end of the list.

Returns the DtListItem envelope object that contains your new element.

Reimplemented in DtRwHazardTypes.

virtual DtListItem* DtRwList::addWithAlternateName	(	DtReaderWriter *	data,
		const DtString &	name
	)

virtual

Add element to the end of the list, but use the provided name in place of the object name on the data object.

Reimplemented in DtRwHazardTypes.

virtual DtListItem* DtRwList::addToStart ( DtReaderWriter * data )

virtual

Add element to the beginning of the list.

Returns the DtListItem envelope object that contains your new element.

Reimplemented in DtRwHazardTypes.

virtual DtListItem* DtRwList::addToEnd ( DtReaderWriter * data )

virtual

Add element to the end of the list.

Returns the DtListItem envelope object that contains your new element.

Reimplemented in DtRwHazardTypes.

virtual void* DtRwList::remove	(	DtReaderWriter *	data,
		DtListItem *	item
	)

virtual

Remove an element from the list.

Item is the envelope containing the data element you would like to remove. Note: remove does not free memory of data associated with the item. It only frees the item. The data is returned to the caller for deletion if required.

Reimplemented in DtModelSet.

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

pure virtual

This method must be overridden by a subclass.

  Within this method, new instances of the DtReaderWriter subclass
  that is being handled by this list must be created, and then retrieved
  from the mtl stream, using the getSelf member of that item.
  \par
  Here is some sample code that could be used to implement a 
  override of this class:  (This is used in the DtRwIntegerList::getData() method)
  @code

DtlObjPtr nameObj = DtcCar(args); DtRwInt* value = new DtRwInt(nameObj->pname()); value->getSelf(args, searchPaths, variableBindings); this->add(value); return DtcCdr(DtcCdr(args));

virtual DtlObjPtr DtRwList::getLocalData ( DtlObjPtr args )

virtual

Since getData is usually used for local data, and we're overloading it here to get the list data, use this if you want any data before your lists.

Reimplemented in DtPrbValueList.

virtual void DtRwList::getSelf	(	DtlObjPtr	args,
		const DtReaderWriter::SearchPaths &	searchPaths = `SearchPaths()`,
		const DtVariableBindingsList &	variableBindings = `nullVariableReference()`
	)

virtual

Reimplemented in DtFormationTable, DtVrfSubObjectParameterList, DtPromotionEntryList, DtVrfObjectParametersList, DtEmitterBeamList, DtActiveSonarBeamList, DtRadarModeList, and DtActiveSonarModeList.

virtual void DtRwList::getSelf	(	const DtEnvironmentSP	,
		const DtEnvValueSP	root,
		const SearchPaths &	searchPaths = `SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

virtual

virtual DtListItem* DtRwList::addBefore	(	DtReaderWriter *	data,
		const DtString &	before
	)

virtual

Add element to the list just before the indicated item.

Returns the DtListItem envelope object that contains your new element.

virtual DtListItem* DtRwList::addBefore	(	DtReaderWriter *	data,
		const DtSymbolString &	before
	)

virtual

virtual DtListItem* DtRwList::addAfter	(	DtReaderWriter *	data,
		const DtString &	after
	)

virtual

Add element to the list just after the indicated item.

Returns the DtListItem envelope object that contains your new element.

virtual DtListItem* DtRwList::addAfter	(	DtReaderWriter *	data,
		const DtSymbolString &	after
	)

virtual

virtual DtListItem* DtRwList::addBefore	(	DtReaderWriter *	data,
		DtReaderWriter *	before
	)

virtual

Add element to the list just before the indicated item.

Returns the DtListItem envelope object that contains your new element.

virtual DtListItem* DtRwList::addAfter	(	DtReaderWriter *	data,
		DtReaderWriter *	after
	)

virtual

Add element to the list just after the indicated item.

Returns the DtListItem envelope object that contains your new element.

virtual void DtRwList::removeAll ( )

virtual

Removes all the items in the list.

virtual void DtRwList::removeAndDeleteAll ( )

virtual

Removes and deletes all items in the list.

virtual void DtRwList::reset ( )

virtual

Calls removeAndDeleteAll.

Reimplemented from DtReaderWriter.

virtual const char* DtRwList::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 DtRwList::operator== ( const DtRwList & rhs ) const

Iterates over all items and calls the factory to compare.

bool DtRwList::operator!= ( const DtRwList & rhs ) const

inline

virtual void DtRwList::putData	(	DtEnvironmentSP	,
		DtEnvValueSP	parent
	)		const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented from DtReaderWriter.

Reimplemented in DtFormationTable.

virtual void DtRwList::getData	(	const DtEnvironmentSP	,
		const DtEnvValueSP	value,
		const DtReaderWriter::SearchPaths &	searchPaths = `DtReaderWriter::SearchPaths()`,
		const DtVariableBindingsList &	bindings = `DtVariableBindingsList()`
	)

virtual

Reimplemented in DtFormationTable, DtSoilList, DtVrfSubObjectParameterList, DtMappingList, and DtRwKeywordValuePairsReader.

static const char* DtRwList::theXmlType ( )

static

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

Reimplemented from DtReaderWriter.

Referenced by DtRwStringList::xmlType(), DtSignatureModifierList::xmlType(), DtRwObjectTypeList::xmlType(), DtRwIntegerList::xmlType(), DtRwVectorObstructionTypeList::xmlType(), DtSimResourceList::xmlType(), DtRwIntegerAttributeList::xmlType(), DtRwRealAttributeList::xmlType(), DtRwStringAttributeList::xmlType(), DtVrfSubObjectParameterList::xmlType(), DtSoilList::xmlType(), DtSensorContactInfoList::xmlType(), DtRwSpotReportDeltaCheckList::xmlType(), and DtFormationTable::xmlType().

virtual const char* DtRwList::xmlType ( ) const

inlinevirtual

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

virtual std::set<DtString> DtRwList::supportedXmlTypes ( ) const

virtual

Returns the list of xml types supported by this list. Default is all.

virtual void DtRwList::populateList	(	boost::function< void(DtReaderWriter *)>	addFunction,
		DtEnvironmentSP	env,
		DtEnvValueSP	node,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	bindings
	)

virtual

virtual void DtRwList::populateListByType	(	boost::function< void(DtReaderWriter *)>	addFunction,
		DtEnvironmentSP	env,
		DtEnvValueSP	node,
		const DtString &	bindingType,
		const DtReaderWriter::SearchPaths &	searchPaths,
		const DtVariableBindingsList &	bindings
	)

virtual

Reimplemented in DtRwKeyValueList.

virtual DtListItem* DtRwList::addBefore	(	DtReaderWriter *	data,
		DtListItem *	before
	)

protectedvirtual

Add element to the list just before the indicated item.

Returns the DtListItem envelope object that contains your new element.

virtual DtListItem* DtRwList::addAfter	(	DtReaderWriter *	data,
		DtListItem *	after
	)

protectedvirtual

Add element to the list just after the indicated item.

Returns the DtListItem envelope object that contains your new element.

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

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

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation