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 void	putSelf (FILE *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 DtFilename &searchPath, 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)
	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	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 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 (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 ()

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.
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	putData (FILE *fp, int indentLevel=0)
	Deriving class overrides these to get/put class specific data.
virtual DtlObjPtr	getData (DtlObjPtr args, const DtFilename &searchPath, const DtVariableBindingsList &variableBindings)
	Deriving class overrides these to get/put class specific data.

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.
Protected Attributes inherited from DtVrfProcessStateRepository
DtVrfObject *	myVrfObject
bool	myLoadedFromMTL
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 )()
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, 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, 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 void DtObjectSensorPSR::putSelf	(	FILE *	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 DtFilename &	searchPath,
		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, 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.

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

/exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/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