DtSpotReportGeneratorControllerDescriptor Class Reference

DtSpotReportGeneratorControllerDescriptor; descriptor for the DtSpotReportGeneratorController component. More...

Inheritance diagram for DtSpotReportGeneratorControllerDescriptor:

List of all members.

Public Member Functions
	DtSpotReportGeneratorControllerDescriptor (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	Constructor.
	DtSpotReportGeneratorControllerDescriptor (const DtSpotReportGeneratorControllerDescriptor &orig, DtReaderWriterRegistry *parentRegistry=0)
	Copy constructor.
DtSpotReportGeneratorControllerDescriptor &	operator= (const DtSpotReportGeneratorControllerDescriptor &orig)
	Assignment operator.
virtual	~DtSpotReportGeneratorControllerDescriptor ()
	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.
virtual bool	forwardSubordinateReports () const
	Accessor/mutator for myForwardSubordinateReports.
virtual void	setForwardSubordinateReports (const bool &newValue)
	Accessor/mutator for myForwardSubordinateReports.
virtual const DtRwObjectTypeList &	objTypesToSpot () const
	Accessor/mutator for #myObjTypesToSpotRep.
virtual void	setObjTypesToSpot (const DtRwObjectTypeList &list)
	Accessor/mutator for #myObjTypesToSpotRep.
virtual bool	reportOnOwnForce () const
	Accessor/mutator for mySendReportsOnOwnForce.
virtual void	setReportOnOwnForce (bool newVal)
	Accessor/mutator for mySendReportsOnOwnForce.
virtual bool	reportOnHostileForces () const
	See #mySendSpotReportsOnHostileForces.
virtual void	setReportOnHostileForces (bool newVal)
	See #mySendSpotReportsOnHostileForces.
virtual bool	reportOnNeutralForces () const
	See #mySendSpotReportsOnNeutralForces.
virtual void	setReportOnNeutralForces (bool newVal)
	See #mySendSpotReportsOnNeutralForces.
virtual double	reportResendPeriod () const
	Accessor/mutator for myReportResendPeriod.
virtual void	setReportResendPeriod (const double &newValue)
	Accessor/mutator for myReportResendPeriod.
virtual DtString	radioName () const
virtual void	setRadioName (const DtString &name)
Static Public Member Functions
static DtComponentDescriptor *	creator ()
Static Public Attributes
static const DtString	theDefaultRadioName
	Name used to indicate the default radio name in myRadioName.
Protected Attributes
parameters
These parameters are available for setting in the OPD files.
DtRwBoolean	myForwardSubordinateReports
	Parameter Name: "forward-subordinate-reports" Parameter Description: Flag indicating whether reports from subordinates should be forwarded to the superior.
DtRwReal	myReportResendPeriod
	Parameter Name: "report-resend-period" Parameter Description: Heartbeat interval at which a given report should be resent for a given contact.
DtRwObjectTypeList	myObjTypesToSpot
	Parameter Name: "object-types-to-spot-report" Parameter Description: List of object types to be reported about from this spot report generator.
DtRwBoolean	mySendReportsOnOwnForce
	Parameter Name: "send-spot-reports-on-own-force" Parameter Description: Flag indicating whether entity should send spot reports on entities of it's own force type.
DtRwBoolean	mySendReportsOnHostileForces
	Parameter Name: "send-spot-reports-on-hostile-forces" Parameter Description: Flag indicating whether entity should send spot reports on entities that are designated hostile to this entity.
DtRwBoolean	mySendReportsOnNeutralForces
	Parameter Name: "send-spot-reports-on-neutral-forces" Parameter Description: Flag indicating whether entity should send spot reports on entities of other neutral forces.
DtRwString	myRadioName
	Parameter Name: "radio-name" Parameter Description: The name of the radio on which the spot reports will be sent.

---

Detailed Description

DtSpotReportGeneratorControllerDescriptor; descriptor for the DtSpotReportGeneratorController component.

Instances of DtSpotReportGeneratorControllerDescriptor are used to specify the parameters for a DtSpotReportGeneratorController object.

---

Constructor & Destructor Documentation

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

Constructor.

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

Copy constructor.

virtual DtSpotReportGeneratorControllerDescriptor::~DtSpotReportGeneratorControllerDescriptor

(

)

[virtual]

Destructor.

---

Member Function Documentation

DtSpotReportGeneratorControllerDescriptor& DtSpotReportGeneratorControllerDescriptor::operator=

(

const DtSpotReportGeneratorControllerDescriptor &

orig

)

Assignment operator.

virtual DtComponentDescriptor* DtSpotReportGeneratorControllerDescriptor::clone

(

DtReaderWriterRegistry *

parentRegistry = 0

)

const [virtual]

Returns a copy of this class using the copy constructor.

Reimplemented from DtComponentDescriptor.

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

DtSpotReportGeneratorControllerDescriptorType

Reimplemented from DtComponentDescriptor.

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

virtual bool DtSpotReportGeneratorControllerDescriptor::forwardSubordinateReports

(

)

const [virtual]

Accessor/mutator for myForwardSubordinateReports.

virtual void DtSpotReportGeneratorControllerDescriptor::setForwardSubordinateReports

(

const bool &

newValue

)

[virtual]

Accessor/mutator for myForwardSubordinateReports.

virtual const DtRwObjectTypeList& DtSpotReportGeneratorControllerDescriptor::objTypesToSpot

(

)

const [virtual]

Accessor/mutator for #myObjTypesToSpotRep.

virtual void DtSpotReportGeneratorControllerDescriptor::setObjTypesToSpot

(

const DtRwObjectTypeList &

list

)

[virtual]

Accessor/mutator for #myObjTypesToSpotRep.

virtual bool DtSpotReportGeneratorControllerDescriptor::reportOnOwnForce

(

)

const [virtual]

Accessor/mutator for mySendReportsOnOwnForce.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportOnOwnForce

(

bool

newVal

)

[virtual]

Accessor/mutator for mySendReportsOnOwnForce.

virtual bool DtSpotReportGeneratorControllerDescriptor::reportOnHostileForces

(

)

const [virtual]

See #mySendSpotReportsOnHostileForces.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportOnHostileForces

(

bool

newVal

)

[virtual]

See #mySendSpotReportsOnHostileForces.

virtual bool DtSpotReportGeneratorControllerDescriptor::reportOnNeutralForces

(

)

const [virtual]

See #mySendSpotReportsOnNeutralForces.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportOnNeutralForces

(

bool

newVal

)

[virtual]

See #mySendSpotReportsOnNeutralForces.

virtual double DtSpotReportGeneratorControllerDescriptor::reportResendPeriod

(

)

const [virtual]

Accessor/mutator for myReportResendPeriod.

virtual void DtSpotReportGeneratorControllerDescriptor::setReportResendPeriod

(

const double &

newValue

)

[virtual]

Accessor/mutator for myReportResendPeriod.

virtual DtString DtSpotReportGeneratorControllerDescriptor::radioName

(

)

const [virtual]

See also:

myRadioName

virtual void DtSpotReportGeneratorControllerDescriptor::setRadioName

(

const DtString &

name

)

[virtual]

See also:

myRadioName

---

Member Data Documentation

const DtString DtSpotReportGeneratorControllerDescriptor::theDefaultRadioName [static]

Name used to indicate the default radio name in myRadioName.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::myForwardSubordinateReports [protected]

Parameter Name: "forward-subordinate-reports"
Parameter Description: Flag indicating whether reports from subordinates should be forwarded to the superior.

Default Value: False

DtRwReal DtSpotReportGeneratorControllerDescriptor::myReportResendPeriod [protected]

Parameter Name: "report-resend-period"
Parameter Description: Heartbeat interval at which a given report should be resent for a given contact.

Default Value: 60.0 Parameter Units: seconds

DtRwObjectTypeList DtSpotReportGeneratorControllerDescriptor::myObjTypesToSpot [protected]

Parameter Name: "object-types-to-spot-report"
Parameter Description: List of object types to be reported about from this spot report generator.

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendReportsOnOwnForce [protected]

Parameter Name: "send-spot-reports-on-own-force"
Parameter Description: Flag indicating whether entity should send spot reports on entities of it's own force type.

Default Value: False

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendReportsOnHostileForces [protected]

Parameter Name: "send-spot-reports-on-hostile-forces"
Parameter Description: Flag indicating whether entity should send spot reports on entities that are designated hostile to this entity.

Default Value: True

DtRwBoolean DtSpotReportGeneratorControllerDescriptor::mySendReportsOnNeutralForces [protected]

Parameter Name: "send-spot-reports-on-neutral-forces"
Parameter Description: Flag indicating whether entity should send spot reports on entities of other neutral forces.

This does not include the entities own force.
Default Value: True

DtRwString DtSpotReportGeneratorControllerDescriptor::myRadioName [protected]

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

This name matches the names in the radio block of the OPE file.
Default Value: "default"

---

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

• include/vrfobjparam/spotReportGeneratorDesc.h