VR-Forces 4.1 Class Documentation
List of all members | Public Member Functions | Static Public Member Functions | Protected Attributes
DtSubordinateIndividualEntry Class Reference
Inheritance diagram for DtSubordinateIndividualEntry:
Inheritance graph
[legend]

Public Member Functions

 DtSubordinateIndividualEntry ()
 default constructor
 DtSubordinateIndividualEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtSubordinateIndividualEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtSubordinateIndividualEntry (const DtString &name, const DtSubordinateIndividualEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtSubordinateIndividualEntry (const DtSymbolString &name, const DtSubordinateIndividualEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const
DtSubordinateIndividualEntry
operator= (const DtSubordinateIndividualEntry &orig)
 assignment operator
virtual ~DtSubordinateIndividualEntry ()
virtual
DtSubordinateIndividualEntry
clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual
DtSubordinateIndividualEntry
clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtAggregatedResourceListgetResourceList ()
 Accessor/mutator for myResourceList.
- Public Member Functions inherited from DtSubordinateEntry
 DtSubordinateEntry ()
 default constructor
 DtSubordinateEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtSubordinateEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtSubordinateEntry (const DtString &name, const DtSubordinateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtSubordinateEntry (const DtSymbolString &name, const DtSubordinateEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtSubordinateEntryoperator= (const DtSubordinateEntry &orig)
 assignment operator
virtual ~DtSubordinateEntry ()
virtual DtPoint positionOffset (const DtPoint &accumOffset=DtPoint(0, 0, 0)) const
virtual void setPositionOffset (const DtVector &offset=DtVector(0, 0, 0))
virtual const DtStringsubordinateEntryType () const
 Accessor/mutator for mySubordinateEntryType.
virtual void setSubordinateEntryType (const DtString &entryType)
 Accessor/mutator for mySubordinateEntryType.
virtual const DtRwObjectTypesubordinateType () const
 Accessor/mutator for mySubordinateType.
virtual void setSubordinateType (const DtObjectType &subordinateType)
 Accessor/mutator for mySubordinateType.
virtual bool isDestroyed () const
 Accessor/mutator for myDestroyed.
virtual void setDestroyed (bool trueFalse)
 Accessor/mutator for myDestroyed.
- 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.

Static Public Member Functions

static
DtSubordinateIndividualEntry
createSubordinateEntry (const DtString &rwName, DtReaderWriterRegistry *parentRegistry)
static DtSubordinateEntrycreator ()
- Static Public Member Functions inherited from DtSubordinateEntry
static void addSubordinateEntryCreatorFcn (const DtString &type, DtSubordinateEntryCreatorFcn fcn)
 Adds a given subordinate entry creation function and corresponding type (defined in trueAggregateTypes.h) to the DtSubordinateEntryFactory.
static DtSubordinateEntrycreateSubordinateEntry (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
 Creates and initializes a subordinate entry when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtSubordinateEntrycreateSubordinateEntry (const char *pName)
 Creates and initializes a new instance of this class.
static DtSubordinateEntryFactoryfactory ()
 The factory for creating objects of type DtSubordinateEntry.
static void setFactory (DtSubordinateEntryFactory *factory)
 The factory for creating objects of type DtSubordinateEntry.
- 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.

Protected Attributes

DtAggregatedResourceList myResourceList
 Parameter Name: resources
Parameter Description: List of all resources
Parameter Default Value:
.
- Protected Attributes inherited from DtSubordinateEntry
DtRwString mySubordinateEntryType
 Parameter Name: subordinate-entry-type
Parameter Description: explicit string of entry types "aggregate" or "individual" Parameter Default Value:
.
DtRwObjectType mySubordinateType
 Parameter Name: Subordinate-type
Parameter Description: DIS/RPR entity type enumeration representing the kind of entity to Subordinate.
DtRwBoolean myDestroyed
 Parameter Name: is-destroyed
Parameter Description: true if the entity is destroyed
Parameter Default Value: false
.
DtRwVector myPositionOffset
 offset from parent;
- 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
- 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 DtSubordinateEntry
static DtSubordinateEntryFactorymyFactory

Constructor & Destructor Documentation

DtSubordinateIndividualEntry::DtSubordinateIndividualEntry ( )

default constructor

DtSubordinateIndividualEntry::DtSubordinateIndividualEntry ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

DtSubordinateIndividualEntry::DtSubordinateIndividualEntry ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
)
DtSubordinateIndividualEntry::DtSubordinateIndividualEntry ( const DtString name,
const DtSubordinateIndividualEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor

DtSubordinateIndividualEntry::DtSubordinateIndividualEntry ( const DtSymbolString name,
const DtSubordinateIndividualEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)
virtual DtSubordinateIndividualEntry::~DtSubordinateIndividualEntry ( )
virtual

Member Function Documentation

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

assignment operator

virtual DtSubordinateIndividualEntry* DtSubordinateIndividualEntry::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual

Reimplemented from DtSubordinateEntry.

virtual DtSubordinateIndividualEntry* DtSubordinateIndividualEntry::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const
virtual

Reimplemented from DtSubordinateEntry.

virtual DtAggregatedResourceList& DtSubordinateIndividualEntry::getResourceList ( )
virtual

Accessor/mutator for myResourceList.

static DtSubordinateIndividualEntry* DtSubordinateIndividualEntry::createSubordinateEntry ( const DtString rwName,
DtReaderWriterRegistry parentRegistry 
)
static
static DtSubordinateEntry* DtSubordinateIndividualEntry::creator ( )
static

Member Data Documentation

DtAggregatedResourceList DtSubordinateIndividualEntry::myResourceList
protected

Parameter Name: resources
Parameter Description: List of all resources
Parameter Default Value:
.


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)