DtRwList Class Reference

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

Inherits DtReaderWriter, and DtList.

Inherited by DtAggregatedResourceList, DtAmmoSelectTable, DtBehaviorUi, DtCommModelDescriptorList, DtComponentDescriptorList, DtComponentSystemDescriptorList, DtConnectionDescriptorList, DtDetonationDescriptorList, DtDIGuyCharacterAnimationTable, DtDmgMunitionTable, DtDmgSurfaceEntry, DtDmgSurfaceTable, DtEmitterBeamList, DtFormation, DtFormationTable, DtIndirectArtilleryTypesManager, DtLayoutContainer, DtMappingList, DtModelSet, DtPrbCoefficientList, DtPrbRangeList, DtPrbRangeTableEntry, DtPromotionEntryList, DtRadarModeList, DtRadioDescriptorList, DtRangeProbabilityTable, DtRealList, DtRwBooleanList, DtRwDIGuyAnimationsList, DtRwEntityTypeList, DtRwForceDescriptionList, DtRwIntegerAttributeList, DtRwIntegerList, DtRwMultiTypeListTemplate< T_ContentBase >, DtRwMultiTypeListTemplate< DtSystemMetaDataEntry >, DtRwMultiTypeListTemplate< DtSystemParameterData >, DtRwObjectTypeList, DtRwRealAttributeList, DtRwSoilSpeedFactorList, DtRwSpawnDataList, DtRwStaticDynamicPostureList, DtRwStringAttributeList, DtRwStringList, DtRwTemplatedListPtr< T >, DtRwTemplatedListPtr< DtLaserSpotData >, DtRwTemplatedListPtr< DtLoadPoint >, DtRwTemplatedListPtr< DtMtlParameterDbFileEntry >, DtRwTemplatedListPtr< DtPromotionIdObjectNameInformation >, DtRwTemplatedListPtr< DtReservedSlot >, DtRwTemplatedListPtr< DtRwGaussianPuffData >, DtRwTemplatedListPtr< DtRwInt >, DtRwTemplatedListPtr< DtRwNLengthStringVector >, DtRwTemplatedListPtr< DtRwObjectTypeInfo >, DtRwTemplatedListPtr< DtRwRailSegment >, DtRwTemplatedListPtr< DtRwSensorSignature >, DtRwTemplatedListPtr< DtRwString >, DtRwTemplatedListPtr< DtRwTrafficSinkListEntry >, DtRwTemplatedListPtr< DtRwVector >, DtRwTemplatedListPtr< DtSlotExclusion >, DtRwTemplatedListPtr< DtSymbolMapperEntry >, DtRwTemplatedListPtr< DtTargetAcquireCriteria >, DtRwTriggerDataList, DtRwVectorObstructionTypeList, DtScenarioBatchRecordList, DtSensorContactInfoList, DtSignatureModifierList, DtSignaturePropagatorDescriptorList, DtSimArtPartDescriptorList, DtSimArtPartParamList, DtSimComponentList, DtSimMunitionList, DtSimReportList, DtSimResourceList, DtSimResourceManager, DtSoilList, DtSubordinateObjectsList, DtTargetPriorityList, DtTaskStatusList, DtTrueAggregateResourceList, DtUiForParameter, DtVertexList, DtVrfObjectManager, DtVrfObjectParametersList, DtVrfProcessStateRepositoryManager, and DtVrfSubObjectParameterList.

List of all members.

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

---

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.

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, searchPath, variableBindings);
 this->add(value);
 return DtcCdr(DtcCdr(args));

Implemented in DtVrfObjectManager, DtLayoutContainer, DtVrfProcessStateRepositoryManager, DtRwForceDescriptionList, DtSensorContactInfoList, DtSimResourceManager, DtConnectionDescriptorList, DtFormationTable, DtFormation, DtUiForParameter, DtRwSpawnDataList, DtBehaviorUi, DtRwRealAttributeList, DtRwSoilSpeedFactorList, DtRwIntegerAttributeList, DtDetonationDescriptorList, DtSoilList, DtRwVectorObstructionTypeList, DtModelSet, DtRwDIGuyAnimationsList, DtPrbRangeList, DtRangeProbabilityTable, DtRwObjectTypeList, DtRwStringAttributeList, DtVertexList, DtDmgSurfaceEntry, DtDmgSurfaceTable, DtRwStaticDynamicPostureList, DtPromotionEntryList, DtRwIntegerList, DtVrfSubObjectParameterList, DtTargetPriorityList, DtRadioDescriptorList, DtDIGuyCharacterAnimationTable, DtRwMultiTypeListTemplate< T_ContentBase >, DtRwMultiTypeListTemplate< DtSystemParameterData >, DtRwMultiTypeListTemplate< DtSystemMetaDataEntry >, DtSimComponentList, DtSimArtPartDescriptorList, DtCommModelDescriptorList, DtSignaturePropagatorDescriptorList, DtSimMunitionList, DtComponentDescriptorList, DtDmgMunitionTable, DtSimReportList, DtTaskStatusList, DtComponentSystemDescriptorList, DtIndirectArtilleryTypesManager, DtAmmoSelectTable, DtMappingList, DtPrbCoefficientList, DtRwEntityTypeList, DtSimArtPartParamList, DtPrbRangeTableEntry, DtVrfObjectParametersList, DtSimResourceList, DtRwBooleanList, DtSubordinateObjectsList, DtAggregatedResourceList, DtSignatureModifierList, DtRwTriggerDataList, DtTrueAggregateResourceList, DtEmitterBeamList, DtLegacyProcessStateRepositoryManager, DtRadarModeList, DtRwTemplatedListPtr< T >, DtScenarioBatchRecordList, DtRwTemplatedListPtr< DtTargetAcquireCriteria >, DtRwTemplatedListPtr< DtRwObjectTypeInfo >, DtRwTemplatedListPtr< DtRwInt >, DtRwTemplatedListPtr< DtRwString >, DtRwTemplatedListPtr< DtSlotExclusion >, DtRwTemplatedListPtr< DtRwTrafficSinkListEntry >, DtRwTemplatedListPtr< DtRwSensorSignature >, DtRwTemplatedListPtr< DtRwGaussianPuffData >, DtRwTemplatedListPtr< DtMtlParameterDbFileEntry >, DtRwTemplatedListPtr< DtRwNLengthStringVector >, DtRwTemplatedListPtr< DtSymbolMapperEntry >, DtRwTemplatedListPtr< DtPromotionIdObjectNameInformation >, DtRwTemplatedListPtr< DtLoadPoint >, DtRwTemplatedListPtr< DtRwVector >, DtRwTemplatedListPtr< DtRwRailSegment >, DtRwTemplatedListPtr< DtLaserSpotData >, DtRwTemplatedListPtr< DtReservedSlot >, DtRealList, and DtRwStringList.

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]

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.

