DtSubordinateEntry Class Reference

Inheritance diagram for DtSubordinateEntry:

Public Member Functions
	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 DtSubordinateEntry &	operator= (const DtSubordinateEntry &orig)
	assignment operator
virtual	~DtSubordinateEntry ()
virtual DtSubordinateEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtSubordinateEntry *	clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtPoint	positionOffset (const DtPoint &accumOffset=DtPoint(0, 0, 0)) const
virtual void	setPositionOffset (const DtVector &offset=DtVector(0, 0, 0))
virtual const DtString &	subordinateEntryType () const
	Accessor/mutator for mySubordinateEntryType.
virtual void	setSubordinateEntryType (const DtString &entryType)
	Accessor/mutator for mySubordinateEntryType.
virtual const DtRwObjectType &	subordinateType () 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 DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
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 aliasContainer &	aliases () 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 void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
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 DtSubordinateEntry *	createSubordinateEntry (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 DtSubordinateEntry *	createSubordinateEntry (const char *pName)
	Creates and initializes a new instance of this class.
static DtSubordinateEntryFactory *	factory ()
	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.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

Protected Attributes
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.

Static Protected Attributes
static DtSubordinateEntryFactory *	myFactory
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

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
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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.

Constructor & Destructor Documentation

DtSubordinateEntry::DtSubordinateEntry

(

)

default constructor

DtSubordinateEntry::DtSubordinateEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

real constructor

DtSubordinateEntry::DtSubordinateEntry	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

DtSubordinateEntry::DtSubordinateEntry	(	const DtString &	name,
		const DtSubordinateEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

DtSubordinateEntry::DtSubordinateEntry	(	const DtSymbolString &	name,
		const DtSubordinateEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

virtual DtSubordinateEntry::~DtSubordinateEntry ( )

virtual

Member Function Documentation

const DtSubordinateEntry& DtSubordinateEntry::operator=

(

const DtSubordinateEntry &

orig

)

assignment operator

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

virtual

Reimplemented in DtSubordinateIndividualEntry, and DtSubordinateAggregateEntry.

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

virtual

Reimplemented in DtSubordinateIndividualEntry, and DtSubordinateAggregateEntry.

virtual const DtString& DtSubordinateEntry::subordinateEntryType ( ) const

virtual

Accessor/mutator for mySubordinateEntryType.

virtual void DtSubordinateEntry::setSubordinateEntryType ( const DtString &  entryType )

virtual

Accessor/mutator for mySubordinateEntryType.

virtual const DtRwObjectType& DtSubordinateEntry::subordinateType ( ) const

virtual

Accessor/mutator for mySubordinateType.

virtual void DtSubordinateEntry::setSubordinateType ( const DtObjectType &  subordinateType )

virtual

Accessor/mutator for mySubordinateType.

virtual bool DtSubordinateEntry::isDestroyed ( ) const

virtual

Accessor/mutator for myDestroyed.

virtual void DtSubordinateEntry::setDestroyed ( bool  trueFalse )

virtual

Accessor/mutator for myDestroyed.

virtual DtPoint DtSubordinateEntry::positionOffset ( const DtPoint &  accumOffset = DtPoint(0, 0, 0) ) const

virtual

virtual void DtSubordinateEntry::setPositionOffset ( const DtVector &  offset = DtVector(0, 0, 0) )

virtual

static void DtSubordinateEntry::addSubordinateEntryCreatorFcn ( const DtString &  type, DtSubordinateEntryCreatorFcn  fcn  )

static

Adds a given subordinate entry creation function and corresponding type (defined in trueAggregateTypes.h) to the DtSubordinateEntryFactory.

static DtSubordinateEntryFactory* DtSubordinateEntry::factory ( )

static

The factory for creating objects of type DtSubordinateEntry.

The factory is used to generate subordinate entrys on demand, when reading in parameter database files.

Reimplemented from DtReaderWriter.

static void DtSubordinateEntry::setFactory ( DtSubordinateEntryFactory *  factory )

static

The factory for creating objects of type DtSubordinateEntry.

The factory is used to generate subordinate entrys on demand, when reading in parameter database files.

static DtSubordinateEntry* DtSubordinateEntry::createSubordinateEntry ( DtlObjPtr  mtlStream, const DtFilename &  searchPath, const DtVariableBindingsList &  variableBindings  )

static

Creates and initializes a subordinate entry when reading in from an MTL (MAK Technologies Lisp) file (i.e.

a parameter database file).

Parameters

mtlStream	Input stream from an MTL file.
searchPath	Path at which any DtReaderWriterFile items should be searched for if encountered when parsing the mtlStream.

Returns

Newly created and intialized instance of this class, with data read in from the MTL stream.

static DtSubordinateEntry* DtSubordinateEntry::createSubordinateEntry ( const char *  pName )

static

Creates and initializes a new instance of this class.

Parameters

pName

DtReaderWriter name of the component. The name appears as the first string of a subordinate entry

Returns

Newly created and intialized instance of this class.

Member Data Documentation

DtRwString DtSubordinateEntry::mySubordinateEntryType

protected

Parameter Name: subordinate-entry-type
Parameter Description: explicit string of entry types "aggregate" or "individual" Parameter Default Value:
.

DtRwObjectType DtSubordinateEntry::mySubordinateType

protected

Parameter Name: Subordinate-type
Parameter Description: DIS/RPR entity type enumeration representing the kind of entity to Subordinate.

Parameter Default Value:

DtRwBoolean DtSubordinateEntry::myDestroyed

protected

Parameter Name: is-destroyed
Parameter Description: true if the entity is destroyed
Parameter Default Value: false
.

DtRwVector DtSubordinateEntry::myPositionOffset

protected

offset from parent;

DtSubordinateEntryFactory* DtSubordinateEntry::myFactory

staticprotected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/trueAggregateSubordinateEntry.h