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).

Inheritance diagram for DtVrfSubObjectParameterEntry:

[legend]

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

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

virtual	~DtVrfSubObjectParameterEntry ()

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

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

DtVrfSubObjectParameterEntry &	operator= (const DtVrfSubObjectParameterEntry &orig)

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

bool	operator!= (const DtVrfSubObjectParameterEntry &) const

virtual const char *	readerWriterType () const


virtual DtObjectType	objectType () const

virtual void	setObjectType (const DtObjectType &objectType)


virtual const DtVector &	positionOffset () const

virtual void	setPositionOffset (const DtVector &positionOffset)


virtual DtReal	headingOffset () const

virtual void	setHeadingOffset (DtReal headingOffset)


virtual const DtString &	functionHandle () const

virtual void	setFunctionHandle (const DtString &functionHandle)

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

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

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

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwObjectType	myObjectType

DtRwVector	myPositionOffset

DtRwReal	myHeadingOffset

DtRwString	myFunctionHandle

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

bool	myInvalid

bool	myChangedFlag

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 ()

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 (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

static bool	thePutIndent

static DtOutputStream *	theOutputStream

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.

virtual const DtString& DtVrfSubObjectParameterEntry::functionHandle ( ) const

virtual

Accessor/mutator for myFunctionHandle.

virtual void DtVrfSubObjectParameterEntry::setFunctionHandle ( const DtString & functionHandle )

virtual

Accessor/mutator for myFunctionHandle.

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.

Reimplemented from DtReaderWriter.

static const char* DtVrfSubObjectParameterEntry::theXmlType ( )

static

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

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.

DtRwString DtVrfSubObjectParameterEntry::myFunctionHandle

protected

Parameter Name:
Parameter Description: Function handle (key) for subordinate, found in "extra/subordinateFunctions.csv".
Parameter Default Value:
Parameter Units: string.

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/vrfSubObjectParameterEntry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation