DtVrfObjectDataMessengerDescriptor Class Reference

DtVrfObjectDataMessengerDescriptor; descriptor for the DtCustomReportSpotReportGeneratorController component. More...

Inheritance diagram for DtVrfObjectDataMessengerDescriptor:

List of all members.

Public Member Functions
	DtVrfObjectDataMessengerDescriptor (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtVrfObjectDataMessengerDescriptor (const DtVrfObjectDataMessengerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	Copy constructor.
DtVrfObjectDataMessengerDescriptor &	operator= (const DtVrfObjectDataMessengerDescriptor &orig)
	Assignment operator.
virtual	~DtVrfObjectDataMessengerDescriptor ()
	Destructor.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
	Returns a copy of this class using the copy constructor.
virtual DtString	type () const
	Returns the type of component this descriptor describes.
DtTime	maxSendInterval () const
	Longest period of time to wait before resending message.
void	setMaxSendInterval (DtTime ival)
	Longest period of time to wait before resending message.
DtTime	minSendInterval () const
	Shortest period of time to wait before resending message.
void	setMinSendInterval (DtTime ival)
	Shortest period of time to wait before resending message.
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Attributes
DtRwReal	myMaxSendInterval
	Parameter Name: "max-send-interval" Parameter Description: Maximum time before resending message.
DtRwReal	myMinSendInterval
	Parameter Name: "min-send-interval" Parameter Description: Smallest amount of time to wait before sending message.

---

Detailed Description

DtVrfObjectDataMessengerDescriptor; descriptor for the DtCustomReportSpotReportGeneratorController component.

Instances of DtVrfObjectDataMessengerDescriptor are used to specify the parameters for a DtCustomReportSpotReportGeneratorController object.

---

Constructor & Destructor Documentation

DtVrfObjectDataMessengerDescriptor::DtVrfObjectDataMessengerDescriptor	(	const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

Constructor.

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

Copy constructor.

virtual DtVrfObjectDataMessengerDescriptor::~DtVrfObjectDataMessengerDescriptor

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtVrfObjectDataMessengerDescriptor& DtVrfObjectDataMessengerDescriptor::operator=

(

const DtVrfObjectDataMessengerDescriptor &

orig

)

Assignment operator.

virtual DtComponentDescriptor* DtVrfObjectDataMessengerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Returns a copy of this class using the copy constructor.

Reimplemented from DtComponentDescriptor.

virtual DtString DtVrfObjectDataMessengerDescriptor::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:

DtVrfObjectDataMessengerDescriptorType

Reimplemented from DtComponentDescriptor.

static DtComponentDescriptor* DtVrfObjectDataMessengerDescriptor::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.

DtTime DtVrfObjectDataMessengerDescriptor::maxSendInterval

(

)

const [inline]

Longest period of time to wait before resending message.

References myMaxSendInterval, and DtRwReal::value().

void DtVrfObjectDataMessengerDescriptor::setMaxSendInterval

(

DtTime

ival

)

[inline]

Longest period of time to wait before resending message.

References myMaxSendInterval, and DtRwReal::setValue().

DtTime DtVrfObjectDataMessengerDescriptor::minSendInterval

(

)

const [inline]

Shortest period of time to wait before resending message.

References myMinSendInterval, and DtRwReal::value().

void DtVrfObjectDataMessengerDescriptor::setMinSendInterval

(

DtTime

ival

)

[inline]

Shortest period of time to wait before resending message.

References myMinSendInterval, and DtRwReal::setValue().

---

Member Data Documentation

DtRwReal DtVrfObjectDataMessengerDescriptor::myMaxSendInterval [protected]

Parameter Name: "max-send-interval"
Parameter Description: Maximum time before resending message.

Default Value: 5.0 Parameter Units: seconds

Referenced by maxSendInterval(), and setMaxSendInterval().

DtRwReal DtVrfObjectDataMessengerDescriptor::myMinSendInterval [protected]

Parameter Name: "min-send-interval"
Parameter Description: Smallest amount of time to wait before sending message.

Default Value: 0.5 Parameter Units: seconds

Referenced by minSendInterval(), and setMinSendInterval().

---

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

• include/vrfobjparam/vrfObjectDataMessengerDesc.h