DtSpotReportReceiverDescriptor Class Reference

Descriptor for the DtSpotReportReceiver class. More...

Inheritance diagram for DtSpotReportReceiverDescriptor:

List of all members.

Public Member Functions
	DtSpotReportReceiverDescriptor (const DtString &name, DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtSpotReportReceiverDescriptor (const DtSpotReportReceiverDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
DtSpotReportReceiverDescriptor &	operator= (const DtSpotReportReceiverDescriptor &orig)
	assignment
virtual	~DtSpotReportReceiverDescriptor ()
	destructor
virtual DtString	type () const
	Returns the type of component this descriptor describes.
virtual DtComponentDescriptor *	clone (DtReaderWriterRegistry *parentRegistry=0) const
virtual DtReal	spotReportAgeLimit () const
	Accessor/mutator for #myScanRate.
virtual void	setSpotReportAgeLimit (DtReal value)
	Accessor/mutator for #myScanRate.
virtual DtString	radioName () const
virtual void	setRadioName (const DtString &name)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Protected Member Functions
	DtSpotReportReceiverDescriptor ()
	default constructor
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwReal	mySpotReportAgeLimit
	Parameter Name: spot-report-age-limit Parameter Description: Spot reports will be kept by the receiver until they are older than this age.
DtRwString	myRadioName
	Parameter Name: radio-name Parameter Description: Name of the radio on which spot reports will be received.

---

Detailed Description

Descriptor for the DtSpotReportReceiver class.

Specifies parameters needed by this component to run.

---

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtSpotReportReceiverDescriptor::~DtSpotReportReceiverDescriptor

(

)

[virtual]

destructor

DtSpotReportReceiverDescriptor::DtSpotReportReceiverDescriptor

(

)

[protected]

default constructor

---

Member Function Documentation

DtSpotReportReceiverDescriptor& DtSpotReportReceiverDescriptor::operator=

(

const DtSpotReportReceiverDescriptor &

orig

)

assignment

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

DtSpotReportReceiverDescriptorType

Reimplemented from DtComponentDescriptor.

virtual DtReal DtSpotReportReceiverDescriptor::spotReportAgeLimit

(

)

const [virtual]

Accessor/mutator for #myScanRate.

virtual void DtSpotReportReceiverDescriptor::setSpotReportAgeLimit

(

DtReal

value

)

[virtual]

Accessor/mutator for #myScanRate.

virtual DtString DtSpotReportReceiverDescriptor::radioName

(

)

const [virtual]

See also:

myRadioName

virtual void DtSpotReportReceiverDescriptor::setRadioName

(

const DtString &

name

)

[virtual]

See also:

myRadioName

virtual DtComponentDescriptor* DtSpotReportReceiverDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Reimplemented from DtComponentDescriptor.

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

---

Member Data Documentation

DtRwReal DtSpotReportReceiverDescriptor::mySpotReportAgeLimit [protected]

Parameter Name: spot-report-age-limit
Parameter Description: Spot reports will be kept by the receiver until they are older than this age.

Parameter Default Value: 60
Parameter Units: Seconds
Parameter Range: positive real numbers

DtRwString DtSpotReportReceiverDescriptor::myRadioName [protected]

Parameter Name: radio-name
Parameter Description: Name of the radio on which spot reports will be received.

If specified, then only spot reports arriving over this radio will be processed. If blank, all radios will be monitored.
Parameter Default Value: blank

---

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

• include/vrfobjparam/spotReportReceiverDescriptor.h