Instances of DtSensorFieldOfViewEntry are used to specify the parameters that describe the possible angles of view for a sensor.

Inheritance diagram for DtSensorFieldOfViewEntry:

[legend]

Public Member Functions
	DtSensorFieldOfViewEntry ()

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

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

	DtSensorFieldOfViewEntry (const DtSensorFieldOfViewEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)

DtSensorFieldOfViewEntry &	operator= (const DtSensorFieldOfViewEntry &orig)

virtual	~DtSensorFieldOfViewEntry ()

virtual DtSensorFieldOfViewEntry *	clone (DtReaderWriterRegistry *parentRegistry=NULL) const


virtual const DtString &	sensorFieldOfViewId () const

virtual void	setSensorFieldOfViewId (const DtString &id)


virtual double	widestXAngle () const

virtual void	setWidestXAngle (double angle)


virtual double	widestYAngle () const

virtual void	setWidestYAngle (double angle)


virtual double	maxZoomLevel () const

virtual void	setMaxZoomLevel (double zoomLevel)


virtual double	radius () const

virtual void	setRadius (double rad)

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	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

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

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)

Protected Attributes
Parameters
These parameters are available for setting in the OPD files.
DtRwString	mySensorFieldOfViewId

DtRwReal	myWidestXAngle

DtRwReal	myWidestYAngle

DtRwReal	myMaxZoomLevel

DtRwReal	myRadius

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 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 inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

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

DtSensorFieldOfViewEntry::DtSensorFieldOfViewEntry ( )

DtSensorFieldOfViewEntry::DtSensorFieldOfViewEntry	(	const DtString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

constructor

DtSensorFieldOfViewEntry::DtSensorFieldOfViewEntry	(	const DtSymbolString &	name,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

DtSensorFieldOfViewEntry::DtSensorFieldOfViewEntry	(	const DtSensorFieldOfViewEntry &	orig,
		DtReaderWriterRegistry *	parentRegistry = `NULL`
	)

copy constructor

virtual DtSensorFieldOfViewEntry::~DtSensorFieldOfViewEntry ( )

virtual

destructor

Member Function Documentation

DtSensorFieldOfViewEntry& DtSensorFieldOfViewEntry::operator= ( const DtSensorFieldOfViewEntry & orig )

assignment

virtual DtSensorFieldOfViewEntry* DtSensorFieldOfViewEntry::clone ( DtReaderWriterRegistry * parentRegistry = NULL ) const

virtual

virtual const DtString& DtSensorFieldOfViewEntry::sensorFieldOfViewId ( ) const

virtual

Accessor/mutator for mySensorFieldOfViewId.

virtual void DtSensorFieldOfViewEntry::setSensorFieldOfViewId ( const DtString & id )

virtual

Accessor/mutator for mySensorFieldOfViewId.

virtual double DtSensorFieldOfViewEntry::widestXAngle ( ) const

virtual

Accessor/mutator for myWidestXAngle.

virtual void DtSensorFieldOfViewEntry::setWidestXAngle ( double angle )

virtual

Accessor/mutator for myWidestXAngle.

virtual double DtSensorFieldOfViewEntry::widestYAngle ( ) const

virtual

Accessor/mutator for myWidestYAngle.

virtual void DtSensorFieldOfViewEntry::setWidestYAngle ( double angle )

virtual

Accessor/mutator for myWidestYAngle.

virtual double DtSensorFieldOfViewEntry::maxZoomLevel ( ) const

virtual

Accessor/mutator for myMaxZoomLevel.

virtual void DtSensorFieldOfViewEntry::setMaxZoomLevel ( double zoomLevel )

virtual

Accessor/mutator for myMaxZoomLevel.

virtual double DtSensorFieldOfViewEntry::radius ( ) const

virtual

Accessor/mutator for myRadius.

virtual void DtSensorFieldOfViewEntry::setRadius ( double rad )

virtual

Accessor/mutator for myRadius.

Member Data Documentation

DtRwString DtSensorFieldOfViewEntry::mySensorFieldOfViewId

protected

Parameter Name: sensor-field-of-view-id
Parameter Description: String uniquely identifying this sensor field of view from any other sensor fields of view attached to this entity.
Parameter Default Value:
.

DtRwReal DtSensorFieldOfViewEntry::myWidestXAngle

protected

Parameter Name: widest-x-angle
Parameter Description: Widest angle for the X dimension.
Parameter Default Value: 1.173 radians.

DtRwReal DtSensorFieldOfViewEntry::myWidestYAngle

protected

Parameter Name: widest-y-angle
Parameter Description: Widest angle for the Y dimension.
Parameter Default Value: 0.66 radians.

DtRwReal DtSensorFieldOfViewEntry::myMaxZoomLevel

protected

Parameter Name: max-zoom-level
Parameter Description: Maximum allowable zoom level. Parameter Default Value: 100.

DtRwReal DtSensorFieldOfViewEntry::myRadius

protected

Parameter Name: radius
Parameter Description: The radius of the sensor field of view volume e.g. the distance from the entity to the end of the sensor range. Parameter Default Value: 0 (infinite)

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfobjparam/sensorFieldOfViewEntry.h

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation