DtVrfSubObjectParameterEntry Class Reference

DtVrfSubObjectParameterEntry. More...

Inheritance diagram for DtVrfSubObjectParameterEntry:

List of all members.

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

---

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