VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes
DtRwTemplatedListPtr< T, T_autoDelete > Class Template Reference

template<typename T, bool T_autoDelete>
class DtRwTemplatedListPtr< T, T_autoDelete >

A version of DtRwList that contains a homogeneous list of a templated RW type. The templated type specified must be a subclass of DtReaderWriter. The T_autoDelete template parameter indicates whether or not this list takes ownership of the items added to it. If true, the items will be deleted when removed from the list, or the list is destroyed.

Inherits DtRwList.

Inherited by DtRwChannelSettings.

Public Types

typedef DtIteratorBase< T > iterator
 
typedef DtIteratorBase< const T > const_iterator
 
- 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 )()
 

Public Member Functions

 DtRwTemplatedListPtr ()
 
 DtRwTemplatedListPtr (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtSymbolString &name, const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwTemplatedListPtr (const DtRwTemplatedListPtr &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtRwTemplatedListPtr & operator= (const DtRwTemplatedListPtr &orig)
 
virtual ~DtRwTemplatedListPtr ()
 
DtlObjPtr getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
 
virtual DtListItem * insertItemAt (T *data, int index)
 
virtual DtListItem * add (T *data)
 
void removeAll ()
 
void * remove (DtListItem *item)
 
void * remove (T *item)
 
virtual std::set< DtString > supportedXmlTypes () const
 
void removeAndDeleteAll ()
 
bool operator== (const DtRwTemplatedListPtr &) const
 
bool operator!= (const DtRwTemplatedListPtr &) const
 
virtual const char * xmlType () const
 
virtual void populateList (boost::function< void(DtReaderWriter *)> addFunction, DtEnvironmentSP env, DtEnvValueSP node, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &bindings)
 
DtListItem * find (boost::function< bool(const T &)> predFcn) const
 
virtual DtString prettyPrint () const
 
const char * readerWriterType () const
 
void copyList (const DtRwTemplatedListPtr &orig)
 
- Public Member Functions inherited from DtRwList
 DtRwList ()
 
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtRwList ()
 
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 getLocalData (DtlObjPtr args)
 
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)
 
virtual DtListItem * addAfter (DtReaderWriter *data, DtReaderWriter *after)
 
virtual void reset ()
 
bool operator== (const DtRwList &rhs) const
 
bool operator!= (const DtRwList &rhs) const
 
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)
 
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())
 
- 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)
 
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 &)
 
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 wasUpdatedSince (DtTime t) 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)
 

Static Public Member Functions

static const char * theXmlType ()
 
static const char * ListReaderWriterType ()
 
- Static Public Member Functions inherited from DtRwList
static const char * theXmlType ()
 
- 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

DtString myXmlType
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from DtRwList
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)
 
- 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
 

Member Typedef Documentation

template<typename T, bool T_autoDelete>
typedef DtIteratorBase<T> DtRwTemplatedListPtr< T, T_autoDelete >::iterator
template<typename T, bool T_autoDelete>
typedef DtIteratorBase<const T> DtRwTemplatedListPtr< T, T_autoDelete >::const_iterator

Constructor & Destructor Documentation

template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( )

default constructor

template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
)

real constructor

template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
)
template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( const DtString &  name,
const DtRwTemplatedListPtr< T, T_autoDelete > &  orig,
DtReaderWriterRegistry *  parentRegistry = NULL 
)

Invokes DtReaderWriter copy constructor. Elements are copied using their standard copy constructor.

template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( const DtSymbolString &  name,
const DtRwTemplatedListPtr< T, T_autoDelete > &  orig,
DtReaderWriterRegistry *  parentRegistry = NULL 
)
template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr< T, T_autoDelete >::DtRwTemplatedListPtr ( const DtRwTemplatedListPtr< T, T_autoDelete > &  orig,
DtReaderWriterRegistry *  parentRegistry = NULL 
)

... and make sure the default constructor is overridden:

template<typename T, bool T_autoDelete>
virtual DtRwTemplatedListPtr< T, T_autoDelete >::~DtRwTemplatedListPtr ( )
virtual

Member Function Documentation

template<typename T, bool T_autoDelete>
DtRwTemplatedListPtr& DtRwTemplatedListPtr< T, T_autoDelete >::operator= ( const DtRwTemplatedListPtr< T, T_autoDelete > &  orig)
template<typename T, bool T_autoDelete>
DtlObjPtr DtRwTemplatedListPtr< T, T_autoDelete >::getData ( DtlObjPtr  args,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  variableBindings 
)
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));

Implements DtRwList.

template<typename T, bool T_autoDelete>
virtual DtListItem* DtRwTemplatedListPtr< T, T_autoDelete >::insertItemAt ( T *  data,
int  index 
)
inlinevirtual
template<typename T, bool T_autoDelete>
virtual DtListItem* DtRwTemplatedListPtr< T, T_autoDelete >::add ( T *  data)
inlinevirtual

