DtActiveSonarSensorPSR Class Reference

Process State Repository for the DtActiveSonarSensor component. More...

Inheritance diagram for DtActiveSonarSensorPSR:

Public Member Functions
	DtActiveSonarSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtActiveSonarSensorPSR (const DtActiveSonarSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtActiveSonarSensorPSR ()
	destructor
DtActiveSonarSensorPSR &	operator= (const DtActiveSonarSensorPSR &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
virtual void	setNextDetectAttempt (DtTime time)
	Simulation time of next detection attempt (in seconds).
virtual DtTime	nextDetectAttempt () const
virtual DtString	activeSonarMode () const
virtual void	setActiveSonarMode (const DtString &mode)
virtual bool	activeSonarModeSpecified () const
Public Member Functions inherited from DtPassiveSonarSensorPSR
	DtPassiveSonarSensorPSR (DtVrfObject *vrfObject, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	constructor
	DtPassiveSonarSensorPSR (const DtPassiveSonarSensorPSR &orig, const DtString &rwName=DtString::nullString(), DtReaderWriterRegistry *parentRegistry=0)
	copy constructor
virtual	~DtPassiveSonarSensorPSR ()
	destructor
DtPassiveSonarSensorPSR &	operator= (const DtPassiveSonarSensorPSR &orig)
	assignment operator - not implemented
virtual void	setDepth (DtReal depth)
virtual DtReal	depth () const
virtual bool	depthSpecified () const
virtual void	setDepthSpecified (bool specified)
Public Member Functions inherited from DtObjectSensorPSR
	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 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.

Protected Attributes
DtRwString	myActiveSonarMode
DtRwReal	myNextDetectAttempt
	Simulation time of next detection attempt (seconds).
Protected Attributes inherited from DtPassiveSonarSensorPSR
DtRwReal	myDepth
Protected Attributes inherited from DtObjectSensorPSR
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 )()
Protected Member Functions inherited from DtObjectSensorPSR
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.
Static Protected Attributes inherited from DtVrfProcessStateRepository
static DtVrfProcessStateRepositoryFactory *	theFactory

Detailed Description

Process State Repository for the DtActiveSonarSensor component.

Extends DtObjectSensorPSR with a boolean to track whether the active sonar system is on or off.

Constructor & Destructor Documentation

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

constructor

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

copy constructor

virtual DtActiveSonarSensorPSR::~DtActiveSonarSensorPSR ( )

virtual

destructor

Member Function Documentation

DtActiveSonarSensorPSR& DtActiveSonarSensorPSR::operator=

(

const DtActiveSonarSensorPSR &

orig

)

assignment operator - not implemented

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

virtual

returns a newly created copy of this object

Reimplemented from DtPassiveSonarSensorPSR.

virtual DtString DtActiveSonarSensorPSR::type ( ) const

virtual

Returns

DtVrfActiveSonarSensorProcessStateRepositoryType, as defined in procSRTypes.h.

Reimplemented from DtPassiveSonarSensorPSR.

virtual void DtActiveSonarSensorPSR::setNextDetectAttempt ( DtTime  time )

virtual

Simulation time of next detection attempt (in seconds).

virtual DtTime DtActiveSonarSensorPSR::nextDetectAttempt ( ) const

virtual

virtual DtString DtActiveSonarSensorPSR::activeSonarMode ( ) const

virtual

virtual void DtActiveSonarSensorPSR::setActiveSonarMode ( const DtString &  mode )

virtual

virtual bool DtActiveSonarSensorPSR::activeSonarModeSpecified ( ) const

virtual

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

static

Returns a newly created instance of this class.

Reimplemented from DtPassiveSonarSensorPSR.

Member Data Documentation

DtRwString DtActiveSonarSensorPSR::myActiveSonarMode

protected

DtRwReal DtActiveSonarSensorPSR::myNextDetectAttempt

protected

Simulation time of next detection attempt (seconds).

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfobjcore/activeSonarSensorPSR.h