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)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (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 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 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 DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

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
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 DtReaderWriterFactory *	factory ()
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

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.

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:

• include/vrfutil/subObjEntry.h