Descriptor base class for DtRadio instances. A descriptor tells what type of radio to create as well as any parameters for the radio.

Inheritance diagram for DtCommModelDescriptor:

[legend]

Public Member Functions
	DtCommModelDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)

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

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

DtCommModelDescriptor &	operator= (const DtCommModelDescriptor &orig)

virtual	~DtCommModelDescriptor () override

virtual DtString	type () const

virtual DtCommModelDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const

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

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

virtual bool	init ()


virtual void	setCommModelType (const DtString &typeString)

virtual DtString	commModelType () const


virtual bool	publishTransmitters () const

virtual void	setPublishTransmitters (bool value)


virtual bool	sendReceivedCommMessageOnBroadcast () const

virtual void	setSendReceivedCommMessageOnBroadcast (bool)

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

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 const char *	readerWriterType () const

virtual const char *	xmlType () const

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	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	putData (DtEnvironmentSP, DtEnvValueSP value) 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	getData (const DtEnvironmentSP, const DtEnvValueSP, 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)

Static Public Member Functions
static DtCommModelDescriptorFactory *	factory ()

static void	setFactory (DtCommModelDescriptorFactory *factory)

static DtCommModelDescriptor *	creator ()


static DtCommModelDescriptor *	createCommModelDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

static DtCommModelDescriptor *	createCommModelDescriptor (const char *typeString)

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 Attributes
DtRwBoolean	myPublishTransmitters

DtRwBoolean	mySendReceivedCommMessageOnBroadcast

parameters
These parameters are available for setting in the OPD files.
DtRwString	myCommModelType

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

Static Protected Attributes
static DtCommModelDescriptorFactory *	theFactory

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

Private Member Functions
	DtCommModelDescriptor ()

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

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

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

overridevirtual

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 bool DtCommModelDescriptor::sendReceivedCommMessageOnBroadcast ( ) const

virtual

See mySendReceivedCommMessageOnBroadcast.

virtual void DtCommModelDescriptor::setSendReceivedCommMessageOnBroadcast ( bool )

virtual

See mySendReceivedCommMessageOnBroadcast.

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

overridevirtual

Overrides base class putData to output our type.

Reimplemented from DtReaderWriter.

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

overridevirtual

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

Reimplemented from DtReaderWriter.

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.

static void DtCommModelDescriptor::setFactory ( DtCommModelDescriptorFactory * factory )

static

static DtCommModelDescriptor* DtCommModelDescriptor::createCommModelDescriptor	(	DtlObjPtr	mtlStream,
		const DtReaderWriter::SearchPaths &	searchPaths,
		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.

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.

DtRwBoolean DtCommModelDescriptor::mySendReceivedCommMessageOnBroadcast

protected

Parameter Name: send-received-comm-message-on-broadcast
Parameter Description: If the message being sent is a broadcast message, whether or not to send a message to the VR-Forces GUI (DtIfRadioMessageReceived) to draw a comm line. Default Value: False.

DtCommModelDescriptorFactory* DtCommModelDescriptor::theFactory

staticprotected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfobjparam/commModelDescriptor.h

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation