Inheritance diagram for DtObjectSensorPSR:

Public Member Functions
	DtObjectSensorPSR (DtLocalObject vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry parentRegistry=0)

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

virtual	~DtObjectSensorPSR ()

DtObjectSensorPSR &	operator= (const DtObjectSensorPSR &orig)

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

virtual DtString	type () const

virtual bool	init ()

virtual DtSensorContactInfoList *	contactInfoList ()

virtual const DtSensorContactInfoList *	contactInfoList () const

virtual DtRwSensorContactInfo *	lookupContactById (const DtUUID &id) const

virtual void	clearContactInfoList ()

virtual DtRwSensorContactInfo *	createSensorContactInfo () const

virtual const DtRwObjectTypeList &	typesToDetectForTask () const

virtual void	setTypesToDetectForTask (const DtRwObjectTypeList &objectTypes)

virtual void	clearTypesToDetectForTask ()

virtual void	setNextDetectAttempt (DtTime time)

virtual DtTime	nextDetectAttempt () const

virtual void	setSensorEnabled (bool enabled)

virtual bool	sensorEnabled () const

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

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

Public Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository (DtLocalObject 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 ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs)

virtual	~DtReaderWriter ()

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	wasUpdatedSince (DtTime t) const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

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())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Static Public Member Functions
static DtVrfProcessStateRepository *	creator (const DtString &rwName, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry)

Static Public Member Functions inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	factory ()

static void	setFactory (DtVrfProcessStateRepositoryFactory *factory)

static void	addVrfProcessStateRepositoryCreatorFcn (const DtString &type, DtVrfProcessStateRepositoryCreatorFcn fcn)

static DtVrfProcessStateRepository *	createRepository (const DtString &name, const DtString &type, DtLocalObject vrfObject, DtReaderWriterRegistry parentRegistry=0)

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 ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions
virtual DtSensorContactInfoList *	createSensorContactInfoList (const DtString &name)

virtual void	mapContactIdsToContactNames ()

virtual void	mapContactNamesToContactIds ()

Protected Member Functions inherited from DtVrfProcessStateRepository
	DtVrfProcessStateRepository ()

const DtSimObject *	vrfObject () const

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Protected Attributes
DtSensorContactInfoList *	myContactInfoList

bool	myMutableMapContactNamesToContactIds

DtRwObjectTypeList	myTaskDetectionTypes

DtRwReal	myNextDetectAttempt

DtRwBoolean	mySensorEnabled

Protected Attributes inherited from DtVrfProcessStateRepository
DtLocalObject *	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

bool	myInvalid

bool	myChangedFlag

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

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtObjectSensorPSR::DtObjectSensorPSR	(	DtLocalObject *	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 DtRemoteSensorSpotReportReceiverPSR, 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 DtRemoteSensorSpotReportReceiverPSR, 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 DtUUID & 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,
		DtLocalObject *	vrfObject,
		DtReaderWriterRegistry *	parentRegistry
	)

static

Returns a newly created instance of this class.

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:

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjcore/objectSensorPSR.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation