DtSubordinateEntry Class Reference

Inheritance diagram for DtSubordinateEntry:

List of all members.

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

---

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 [static, protected]

---

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

• include/vrfutil/trueAggregateSubordinateEntry.h