Define this function to hide the DtRwList version, and accept only the specific DtReaderWriter subclass that this list is handling.

Referenced by DtLoadPoint::addPoint(), and DtTerrainInterfaceConfig::ListT< DtTerrainInterfaceConfig >::configure().

template<typename T, bool T_autoDelete>
void DtRwTemplatedListPtr< T, T_autoDelete >::removeAll ( )
virtual

Removes all entries from the list. If autoDelete is true, also deletes all items.

Reimplemented from DtRwList.

template<typename T, bool T_autoDelete>
void* DtRwTemplatedListPtr< T, T_autoDelete >::remove ( DtListItem *  item)
template<typename T, bool T_autoDelete>
void* DtRwTemplatedListPtr< T, T_autoDelete >::remove ( T *  item)
template<typename T, bool T_autoDelete>
virtual std::set<DtString> DtRwTemplatedListPtr< T, T_autoDelete >::supportedXmlTypes ( ) const
virtual

Returns list of supported types. Default is the templated object xml type.

Reimplemented from DtRwList.

Reimplemented in DtRwDistanceAltitudeTimeEntryList.

template<typename T, bool T_autoDelete>
void DtRwTemplatedListPtr< T, T_autoDelete >::removeAndDeleteAll ( )
virtual

Removes and deletes all entries in the list.

Reimplemented from DtRwList.

Referenced by DtTerrainInterfaceConfig::ListT< DtTerrainInterfaceConfig >::configure().

template<typename T, bool T_autoDelete>
bool DtRwTemplatedListPtr< T, T_autoDelete >::operator== ( const DtRwTemplatedListPtr< T, T_autoDelete > &  ) const

Equivalence operators.

template<typename T, bool T_autoDelete>
bool DtRwTemplatedListPtr< T, T_autoDelete >::operator!= ( const DtRwTemplatedListPtr< T, T_autoDelete > &  ) const
template<typename T, bool T_autoDelete>
static const char* DtRwTemplatedListPtr< T, T_autoDelete >::theXmlType ( )
inlinestatic

Referenced by DtRwActivities::xmlType(), DtRwKeywordValuePairsReader::xmlType(), DtRwScriptVariablesList::xmlType(), DtRwTemplatedListPtr< DtRwDynamicTerrainChangeInformation, true >::xmlType(), and DtAssembliesReaderWriter::xmlType().

template<typename T, bool T_autoDelete>
virtual const char* DtRwTemplatedListPtr< T, T_autoDelete >::xmlType ( ) const
inlinevirtual

Routines to archive/dearchive from an XML Environment.

Reimplemented from DtRwList.

Reimplemented in DtRwDistanceAltitudeTimeEntryList, DtRwScriptVariablesList, DtRwIntelCollectionArea, DtRwKeywordValuePairsReader, and DtRwActivities.

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

template<typename T, bool T_autoDelete>
virtual void DtRwTemplatedListPtr< T, T_autoDelete >::populateList ( boost::function< void(DtReaderWriter *)>  addFunction,
DtEnvironmentSP  env,
DtEnvValueSP  node,
const DtReaderWriter::SearchPaths &  searchPaths,
const DtVariableBindingsList &  bindings 
)
virtual

Reimplemented from DtRwList.

template<typename T, bool T_autoDelete>
DtListItem* DtRwTemplatedListPtr< T, T_autoDelete >::find ( boost::function< bool(const T &)>  predFcn) const

Finds the first item in the list for which predFcn returns true.

template<typename T, bool T_autoDelete>
virtual DtString DtRwTemplatedListPtr< T, T_autoDelete >::prettyPrint ( ) const
virtual

Routine to return a human readable form of the reader/writer variable. Not all reader/writer classes implement this feature. Default is to return an empty string.

Reimplemented from DtReaderWriter.

Reimplemented in DtRwOffsetVectorList, DtRwVectorList, and DtRwChannelSettings.

template<typename T, bool T_autoDelete>
const char* DtRwTemplatedListPtr< T, T_autoDelete >::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 DtRwList.

template<typename T, bool T_autoDelete>
static const char* DtRwTemplatedListPtr< T, T_autoDelete >::ListReaderWriterType ( )
static
template<typename T, bool T_autoDelete>
void DtRwTemplatedListPtr< T, T_autoDelete >::copyList ( const DtRwTemplatedListPtr< T, T_autoDelete > &  orig)

Member Data Documentation

template<typename T, bool T_autoDelete>
DtString DtRwTemplatedListPtr< T, T_autoDelete >::myXmlType
protected
The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)