VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions
DtTargetPriorityEntry Class Reference

DtTargetPriorityEntry; readable/writeable representation of a prioritized entity type. More...

Inheritance diagram for DtTargetPriorityEntry:
Inheritance graph
[legend]

Public Member Functions

 DtTargetPriorityEntry ()
 default constructor
 DtTargetPriorityEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
 real constructor
 DtTargetPriorityEntry (const DtString &name, const DtTargetPriorityEntry &orig, DtReaderWriterRegistry *parentRegistry=0)
 copy constructor
const DtTargetPriorityEntryoperator= (const DtTargetPriorityEntry &orig)
 assignment operator
virtual ~DtTargetPriorityEntry ()
virtual DtTargetPriorityEntryclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=0) const
virtual void setEntityType (const DtEntityType &entityType)
 Accessor/mutator for myEntityType.
virtual const DtRwEntityTypeentityType () const
 Accessor/mutator for myEntityType.
virtual void setPriority (int priority)
 Accessor/mutator for myPriority.
virtual int priority () const
 Accessor/mutator for myPriority.
- 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 getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
 Top level to read itself from an input stream.
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 const char * readerWriterType () const
 Used to supply a string type that this reader writer type is.
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 Attributes

Parameters

These parameters are available for setting in the OPD files.

DtRwEntityType myEntityType
 Parameter Name: entity-type
Parameter Description: DIS/RPR enumerated entity type associated with priority value.
DtRwInt myPriority
 Parameter Name: priority
Parameter Description: The priority assigned to this entity type when creating the target-list.
- 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.

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 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.
virtual DtlObjPtr getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Deriving class overrides these to get/put class specific data.
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static DtReaderWriterFactory theFactory

Detailed Description

DtTargetPriorityEntry; readable/writeable representation of a prioritized entity type.

DtTargetPriorityEntry is a readable/writable doublet of DtEntityType and an integer priority. The DtTargetPriorityList is a list of these types.

Constructor & Destructor Documentation

DtTargetPriorityEntry::DtTargetPriorityEntry ( )

default constructor

DtTargetPriorityEntry::DtTargetPriorityEntry ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
)

real constructor

DtTargetPriorityEntry::DtTargetPriorityEntry ( const DtString name,
const DtTargetPriorityEntry orig,
DtReaderWriterRegistry parentRegistry = 0 
)

copy constructor

virtual DtTargetPriorityEntry::~DtTargetPriorityEntry ( )
virtual

Member Function Documentation

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

assignment operator

virtual DtTargetPriorityEntry* DtTargetPriorityEntry::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = 0 
) const
virtual
virtual void DtTargetPriorityEntry::setEntityType ( const DtEntityType &  entityType)
virtual

Accessor/mutator for myEntityType.

virtual const DtRwEntityType& DtTargetPriorityEntry::entityType ( ) const
virtual

Accessor/mutator for myEntityType.

virtual void DtTargetPriorityEntry::setPriority ( int  priority)
virtual

Accessor/mutator for myPriority.

virtual int DtTargetPriorityEntry::priority ( ) const
virtual

Accessor/mutator for myPriority.

Member Data Documentation

DtRwEntityType DtTargetPriorityEntry::myEntityType
protected

Parameter Name: entity-type
Parameter Description: DIS/RPR enumerated entity type associated with priority value.


Parameter Default Value:

DtRwInt DtTargetPriorityEntry::myPriority
protected

Parameter Name: priority
Parameter Description: The priority assigned to this entity type when creating the target-list.


Parameter Default Value: 0


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

Document ID: Generated on Tue Jan 29 18:21:16 EST 2013 from SVN revision 123193
Copyright © 2005-2013 VT MÄK Inc. All Rights Reserved (www.mak.com)