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

Inherits DtReaderWriter, and DtList.

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 *	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 DtFilename &searchPath, 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 DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Top level to read itself from an input stream.
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 const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.

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

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)
	Add element to the list just before the indicated item.

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)
	Add element to the list just after the indicated item.
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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
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	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 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.
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 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 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.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.

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::pair < DtSymbolString, DtString >	DtVariableNameType
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 DtFilename &	appPath ()
	Gets the current working directory.
static DtReaderWriterFactory *	factory ()
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
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 DtReaderWriterFactory	theFactory

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

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

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.

Referenced by DtLoadPoint::addPoint(), and DtReservedSlot::addReservedBy().

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.

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.

Referenced by DtBufferSerialize::decode().

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.

Referenced by DtRwTemplatedListPtr< T >::remove().

virtual DtlObjPtr DtRwList::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		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, searchPath, 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 DtPrbRangeTableEntry.

virtual void DtRwList::getSelf	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)

virtual

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

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

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.

Referenced by DtRwTemplatedListPtr< T >::removeAll(), and DtRwTemplatedListPtr< T >::removeAndDeleteAll().

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.

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:

include/vrfutil/rwList.h

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation