DtExternalCommModelDescriptor Class Reference

DtExternalCommModelDescriptor.

Parameters for the DtExternalCommModel communications model.

Inheritance diagram for DtExternalCommModelDescriptor:

Public Member Functions
	DtExternalCommModelDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtExternalCommModelDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtExternalCommModelDescriptor (const DtExternalCommModelDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtExternalCommModelDescriptor &	operator= (const DtExternalCommModelDescriptor &orig)
virtual	~DtExternalCommModelDescriptor ()
virtual DtString	type () const
virtual DtExternalCommModelDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	useActualMessageSize () const
virtual void	setUseActualMessageSize (bool value)
virtual int	substituteMessageSize () const
virtual void	setSubstituteMessageSize (int value)
virtual double	messageTimeout () const
virtual void	setMessageTimeout (double value)
virtual bool	useReadyToSend () const
virtual void	setUseReadyToSend (bool value)
Public Member Functions inherited from DtCommModelDescriptor
	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 ()
virtual void	putData (std::string &fp, int indentLevel=0)
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
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 DtCommModelDescriptor *	creator ()
Static Public Member Functions inherited from DtCommModelDescriptor
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	myUseActualMessageSize
DtRwInt	mySubstituteMessageSize
DtRwReal	myMessageTimeout
DtRwBoolean	myUseReadyToSend
Protected Attributes inherited from DtCommModelDescriptor
DtRwBoolean	myPublishTransmitters
DtRwBoolean	mySendReceivedCommMessageOnBroadcast
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

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)
Static Protected Attributes inherited from DtCommModelDescriptor
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

Constructor & Destructor Documentation

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

real constructor

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

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

copy constructor

virtual DtExternalCommModelDescriptor::~DtExternalCommModelDescriptor ( )

virtual

Member Function Documentation

DtExternalCommModelDescriptor& DtExternalCommModelDescriptor::operator=

(

const DtExternalCommModelDescriptor &

orig

)

assignment

virtual DtString DtExternalCommModelDescriptor::type ( ) const

virtual

Returns the type of this descriptor. Used to create the descriptor on read from an mtl file.

Reimplemented from DtCommModelDescriptor.

virtual DtExternalCommModelDescriptor* DtExternalCommModelDescriptor::clone ( DtReaderWriterRegistry *  parentRegistry = NULL ) const

virtual

Reimplemented from DtCommModelDescriptor.

static DtCommModelDescriptor* DtExternalCommModelDescriptor::creator ( )

static

Returns

A new instance of this class.

virtual bool DtExternalCommModelDescriptor::useActualMessageSize ( ) const

virtual

See myUseActualMessageSize.

virtual void DtExternalCommModelDescriptor::setUseActualMessageSize ( bool  value )

virtual

See myUseActualMessageSize.

virtual int DtExternalCommModelDescriptor::substituteMessageSize ( ) const

virtual

See mySubstituteMessageSize.

virtual void DtExternalCommModelDescriptor::setSubstituteMessageSize ( int  value )

virtual

See mySubstituteMessageSize.

virtual double DtExternalCommModelDescriptor::messageTimeout ( ) const

virtual

See myMessageTimeout.

virtual void DtExternalCommModelDescriptor::setMessageTimeout ( double  value )

virtual

See myMessageTimeout.

virtual bool DtExternalCommModelDescriptor::useReadyToSend ( ) const

virtual

See myUseReadyToSend.

virtual void DtExternalCommModelDescriptor::setUseReadyToSend ( bool  value )

virtual

See myUseReadyToSend.

Member Data Documentation

DtRwBoolean DtExternalCommModelDescriptor::myUseActualMessageSize

protected

Parameter Name: use-actual-message-size
Parameter Description: Indicates whether the communication model should model the size of messages sent to be the actual number of bytes the message takes up, or if it should use another value, specified in the substitute-message-size parameter.
Default Value: True.

DtRwInt DtExternalCommModelDescriptor::mySubstituteMessageSize

protected

Parameter Name: substitute-message-size
Parameter Description: Used only if use-actual-message-size is false. All messages will be modeled as if they were this many bytes.
Parameter Units: bytes.
Default Value: 512.

DtRwReal DtExternalCommModelDescriptor::myMessageTimeout

protected

Parameter Name: message-timeout
Parameter Description: The timeout value passed to the external comms effects server for any messages sent by this comm model. If messages are not received within the timeout value from when they are sent, they are dropped.
Parameter Units: seconds
Default Value: 30 seconds.

DtRwBoolean DtExternalCommModelDescriptor::myUseReadyToSend

protected

Parameter Name: use-ready-to-send
Parameter Description: If True, each radio may only send after the external comms model has send a Ready To Send Signal message indicating that particular radio may send. If false, then Ready To Send Signal messages are not needed from the external comms model, and messages are sent as soon as they are requested to be sent. This should be configured to match the external comms model. Default Value: True.

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfobjparam/externalCommModelDescriptor.h