DtExternalCommModelDescriptor Class Reference

DtExternalCommModelDescriptor. More...

Inheritance diagram for DtExternalCommModelDescriptor:

List of all members.

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.
Static Public Member Functions
static DtCommModelDescriptor *	creator ()
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.

---

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:

• include/vrfobjparam/externalCommModelDescriptor.h