DtCommModelDescriptor Class Reference

Descriptor base class for DtRadio instances. More...

Inheritance diagram for DtCommModelDescriptor:

List of all members.

Public Member Functions
	DtCommModelDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtCommModelDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtCommModelDescriptor (const DtCommModelDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtCommModelDescriptor &	operator= (const DtCommModelDescriptor &orig)
	assignment
virtual	~DtCommModelDescriptor ()
virtual DtString	type () const
	Returns the type of this descriptor.
virtual DtCommModelDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.
virtual void	setCommModelType (const DtString &typeString)
	Accessor/mutator for myCommModelType.
virtual DtString	commModelType () const
	Accessor/mutator for myCommModelType.
virtual bool	publishTransmitters () const
	See myPublishTransmitters.
virtual void	setPublishTransmitters (bool value)
	See myPublishTransmitters.
Static Public Member Functions
static DtCommModelDescriptorFactory *	factory ()
	Factory used to generate new instances of DtCommModelDescriptor objects, based on the types defined in signaturePropagatorDescTypes.h.
static void	setFactory (DtCommModelDescriptorFactory *factory)
static DtCommModelDescriptor *	creator ()
static DtCommModelDescriptor *	createCommModelDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Uses the factory to create a new radio descriptor of the specified type.
static DtCommModelDescriptor *	createCommModelDescriptor (const char *typeString)
	Uses the factory to create a new radio descriptor of the specified type.
Protected Attributes
DtRwBoolean	myPublishTransmitters
	Parameter Name: publish-transmitters Parameter Description: Indicates whether or not radios using this comms model should publish a DIS/RPR transmitter object.
parameters
These parameters are available for setting in the OPD files.
DtRwString	myCommModelType
	Parameter Name: radio-network-type Parameter Description: String identifying type of radio network object.
Static Protected Attributes
static DtCommModelDescriptorFactory *	theFactory
Private Member Functions
	DtCommModelDescriptor ()
	default constructor; not implemented

---

Detailed Description

Descriptor base class for DtRadio instances.

A descriptor tells what type of radio to create as well as any parameters for the radio.

---

Constructor & Destructor Documentation

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

real constructor

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

DtCommModelDescriptor::DtCommModelDescriptor	(	const DtCommModelDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = NULL
	)

copy constructor

virtual DtCommModelDescriptor::~DtCommModelDescriptor

(

)

[virtual]

DtCommModelDescriptor::DtCommModelDescriptor

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

DtCommModelDescriptor& DtCommModelDescriptor::operator=

(

const DtCommModelDescriptor &

orig

)

assignment

virtual DtString DtCommModelDescriptor::type

(

)

const [virtual]

Returns the type of this descriptor.

Used to create the descriptor on read from an mtl file.

Reimplemented in DtExternalCommModelDescriptor, and DtSimpleRadioCommModelDescriptor.

virtual DtCommModelDescriptor* DtCommModelDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = NULL

)

const [virtual]

Reimplemented in DtExternalCommModelDescriptor, and DtSimpleRadioCommModelDescriptor.

virtual void DtCommModelDescriptor::setCommModelType

(

const DtString &

typeString

)

[virtual]

Accessor/mutator for myCommModelType.

virtual DtString DtCommModelDescriptor::commModelType

(

)

const [virtual]

Accessor/mutator for myCommModelType.

virtual bool DtCommModelDescriptor::publishTransmitters

(

)

const [virtual]

See myPublishTransmitters.

virtual void DtCommModelDescriptor::setPublishTransmitters

(

bool

value

)

[virtual]

See myPublishTransmitters.

virtual void DtCommModelDescriptor::putData	(	FILE *	fp,
		int	indentLevel = 0
	)		[virtual]

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

virtual DtlObjPtr DtCommModelDescriptor::getData	(	DtlObjPtr	args,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[virtual]

getData is just used to get us past the type in the data stream, since it's not actually stored.

virtual bool DtCommModelDescriptor::init

(

)

[virtual]

Base class init does nothing, but will be called by createSignaturePropagatorDescriptor(), allowing derived classes to do memory allocation if necessary.

static DtCommModelDescriptorFactory* DtCommModelDescriptor::factory

(

)

[static]

Factory used to generate new instances of DtCommModelDescriptor objects, based on the types defined in signaturePropagatorDescTypes.h.

Reimplemented from DtReaderWriter.

static void DtCommModelDescriptor::setFactory

(

DtCommModelDescriptorFactory *

factory

)

[static]

static DtCommModelDescriptor* DtCommModelDescriptor::createCommModelDescriptor	(	DtlObjPtr	mtlStream,
		const DtFilename &	searchPath,
		const DtVariableBindingsList &	variableBindings
	)		[static]

Uses the factory to create a new radio descriptor of the specified type.

static DtCommModelDescriptor* DtCommModelDescriptor::createCommModelDescriptor

(

const char *

typeString

)

[static]

Uses the factory to create a new radio descriptor of the specified type.

static DtCommModelDescriptor* DtCommModelDescriptor::creator

(

)

[static]

Returns:

A new instance of this class.

Reimplemented in DtExternalCommModelDescriptor, and DtSimpleRadioCommModelDescriptor.

---

Member Data Documentation

DtRwString DtCommModelDescriptor::myCommModelType [protected]

Parameter Name: radio-network-type
Parameter Description: String identifying type of radio network object.

Parameter Default Value:

DtRwBoolean DtCommModelDescriptor::myPublishTransmitters [protected]

Parameter Name: publish-transmitters
Parameter Description: Indicates whether or not radios using this comms model should publish a DIS/RPR transmitter object.

If true, the transmitter-params will be used to determine the attributes that are published. Default Value: False.

DtCommModelDescriptorFactory* DtCommModelDescriptor::theFactory [static, protected]

Reimplemented from DtReaderWriter.

---

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

• include/vrfobjparam/commModelDescriptor.h