DtObjectSensorPSR Class Reference

Inheritance diagram for DtObjectSensorPSR:

Public Member Functions
	DtObjectSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtObjectSensorPSR (const DtObjectSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtObjectSensorPSR ()
	destructor
DtObjectSensorPSR &	operator= (const DtObjectSensorPSR &orig)
	assignment operator - not implemented
virtual DtVrfProcessStateRepository *	clone (const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0) const
	returns a newly created copy of this object
virtual DtString	type () const
	Returns the string type of the repository, as defined in procSRTypes.h.
virtual bool	init ()
	Call after creation.
virtual DtSensorContactInfoList *	contactInfoList ()
	The list of DtRwSensorContactInfo (or derivative) objects.
virtual const DtSensorContactInfoList *	contactInfoList () const
	The const list of DtRwSensorContactInfo (or derivative) objects.
virtual DtRwSensorContactInfo *	lookupContactById (const DtEntityIdentifier &id) const
	Returns the contact info for the contact with the specified entity ID, or NULL if not found.
virtual void	clearContactInfoList ()
	Empties the contact info list.
virtual DtRwSensorContactInfo *	createSensorContactInfo () const
	Returns a new DtRwSensorContactInfo (or derivative) class by calling myContactInfoList->createSensorContactInfo().
virtual const DtRwObjectTypeList &	typesToDetectForTask () const
	Sets a list of entity types to detect.
virtual void	setTypesToDetectForTask (const DtRwObjectTypeList &objectTypes)
	Sets the dynamic list of types to detect.
virtual void	clearTypesToDetectForTask ()
	Clears the dynamic list of types to detect.
virtual void	setNextDetectAttempt (DtTime time)
	Simulation time of next detection attempt (in seconds).
virtual DtTime	nextDetectAttempt () const
virtual void	setSensorEnabled (bool enabled)
	Whether the sensor is enabled or disabled.
virtual bool	sensorEnabled () const
virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtReaderWriter::appPath())
	Override to call mapTargetIdsToTargetNames() before calling base class version to write ourselves to file.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Override to set flag indicating we should map target names to target identifiers the next time lookupPreviousTarget() is called.
Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	DtVrfProcessStateRepository (const DtVrfProcessStateRepository &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
const DtVrfProcessStateRepository &	operator= (const DtVrfProcessStateRepository &orig)
virtual	~DtVrfProcessStateRepository ()
virtual bool	loadedFromMTL () const
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)
	pseudo-copy constructor
	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)
	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)
	copy constructor
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	postPutSelf ()
	Called after either version of put self (file or environment). Default is no-op.
virtual void	prePutSelf ()
	Called before either version of put self (file or environment). Default is no-op.
virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Top level to read itself from an input stream.
virtual void	postGetSelf ()
	Called after either version of getSelf (mtl or environment). Default is no-op.
virtual void	preGetSelf ()
	Called before either version of get self (file or environment). Default is no-op.
virtual void	writeSelf (std::string &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 void	addAlias (const DtString &alias)
virtual bool	hasAlias (const DtSymbolString &alias)
virtual const aliasContainer &	aliases () const
virtual void	setReadonly (bool flag)
	Set read-only flag.
bool	isReadonly () const
virtual void	reset ()
	For those reader/writer items that support it, resets the reader/writer value to iriginal state Default is no-op.
virtual int	alignment () const
	For those items that are sent over the network via HLA, this will give the network alignment.
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 const char *	xmlType () const
virtual DtString	prettyPrint () const
	Routine to return a human readable form of the reader/writer variable.
std::string	debugText () const
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 bool	hasVariableReference () const
	Returns true if this item or any item in the registry (recursive) is a variable reference.
virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)
	Checks to see if this RW object is a variable reference that can be bound using the provided bindings.
virtual void	recordUpdateTime () const
	Can be implemented in subclasses to stamp the time when updated.
virtual bool	wasUpdatedSince (DtTime t) const
	Can be implemented in subclasses to return true if an update occurred after the specified time.
virtual void	putData (std::string &fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.
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.
virtual const DtReaderWriter *	defaultRWValue () const
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriter *	defaultRWValue ()
	The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual void	setDefaultRWValue (DtReaderWriter *)
	Previous default value, if exists, will be removed and replaced with a clone of the supplied variable.
virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())
	Give the stream, if the stream contains a default value then set it here.
const DtReaderWriterRegistry &	registry () const
	Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistry &	registry ()
	Collection of child DtReaderWriter nodes owned by this object.
virtual DtPropertyInterface *	property ()
virtual const DtPropertyInterface *	property () const
virtual DtString	toXml () const
virtual bool	toXml (const DtFilename &) const
	Writes contents of xml result to the given filename.
virtual bool	fromXml (const DtString &)
	Restores object from given xml string. Returns true if valid.
virtual bool	fromXmlFile (const DtFilename &)
	Restires object from given xml file.
virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const
virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const
	Override to add attributes of actual data.
virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const
	Called when the item is a variable reference.
virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())
	Gets data from the environment value.
virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)
	Called when the xml reader tries to parse an unknown reader/writer item. Default is a no-op.
virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)
	Called when the item is a variable reference.

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry)
	Returns a newly created instance of this class.
Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()
	a DtVrfProcessStateRepositoryFactory is allocated by the DtSimCreator, and this pointer is set.
static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)
static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)
static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtVrfObject *vrfObject, DtReaderWriterRegistry *parentRegistry=0)
	Creates a new state repository object, using the factory.
Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)
static const DtVariableBindingsList &	nullVariableReference ()
static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)
static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)
static void	setPutIndent (bool)
static bool	putIndent ()
static const char *	theXmlType ()
	The type that is used when archiving to an XML stream.
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 void	cleanupFactory ()
static DtReaderWriter *	createFromXmlFile (const DtFilename &)
	Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromXml (const DtString &)
	Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP)
	Given a xml environment, returns a newly created reader/writer object from the object found within.
static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)
	Gets the named attribute from a DtEnvValueSP.
Static Public Member Functions inherited from DtObjectDebugger< DtReaderWriter >
static DtObjectCounter::CounterType	ObjectCount ()
static const DtObjectContainer *	ObjectContainer ()

Protected Member Functions
virtual DtSensorContactInfoList *	createSensorContactInfoList (const DtString &name)
	Returns a new DtSensorContactInfoList.
virtual void	mapContactIdsToContactNames ()
	Looks up each object in myContactInfoList by the entity ID in the contact information and sets the name of the contact in the contact info to the name of the object found.
virtual void	mapContactNamesToContactIds ()
	Looks up each object in myContactInfoList by name, and sets the entity ID in the contact information to the one found in the vrf object.
Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()
Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)
	Copies values from the specified DtReaderWriter.
Protected Member Functions inherited from DtObjectDebugger< DtReaderWriter >
	DtObjectDebugger ()
	DtObjectDebugger (const DtObjectDebugger &)
	~DtObjectDebugger ()

Protected Attributes
DtSensorContactInfoList *	myContactInfoList
	Init() creates this item by using the createSensorContactInfoList() factory method.
bool	myMutableMapContactNamesToContactIds
	Flag used to indicate that we should initialize contact names to DtEntityIdentifiers.
DtRwObjectTypeList	myTaskDetectionTypes
	Parameter Name: task-detection-types Parameter Description: Types of objects to detect for a particular task.
DtRwReal	myNextDetectAttempt
	Simulation time of next detection attempt (seconds).
DtRwBoolean	mySensorEnabled
	Whether the sensor is enabled or disabled.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName
DtReaderWriterRegistry	myRegistry
DtReaderWriterRegistry *	myParentRegistry
bool	myValueSpecified
bool	myReadOnlyFlag
bool	myIsVariableReference
DtSymbolString	myVariableName
bool	myVariableIsBound
DtReaderWriter *	myDefaultValue
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::vector< DtFilename >	SearchPaths
typedef std::pair < DtSymbolString, DtString >	DtVariableNameType
typedef DtReaderWriterFactory *(*	DtReaderWriterFactoryCreatorFcn )()
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Constructor & Destructor Documentation

DtObjectSensorPSR::DtObjectSensorPSR	(	DtVrfObject *	vrfObject,
		const DtString &	rwName = DtString::nullString(),
		DtReaderWriterRegistry *	parentRegistry = 0
	)

constructor

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

copy constructor

virtual DtObjectSensorPSR::~DtObjectSensorPSR ( )

virtual

destructor

Member Function Documentation

DtObjectSensorPSR& DtObjectSensorPSR::operator=

(

const DtObjectSensorPSR &

orig

)

assignment operator - not implemented

virtual DtVrfProcessStateRepository* DtObjectSensorPSR::clone ( const DtString &  rwName = DtString::nullString(), DtReaderWriterRegistry *  parentRegistry = 0  ) const

virtual

returns a newly created copy of this object

Implements DtVrfProcessStateRepository.

Reimplemented in DtActiveSonarSensorPSR, DtRadarObjectSensorPSR, DtSignatureObjectSensorPSR, DtRotaryWingFlightCommandControllerPSR, and DtPassiveSonarSensorPSR.

virtual DtString DtObjectSensorPSR::type ( ) const

virtual

Returns the string type of the repository, as defined in procSRTypes.h.

Implements DtVrfProcessStateRepository.

Reimplemented in DtActiveSonarSensorPSR, DtRadarObjectSensorPSR, DtSignatureObjectSensorPSR, DtRotaryWingFlightCommandControllerPSR, and DtPassiveSonarSensorPSR.

virtual bool DtObjectSensorPSR::init ( )

virtual

Call after creation.

Sets myContactInfoList using createSensorContactInfoList().

Reimplemented from DtVrfProcessStateRepository.

virtual DtSensorContactInfoList* DtObjectSensorPSR::contactInfoList ( )

virtual

The list of DtRwSensorContactInfo (or derivative) objects.

Will call mapContactNamesToIds() if the flag is set. For this reason, avoid holding a pointer to this list outside of this class.

virtual const DtSensorContactInfoList* DtObjectSensorPSR::contactInfoList ( ) const

virtual