Reimplemented in DtConnectionDescriptorList, DtRwTemplatedListPtr< T >, DtRwTemplatedListPtr< DtTargetAcquireCriteria >, DtRwTemplatedListPtr< DtRwObjectTypeInfo >, DtRwTemplatedListPtr< DtRwInt >, DtRwTemplatedListPtr< DtRwString >, DtRwTemplatedListPtr< DtSlotExclusion >, DtRwTemplatedListPtr< DtRwTrafficSinkListEntry >, DtRwTemplatedListPtr< DtRwSensorSignature >, DtRwTemplatedListPtr< DtRwGaussianPuffData >, DtRwTemplatedListPtr< DtMtlParameterDbFileEntry >, DtRwTemplatedListPtr< DtRwNLengthStringVector >, DtRwTemplatedListPtr< DtSymbolMapperEntry >, DtRwTemplatedListPtr< DtPromotionIdObjectNameInformation >, DtRwTemplatedListPtr< DtLoadPoint >, DtRwTemplatedListPtr< DtRwVector >, DtRwTemplatedListPtr< DtRwRailSegment >, DtRwTemplatedListPtr< DtLaserSpotData >, and DtRwTemplatedListPtr< DtReservedSlot >.

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.

Reimplemented in DtSensorContactInfoList, DtSoilList, DtFormationTable, DtRwVectorObstructionTypeList, DtTargetPriorityList, DtRwDIGuyAnimationsList, DtRwObjectTypeList, DtRwStringAttributeList, DtDmgMunitionTable, DtSimArtPartDescriptorList, DtSimMunitionList, DtRwRealAttributeList, DtEmitterBeamList, DtSimResourceList, DtRwIntegerAttributeList, DtSimArtPartParamList, DtRwSoilSpeedFactorList, DtRadarModeList, DtRwTemplatedListPtr< T >, DtRwTemplatedListPtr< DtTargetAcquireCriteria >, DtRwTemplatedListPtr< DtRwObjectTypeInfo >, DtRwTemplatedListPtr< DtRwInt >, DtRwTemplatedListPtr< DtRwString >, DtRwTemplatedListPtr< DtSlotExclusion >, DtRwTemplatedListPtr< DtRwTrafficSinkListEntry >, DtRwTemplatedListPtr< DtRwSensorSignature >, DtRwTemplatedListPtr< DtRwGaussianPuffData >, DtRwTemplatedListPtr< DtMtlParameterDbFileEntry >, DtRwTemplatedListPtr< DtRwNLengthStringVector >, DtRwTemplatedListPtr< DtSymbolMapperEntry >, DtRwTemplatedListPtr< DtPromotionIdObjectNameInformation >, DtRwTemplatedListPtr< DtLoadPoint >, DtRwTemplatedListPtr< DtRwVector >, DtRwTemplatedListPtr< DtRwRailSegment >, DtRwTemplatedListPtr< DtLaserSpotData >, DtRwTemplatedListPtr< DtReservedSlot >, DtTrueAggregateResourceList, DtRwStaticDynamicPostureList, DtVrfSubObjectParameterList, DtRwSpawnDataList, DtConnectionDescriptorList, DtComponentSystemDescriptorList, DtSystemMetaDataEntryList, DtSystemParameterDataList, DtSignatureModifierList, DtAggregatedResourceList, DtSubordinateObjectsList, and DtRwSensorSignatureList.

virtual DtListItem* DtRwList::addBefore	(	DtReaderWriter *	data,
		DtListItem *	before
	)		[protected, 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,
		DtListItem *	after
	)		[protected, virtual]

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