DtExternalCommModelDescriptor Class Reference

DtExternalCommModelDescriptor. More...

Inheritance diagram for DtExternalCommModelDescriptor:

Public Member Functions
	DtExternalCommModelDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	real constructor
	DtExternalCommModelDescriptor (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
	DtExternalCommModelDescriptor (const DtExternalCommModelDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtExternalCommModelDescriptor &	operator= (const DtExternalCommModelDescriptor &orig)
	assignment
virtual	~DtExternalCommModelDescriptor ()
virtual DtString	type () const
	Returns the type of this descriptor.
virtual DtExternalCommModelDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual bool	useActualMessageSize () const
	See myUseActualMessageSize.
virtual void	setUseActualMessageSize (bool value)
	See myUseActualMessageSize.
virtual int	substituteMessageSize () const
	See mySubstituteMessageSize.
virtual void	setSubstituteMessageSize (int value)
	See mySubstituteMessageSize.
virtual double	messageTimeout () const
	See myMessageTimeout.
virtual void	setMessageTimeout (double value)
	See myMessageTimeout.
virtual bool	useReadyToSend () const
	See myUseReadyToSend.
virtual void	setUseReadyToSend (bool value)
	See myUseReadyToSend.
Public Member Functions inherited from DtCommModelDescriptor
	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 void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, 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.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
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())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtCommModelDescriptor *	creator ()
Static Public Member Functions inherited from DtCommModelDescriptor
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 *	createCommModelDescriptor (DtlObjPtr mtlStream, const DtReaderWriter::SearchPaths &searchPaths, 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.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()
static void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Attributes
DtRwBoolean	myUseActualMessageSize
	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.
DtRwInt	mySubstituteMessageSize
	Parameter Name: substitute-message-size Parameter Description: Used only if use-actual-message-size is false.
DtRwReal	myMessageTimeout
	Parameter Name: message-timeout Parameter Description: The timeout value passed to the external comms effects server for any messages sent by this comm model.
DtRwBoolean	myUseReadyToSend
	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.
Protected Attributes inherited from DtCommModelDescriptor
DtRwBoolean	myPublishTransmitters
	Parameter Name: publish-transmitters Parameter Description: Indicates whether or not radios using this comms model should publish a DIS/RPR transmitter object.
DtRwString	myCommModelType
	Parameter Name: radio-network-type Parameter Description: String identifying type of radio network object.
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
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

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)
	Copies values from the specified DtReaderWriter.
Static Protected Attributes inherited from DtCommModelDescriptor
static DtCommModelDescriptorFactory *	theFactory

Detailed Description

DtExternalCommModelDescriptor.

Parameters for the DtExternalCommModel communications model.

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.

Reimplemented from DtCommModelDescriptor.

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:

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrfobjparam/externalCommModelDescriptor.h