The const list of DtRwSensorContactInfo (or derivative) objects.

Will call mapContactNamesToIds() if the flag is set. (casting away constness to do so) For this reason, avoid holding a pointer to this list outside of this class.

virtual DtRwSensorContactInfo* DtObjectSensorPSR::lookupContactById ( const DtEntityIdentifier &  id ) const

virtual

Returns the contact info for the contact with the specified entity ID, or NULL if not found.

virtual void DtObjectSensorPSR::clearContactInfoList ( )

virtual

Empties the contact info list.

virtual DtRwSensorContactInfo* DtObjectSensorPSR::createSensorContactInfo ( ) const

virtual

Returns a new DtRwSensorContactInfo (or derivative) class by calling myContactInfoList->createSensorContactInfo().

This returns the type being used in the contactInfoList. All items added to the contactInfoList should be created by calling this method. Returns NULL if myContactInfoList is not set.

virtual const DtRwObjectTypeList& DtObjectSensorPSR::typesToDetectForTask ( ) const

virtual

Sets a list of entity types to detect.

This type list is used along with the list in the descriptor and the list on the types-to-detect input port to make a list to process detections. This task list is expected to be changed dynamically during a scenario by tasks.

virtual void DtObjectSensorPSR::setTypesToDetectForTask ( const DtRwObjectTypeList &  objectTypes )

virtual

Sets the dynamic list of types to detect.

virtual void DtObjectSensorPSR::clearTypesToDetectForTask ( )

virtual

Clears the dynamic list of types to detect.

virtual void DtObjectSensorPSR::setNextDetectAttempt ( DtTime  time )

virtual

Simulation time of next detection attempt (in seconds).

Reimplemented in DtActiveSonarSensorPSR.

virtual DtTime DtObjectSensorPSR::nextDetectAttempt ( ) const

virtual

Reimplemented in DtActiveSonarSensorPSR.

virtual void DtObjectSensorPSR::setSensorEnabled ( bool  enabled )

virtual

Whether the sensor is enabled or disabled.

virtual bool DtObjectSensorPSR::sensorEnabled ( ) const

virtual

virtual void DtObjectSensorPSR::putSelf ( std::string &  fp, int  indentLevel = 0, bool  writeUnspecified = false, const DtFilename &  path = DtReaderWriter::appPath()  )

virtual

Override to call mapTargetIdsToTargetNames() before calling base class version to write ourselves to file.

It fills out our writable list of target object names from the non-writable myPreviousTargets list of DtEntityIdentifiers. This way the identities of previously detected targets get preserved as part of a checkpoint save.

Reimplemented from DtReaderWriter.

virtual void DtObjectSensorPSR::getSelf ( DtlObjPtr  args, const DtReaderWriter::SearchPaths &  searchPaths, const DtVariableBindingsList &  variableBindings  )

virtual

Override to set flag indicating we should map target names to target identifiers the next time lookupPreviousTarget() is called.

Reimplemented from DtVrfProcessStateRepository.

virtual DtSensorContactInfoList* DtObjectSensorPSR::createSensorContactInfoList ( const DtString &  name )

protectedvirtual

Returns a new DtSensorContactInfoList.

If you are adding custom data to the sensor contact info, create a new derivative of DtSensorContactInfoList, and override this method to create your new subclass here.

static DtVrfProcessStateRepository* DtObjectSensorPSR::creator ( const DtString &  rwName, DtVrfObject *  vrfObject, DtReaderWriterRegistry *  parentRegistry  )

static

Returns a newly created instance of this class.

Reimplemented in DtRadarObjectSensorPSR, DtActiveSonarSensorPSR, DtSignatureObjectSensorPSR, DtRotaryWingFlightCommandControllerPSR, and DtPassiveSonarSensorPSR.

virtual void DtObjectSensorPSR::mapContactIdsToContactNames ( )

protectedvirtual

Looks up each object in myContactInfoList by the entity ID in the contact information and sets the name of the contact in the contact info to the name of the object found.

Objects that are not found are left as they were.

virtual void DtObjectSensorPSR::mapContactNamesToContactIds ( )

protectedvirtual

Looks up each object in myContactInfoList by name, and sets the entity ID in the contact information to the one found in the vrf object.

Member Data Documentation

DtSensorContactInfoList* DtObjectSensorPSR::myContactInfoList

protected

Init() creates this item by using the createSensorContactInfoList() factory method.

bool DtObjectSensorPSR::myMutableMapContactNamesToContactIds

mutableprotected

Flag used to indicate that we should initialize contact names to DtEntityIdentifiers.

DtRwObjectTypeList DtObjectSensorPSR::myTaskDetectionTypes

protected

Parameter Name: task-detection-types
Parameter Description: Types of objects to detect for a particular task.

Set with a function call; or a setAttribute call in Lua.
Parameter Default Value: empty

DtRwReal DtObjectSensorPSR::myNextDetectAttempt

protected

Simulation time of next detection attempt (seconds).

DtRwBoolean DtObjectSensorPSR::mySensorEnabled

protected

Whether the sensor is enabled or disabled.

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-4-branch/include/vrfobjcore/objectSensorPSR.h