DtVrfSubObjectParameterEntry Class Reference

DtVrfSubObjectParameterEntry. More...

Inheritance diagram for DtVrfSubObjectParameterEntry:

Public Member Functions
	DtVrfSubObjectParameterEntry (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	constructor with parameters to set up read/writability correctly
	DtVrfSubObjectParameterEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual	~DtVrfSubObjectParameterEntry ()
	destructor
	DtVrfSubObjectParameterEntry (const DtVrfSubObjectParameterEntry &orig, const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor. Use clone instead...
	DtVrfSubObjectParameterEntry (const DtVrfSubObjectParameterEntry &orig, const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
DtVrfSubObjectParameterEntry &	operator= (const DtVrfSubObjectParameterEntry &orig)
	assignment operator
virtual DtVrfSubObjectParameterEntry *	clone (const DtString &name=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtVrfSubObjectParameterEntry *	clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
bool	operator== (const DtVrfSubObjectParameterEntry &) const
	Equivalence operators.
bool	operator!= (const DtVrfSubObjectParameterEntry &) const
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtObjectType	objectType () const
	Accessor/mutator for myObjectType.
virtual void	setObjectType (const DtObjectType &objectType)
	Accessor/mutator for myObjectType.
virtual const DtVector &	positionOffset () const
	Accessor/mutator for myPositionOffset.
virtual void	setPositionOffset (const DtVector &positionOffset)
	Accessor/mutator for myPositionOffset.
virtual DtReal	headingOffset () const
	Accessor/mutator for myHeadingOffset.
virtual void	setHeadingOffset (DtReal headingOffset)
	Accessor/mutator for myHeadingOffset.
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
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 void	addAlias (const DtString &alias)
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 void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
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	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myObjectType
	Parameter Name: Parameter Description: DIS/RPR object type for this subobject.
DtRwVector	myPositionOffset
	Parameter Name: Parameter Description: Position offset of subobject, in body coordinates of the parent object.
DtRwReal	myHeadingOffset
	Parameter Name: Parameter Description: Heading offset relative to the parent entity.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.
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())
virtual const char *	xmlType () const
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.

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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
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 ()
static void	cleanupFactory ()
static DtReaderWriterFactory *	factory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
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

Detailed Description

DtVrfSubObjectParameterEntry.

Instances of DtVrfSubObjectParameterEntry are the readable/writeable objects that populate the subordinate and attachment list of the DtVrfObjectParameters class. Each entry specifies a subobject to be created when fully instantiating an aggregate object (as opposed to building such an entity from the bottom up, using aggregateAs). The entry contains an object type, a position offset, and a heading offset (offsets with respect to the parent objects position and heading).

Constructor & Destructor Documentation

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

constructor with parameters to set up read/writability correctly

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

virtual DtVrfSubObjectParameterEntry::~DtVrfSubObjectParameterEntry ( )

virtual

destructor

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

copy constructor. Use clone instead...

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

Member Function Documentation

DtVrfSubObjectParameterEntry& DtVrfSubObjectParameterEntry::operator=

(

const DtVrfSubObjectParameterEntry &

orig

)

assignment operator

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

virtual

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

virtual

virtual DtObjectType DtVrfSubObjectParameterEntry::objectType ( ) const

virtual

Accessor/mutator for myObjectType.

virtual void DtVrfSubObjectParameterEntry::setObjectType ( const DtObjectType &  objectType )

virtual

Accessor/mutator for myObjectType.

virtual const DtVector& DtVrfSubObjectParameterEntry::positionOffset ( ) const

virtual

Accessor/mutator for myPositionOffset.

virtual void DtVrfSubObjectParameterEntry::setPositionOffset ( const DtVector &  positionOffset )

virtual

Accessor/mutator for myPositionOffset.

virtual DtReal DtVrfSubObjectParameterEntry::headingOffset ( ) const

virtual

Accessor/mutator for myHeadingOffset.

virtual void DtVrfSubObjectParameterEntry::setHeadingOffset ( DtReal  headingOffset )

virtual

Accessor/mutator for myHeadingOffset.

bool DtVrfSubObjectParameterEntry::operator==

(

const DtVrfSubObjectParameterEntry &

)

const

Equivalence operators.

bool DtVrfSubObjectParameterEntry::operator!=

(

const DtVrfSubObjectParameterEntry &

)

const

virtual const char* DtVrfSubObjectParameterEntry::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 DtReaderWriter.

virtual void DtVrfSubObjectParameterEntry::putData ( DtEnvironmentSP  , DtEnvValueSP  parent  ) const

virtual

Routines to archive/dearchive from an XML Environment

Reimplemented from DtReaderWriter.

virtual void DtVrfSubObjectParameterEntry::getData ( const DtEnvironmentSP  , const DtEnvValueSP  value, const DtReaderWriter::SearchPaths &  searchPaths = DtReaderWriter::SearchPaths(), const DtVariableBindingsList &  bindings = DtVariableBindingsList()  )

virtual

Routines to archive/dearchive from an XML Environment

static const char* DtVrfSubObjectParameterEntry::theXmlType ( )

static

The type that is used when archiving to an XML stream.

Reimplemented from DtReaderWriter.

virtual const char* DtVrfSubObjectParameterEntry::xmlType ( ) const

inlinevirtual

Routines to archive/dearchive from an XML Environment

Reimplemented from DtReaderWriter.

References DtReaderWriter::theXmlType().

Member Data Documentation

DtRwObjectType DtVrfSubObjectParameterEntry::myObjectType

protected

Parameter Name:
Parameter Description: DIS/RPR object type for this subobject.

Used to supply an entity type to the subobject, as well as to look up its parameters.
Parameter Default Value:

DtRwVector DtVrfSubObjectParameterEntry::myPositionOffset

protected

Parameter Name:
Parameter Description: Position offset of subobject, in body coordinates of the parent object.

Parameter Default Value:
Parameter Units: meters

DtRwReal DtVrfSubObjectParameterEntry::myHeadingOffset

protected

Parameter Name:
Parameter Description: Heading offset relative to the parent entity.

Parameter Default Value:
Parameter Units: radians

---

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

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