VR-Forces 4.1.1 Class Documentation
List of all members | Public Member Functions | Protected Member Functions
DtRadarModeList Class Reference

DtRadarModeList; Readable/writeable container for DtRadarModeEntry* items. More...

Inheritance diagram for DtRadarModeList:
Inheritance graph
[legend]

Public Member Functions

 DtRadarModeList (const DtString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor
 DtRadarModeList (const DtSymbolString &writeName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtRadarModeList ()
 destructor
 DtRadarModeList (const DtString &writeName, const DtRadarModeList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtRadarModeList (const DtSymbolString &writeName, const DtRadarModeList &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtRadarModeListoperator= (const DtRadarModeList &orig)
 assignment operator
virtual void getSelf (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Overridden to call reindexModes() once everything is read.
- Public Member Functions inherited from DtRwList
 DtRwList ()
 default constructor
 DtRwList (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtRwList (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtRwList ()
const DtRwListoperator= (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 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 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.
 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 DtReaderWriteroperator= (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 aliasContaineraliases () 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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
 Collection of child DtReaderWriter nodes owned by this object.

Protected Member Functions

virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Constructs a DtRadarModeListEntry, reads the data from the mtl stream, and adds it to the list.
virtual void reindexModes ()
 Finds any beam entries without specified index values and assignes an available index to them.
void removeAndDeleteModes ()
 removes and deletes all items from the list.
void copyListItemsFrom (const DtRadarModeList &sourceList)
 Makes copies of all items on sourceList and adds them to this list.
virtual const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
- Protected Member Functions inherited from DtRwList
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 DtReaderWriterFactoryfactory ()
- 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

DtRadarModeList; Readable/writeable container for DtRadarModeEntry* items.

Instances of DtRadarModeList each hold a list of pointers to DtRadarModeEntry that describe beam modes for an emitter system.

Constructor & Destructor Documentation

DtRadarModeList::DtRadarModeList ( const DtString writeName,
DtReaderWriterRegistry parentRegistry = NULL 
)

constructor

DtRadarModeList::DtRadarModeList ( const DtSymbolString writeName,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtRadarModeList::~DtRadarModeList ( )
virtual

destructor

DtRadarModeList::DtRadarModeList ( const DtString writeName,
const DtRadarModeList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtRadarModeList::DtRadarModeList ( const DtSymbolString writeName,
const DtRadarModeList orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

Member Function Documentation

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

assignment operator

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

Overridden to call reindexModes() once everything is read.

Reimplemented from DtRwList.

virtual DtlObjPtr DtRadarModeList::getData ( DtlObjPtr  args,
const DtFilename &  searchPath,
const DtVariableBindingsList variableBindings 
)
protectedvirtual

Constructs a DtRadarModeListEntry, reads the data from the mtl stream, and adds it to the list.

Implements DtRwList.

virtual void DtRadarModeList::reindexModes ( )
protectedvirtual

Finds any beam entries without specified index values and assignes an available index to them.

Should be called after the entire list is read from the stream.

void DtRadarModeList::removeAndDeleteModes ( )
protected

removes and deletes all items from the list.

Non-virtual since it is called from constructors/destructor.

void DtRadarModeList::copyListItemsFrom ( const DtRadarModeList sourceList)
protected

Makes copies of all items on sourceList and adds them to this list.

Non-virtual since it is called from constructors.

virtual const char* DtRadarModeList::readerWriterType ( ) const
protectedvirtual

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.


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

Document ID: Generated on Mon Apr 8 19:24:01 EDT 2013 from SVN revision 125877
Copyright © 2005-2013 VT MÄK. All Rights Reserved (www.mak.com)