DtEmbarkationDescriptor Class Reference

Instances of DtEmbarkationDescriptor are used to specify the parameters for a DtEmbarkationController object. More...

Inheritance diagram for DtEmbarkationDescriptor:

List of all members.

Public Member Functions
	DtEmbarkationDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtEmbarkationDescriptor (const DtEmbarkationDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtEmbarkationDescriptor &	operator= (const DtEmbarkationDescriptor &orig)
	assignment
virtual	~DtEmbarkationDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual double	responseTimeout () const
	Accessor/mutator for myResponseTimeout.
virtual void	setResponseTimeout (double value)
	Accessor/mutator for myResponseTimeout.
virtual int	responseRetries () const
	Accessor/mutator for myResponseRetries.
virtual void	setResponseRetries (int value)
	Accessor/mutator for myResponseRetries.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	myResponseTimeout
	Parameter Name: response-timeout Parameter Description: Should set the timeout period for waiting for a response for request for embarkation before making another request.
DtRwInt	myResponseRetries
	Parameter Name: response-retries Parameter Description: Sets the number of retries for sending an embarkation response request.
Private Member Functions
	DtEmbarkationDescriptor ()
	default constructor; not implemented

---

Detailed Description

Instances of DtEmbarkationDescriptor are used to specify the parameters for a DtEmbarkationController object.

---

Constructor & Destructor Documentation

DtEmbarkationDescriptor::DtEmbarkationDescriptor	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

DtEmbarkationDescriptor::DtEmbarkationDescriptor	(	const DtEmbarkationDescriptor &	orig,
		DtReaderWriterRegistry *	parentRegistry = 0
	)

copy constructor

virtual DtEmbarkationDescriptor::~DtEmbarkationDescriptor

(

)

[virtual]

destructor

DtEmbarkationDescriptor::DtEmbarkationDescriptor

(

)

[private]

default constructor; not implemented

---

Member Function Documentation

DtEmbarkationDescriptor& DtEmbarkationDescriptor::operator=

(

const DtEmbarkationDescriptor &

orig

)

assignment

virtual DtString DtEmbarkationDescriptor::type

(

)

const [virtual]

Returns the type of component this descriptor describes.

Used to create the descriptor on read from an mtl file. Component descriptor type strings are defined in compDescTypes.h.

Returns:

DtEmbarkationDescriptorType

Reimplemented from DtComponentDescriptor.

Reimplemented in DtAggregateEmbarkationDescriptor.

virtual DtComponentDescriptor* DtEmbarkationDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

Reimplemented in DtAggregateEmbarkationDescriptor.

static DtComponentDescriptor* DtEmbarkationDescriptor::creator

(

)

[static]

Returns:

Newly created instance of this class, with an empty DtReaderWriter name. Creation methods are registered with a DtComponentDescriptorFactory, so they can be created on demand as they are read in from a parameter database file.

Reimplemented from DtComponentDescriptor.

Reimplemented in DtAggregateEmbarkationDescriptor.

virtual double DtEmbarkationDescriptor::responseTimeout

(

)

const [virtual]

Accessor/mutator for myResponseTimeout.

virtual void DtEmbarkationDescriptor::setResponseTimeout

(

double

value

)

[virtual]

Accessor/mutator for myResponseTimeout.

virtual int DtEmbarkationDescriptor::responseRetries

(

)

const [virtual]

Accessor/mutator for myResponseRetries.

virtual void DtEmbarkationDescriptor::setResponseRetries

(

int

value

)

[virtual]

Accessor/mutator for myResponseRetries.

---

Member Data Documentation

DtRwReal DtEmbarkationDescriptor::myResponseTimeout [protected]

Parameter Name: response-timeout
Parameter Description: Should set the timeout period for waiting for a response for request for embarkation before making another request.

Parameter Default Value: 1.0
Parameter Units: seconds

DtRwInt DtEmbarkationDescriptor::myResponseRetries [protected]

Parameter Name: response-retries
Parameter Description: Sets the number of retries for sending an embarkation response request.

Parameter Default Value: 1

---

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

• include/vrfobjparam/embarkationDesc.h