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

Inheritance diagram for DtSpotReportGeneratorControllerDescriptor:

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)
Public Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor (const DtComponentDescriptor &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
DtComponentDescriptor &	operator= (const DtComponentDescriptor &orig)
	assignment
virtual	~DtComponentDescriptor ()
virtual void	putData (FILE *fp, int indentLevel=0)
	Overrides base class putData to output our type.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	getData is just used to get us past the type in the data stream, since it's not actually stored.
virtual bool	init ()
	Base class init does nothing, but will be called by createComponentDescriptor(), allowing derived classes to do memory allocation if necessary.
bool	operator== (const DtComponentDescriptor &) const
	DtComponentDescriptor (const DtString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
	DtComponentDescriptor (const DtSymbolString &componentName, DtReaderWriterRegistry *parentRegistry=NULL)
virtual void	setComponentType (const DtString &componentType)
	Type of DtSimComponent this descriptor is associated with.
virtual const DtString &	componentType () const
	Type of DtSimComponent this descriptor is associated with.
virtual void	setMinTickPeriod (DtReal minTickPeriod)
virtual DtReal	minTickPeriod () const
virtual void	setMinTickPeriodVariance (DtReal minTickPeriodVariance)
virtual DtReal	minTickPeriodVariance () const
virtual void	setTickPeriodUsesRealTime (bool value)
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual bool	tickPeriodUsesRealTime () const
	Accessor/mutator for myTickPeriodUsesRealTime.
virtual const DtString &	processStateRepositoryName () const
	Name which this component will assign to its PSR.
virtual void	setProcessStateRepositoryName (const DtString &name)
	Name which this component will assign to its PSR.
virtual const DtString &	processStateRepositoryType () const
	Type of PSR this component will create.
virtual void	setProcessStateRepositoryType (const DtString &type)
	Type of PSR this component will create.
virtual void	setIsEnabled (bool yesNo)
	Is the component enabled or not.
virtual bool	isEnabled () const
	Is the component enabled or not.
virtual void	setDebugActive (bool active)
	Should detailed debug info be printed for this component.
virtual bool	debugActive ()
	Should detailed debug info be printed for this component.
virtual void	setCreateComponent (bool yesNo)
	Should the component be created or not.
virtual bool	createComponent () const
	Should the component be created or not.
Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()
	default constructor
	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	real constructor Setting the readonly flag prevents object from writing itself to the stream.
	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)
	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
const DtReaderWriter &	operator= (const DtReaderWriter &orig)
	assignment operator
bool	operator== (const DtReaderWriter &) const
	Equivalence operator.
bool	operator!= (const DtReaderWriter &rhs)
virtual	~DtReaderWriter ()
	destructor
virtual void	putSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Top level call to write itself to file.
virtual void	getSelf (DtlObjPtr args, const DtFilename &searchPath=DtFilename::nullFilename(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	writeSelf (FILE *fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
	Called from putSelf, calls myRegistry.putSelf which in turn calls putSelf on each reader/writer in the registry.
virtual DtSymbolString	name () const
	Accessor for name of this readable/writable object.
virtual void	addAlias (const DtSymbolString &alias)
	Add an alias as an alternative name for this object.
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
virtual bool	isReadonly () const
virtual bool	variableIsBound () const
virtual void	unbindVariable ()
	Sets the myVariableIsBound flag to false.
virtual void	setName (const DtString &)
	Set the name of the object.
virtual const char *	readerWriterType () const
	Used to supply a string type that this reader writer type is.
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
virtual void	bindVariables (DtVariableBindingsList variableBindings)
	Runs a variable binding pass on this reader writer and any of its children.
virtual std::list < DtVariableNameType >	unboundVariables () const
bool	invalid () const
virtual bool	hasChild (const DtReaderWriter *p) const
	Returns true if this variable has a child p in it's chain.
virtual void	setValueSpecified (bool specified, bool recurse=false)
	The specified flags are used for optional values.
virtual bool	valueSpecified () const
	The specified flags are used for optional values.
virtual bool	isVariableReference () const
	Specifies whether or not this reader writer is really a variable that is specified elsewhere.
virtual void	setIsVariableReference (bool value)
virtual void	clearAllVariableReferenceFlags ()
	Clears out all variable reference flags from all readerwriter items in registry recursively.
virtual DtSymbolString	variableName () const
	The variable name, if this object is a variable reference.
virtual void	setVariableName (const DtSymbolString variableName)
	The variable name, if this object is a variable reference.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.

Static Public Member Functions
static DtComponentDescriptor *	creator ()

Static Public Member Functions inherited from DtComponentDescriptor
static void	addComponentDescriptorCreatorFcn (const DtString &type, DtComponentDescriptorCreatorFcn fcn)
	Adds a given component descriptor creation function and corresponding type (defined in compDescTypes.h) to the DtComponentDescriptorFactory.
static DtComponentDescriptor *	createComponentDescriptor (DtlObjPtr mtlStream, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Creates and initializes a component descriptor when reading in from an MTL (MAK Technologies Lisp) file (i.e.
static DtComponentDescriptor *	createComponentDescriptor (const char *pName)
	Creates and initializes a new instance of this class.
static DtComponentDescriptorFactory *	factory ()
	The factory for creating objects of type DtComponentDescriptor.
static void	setFactory (DtComponentDescriptorFactory *factory)
	The factory for creating objects of type DtComponentDescriptor.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (FILE *fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static const DtFilename &	appPath ()
	Gets the current working directory.
static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)
	Sets the function to create the DtReaderWriterFactory.
static void	createReaderWriterFactory ()

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.
Protected Attributes inherited from DtComponentDescriptor
DtRwBoolean	myIsEnabled
DtRwBoolean	myDebug
	This parameter defaults to false.
DtRwBoolean	myCreateComponent
DtRwString	myComponentType
	Parameter Name: component-type Parameter Description: String identifying type of component.
DtRwReal	myMinTickPeriod
	Parameter Name: min-tick-period Parameter Description: Minimum tick period for this component.
DtRwReal	myMinTickPeriodVariance
	Parameter Name: min-tick-period-variance Parameter Description: Minimum tick period for this component.
DtRwBoolean	myTickPeriodUsesRealTime
	Parameter Name: tick-period-uses-real-time Parameter Description: Specified whether the min-tick-period and min-tick-period-variance parameters are based on real time or simulation time.
DtRwString	myProcessStateRepositoryName
	Parameter Name: process-state-repository-name Parameter Description: Name of the process state repository associated with this component.
DtRwString	myProcessStateRepositoryType
	Parameter Name: process-state-repository-type Parameter Description: Type of the process state repository assoicated with this component.
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
aliasContainer	myAliases
	Container for the aliases which represent alternative names for the object.
bool	myInvalid
	Set to true if there is a problem reading this item.

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer
typedef std::vector < DtSymbolString >::iterator	aliasIter
typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()
Protected Member Functions inherited from DtComponentDescriptor
	DtComponentDescriptor ()
	default constructor; not implemented
Static Protected Attributes inherited from DtComponentDescriptor
static DtComponentDescriptorFactory *	myFactory

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:

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjparam/spotReportGeneratorDesc.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation