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.

Inherits DtReaderWriter, and DtList.

Classes
struct	RwObjectAdder

Public Member Functions
	DtRwList ()

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

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

virtual	~DtRwList () override

const DtRwList &	operator= (const DtRwList &orig)

virtual DtListItem *	add (DtReaderWriter *data)

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

virtual DtListItem *	addToStart (DtReaderWriter *data)

virtual DtListItem *	addToEnd (DtReaderWriter *data)

virtual void *	remove (DtReaderWriter data, DtListItem item)

virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings) override=0

virtual DtlObjPtr	getLocalData (DtlObjPtr args)

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

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

virtual DtListItem *	addBefore (DtReaderWriter data, DtReaderWriter before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtReaderWriter after)

virtual void	removeAll ()

virtual void	removeAndDeleteAll ()

virtual void	reset () override

virtual const char *	readerWriterType () const override

bool	operator== (const DtRwList &rhs) const

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)

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


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

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


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

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

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Member Functions
virtual DtListItem *	addBefore (DtReaderWriter data, DtListItem before)

virtual DtListItem *	addAfter (DtReaderWriter data, DtListItem after)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

virtual void	putData (DtEnvironmentSP, DtEnvValueSP parent) const override

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

virtual const char *	xmlType () const override

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

static const char *	theXmlType ()

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 char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

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

bool	myInvalid

bool	myChangedFlag

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

static DtOutputStream *	theOutputStream

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`
	)

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.

virtual DtRwList::~DtRwList ( )

overridevirtual

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.

Referenced by DtRwTemplatedListPtr< DtRwDynamicTerrainChangeInformation, true >::add(), and DtRwTemplatedListPtr< DtRwDynamicTerrainChangeInformation, true >::insertItemAt().

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, and DtSensorContactInfoList.

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

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

: Here is some sample code that could be used to implement a override of this class: (This is used in the DtRwIntegerList::getData() method)
DtlObjPtr nameObj = DtcCar(args);

DtRwInt* value = new DtRwInt(nameObj->pname());

value->getSelf(args, searchPaths, variableBindings);

this->add(value);

return DtcCdr(DtcCdr(args));

Reimplemented from DtReaderWriter.

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()`
	)

overridevirtual

Top level to read itself from an input stream. searchPath is passed down to all DtReaderWriter members in its DtReaderWriterRegistry (collection of child DtReaderWriter nodes). If a given member in the registry is of type DtReaderWriterFile, and the searchPath is specified with a non-NULL string, then file to be read in is searched for in the given path.

Reimplemented from DtReaderWriter.

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()`
	)

overridevirtual

Routines to archive/de-archive from an XML Environment.

Reimplemented from DtReaderWriter.

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.

Referenced by DtRwTemplatedListPtr< DtRwDynamicTerrainChangeInformation, true >::insertItemAt().

virtual DtListItem* DtRwList::addBefore	(	DtReaderWriter *	data,
		const DtSymbolString &	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,
		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

Add element to the list just after the indicated item. Returns the DtListItem envelope object that contains your new element.

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

overridevirtual

Calls removeAndDeleteAll.

Reimplemented from DtReaderWriter.

virtual const char* DtRwList::readerWriterType ( ) const

overridevirtual

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

overridevirtual

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()`
	)

overridevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtReaderWriter.

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

static const char* DtRwList::theXmlType ( )

static

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

virtual const char* DtRwList::xmlType ( ) const

inlineoverridevirtual

Routines to archive/dearchive from an XML Environment.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/readerWriter/rwList.h

Classes

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation