VR-Forces 4.5 Class Documentation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members | Public Member Functions
DtSensorFieldOfViewEntry Class Reference

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

Inheritance diagram for DtSensorFieldOfViewEntry:
Inheritance graph
[legend]

Public Member Functions

 DtSensorFieldOfViewEntry ()
 DtSensorFieldOfViewEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 constructor
 DtSensorFieldOfViewEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 DtSensorFieldOfViewEntry (const DtSensorFieldOfViewEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
DtSensorFieldOfViewEntryoperator= (const DtSensorFieldOfViewEntry &orig)
 assignment
virtual ~DtSensorFieldOfViewEntry ()
 destructor
virtual DtSensorFieldOfViewEntryclone (DtReaderWriterRegistry *parentRegistry=NULL) const
virtual const DtStringsensorFieldOfViewId () const
 Accessor/mutator for mySensorFieldOfViewId.
virtual void setSensorFieldOfViewId (const DtString &id)
virtual double widestXAngle () const
 Accessor/mutator for myWidestXAngle.
virtual void setWidestXAngle (double angle)
virtual double widestYAngle () const
 Accessor/mutator for myWidestYAngle.
virtual void setWidestYAngle (double angle)
virtual double minAzimuthAngle () const
 Accessor/mutator for myMinAzimuthAngle.
virtual void setMinAzimuthAngle (double angle)
virtual double maxAzimuthAngle () const
 Accessor/mutator for myMaxAzimuthAngle.
virtual void setMaxAzimuthAngle (double angle)
virtual double minElevationAngle () const
 Accessor/mutator for myMinElevationAngle.
virtual void setMinElevationAngle (double angle)
virtual double maxElevationAngle () const
 Accessor/mutator for myMaxElevationAngle.
virtual void setMaxElevationAngle (double angle)
virtual double maxZoomLevel () const
 Accessor/mutator for myMaxZoomLevel.
virtual void setMaxZoomLevel (double zoomLevel)
virtual double radius () const
 Accessor/mutator for myRadius.
virtual void setRadius (double rad)
- 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 DtReaderWriteroperator= (const DtReaderWriter &orig)
 assignment operator
bool operator== (const DtReaderWriter &) const
 Equivalence operator.
bool operator!= (const DtReaderWriter &rhs)
virtual ~DtReaderWriter ()
 destructor
virtual void putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())
 Top level call to write itself to file.
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 aliasContaineraliases () 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 charreaderWriterType () const
 Used to supply a string type that this reader writer type is.
virtual const charxmlType () 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)
virtual void setValueSpecified (bool specified, bool recurse=false)
 The specified flags are used for optional values.
virtual bool valueSpecified () const
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)
virtual const DtReaderWriterdefaultRWValue () const
 The default value to use if the reader/writer object is a variable and that variable is not specified.
virtual DtReaderWriterdefaultRWValue ()
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 DtReaderWriterRegistryregistry () const
 Collection of child DtReaderWriter nodes owned by this object.
DtReaderWriterRegistryregistry ()
virtual DtPropertyInterfaceproperty ()
virtual const DtPropertyInterfaceproperty () 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.

Protected Attributes

Parameters

These parameters are available for setting in the OPD files.

DtRwString mySensorFieldOfViewId
 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.
DtRwReal myWidestXAngle
 Parameter Name: widest-x-angle
Parameter Description: Widest angle for the X dimension.
DtRwReal myWidestYAngle
 Parameter Name: widest-y-angle
Parameter Description: Widest angle for the Y dimension.
DtRwReal myMinAzimuthAngle
 Parameter Name: min-azimuth-angle
Parameter Description: Minimum azimuth angle at which sensor can point.
DtRwReal myMaxAzimuthAngle
 Parameter Name: max-azimuth-angle
Parameter Description: Maximum azimuth angle at which sensor can point.
DtRwReal myMinElevationAngle
 Parameter Name: min-elevation-angle
Parameter Description: Minimum elevation angle at which sensor can point.
DtRwReal myMaxElevationAngle
 Parameter Name: max-elevation-angle
Parameter Description: Maximum elevation angle at which sensor can point.
DtRwReal myMaxZoomLevel
 Parameter Name: max-zoom-level
Parameter Description: Maximum allowable zoom level.
DtRwReal myRadius
 Parameter Name: radius
Parameter Description: The radius of the sensor field of view volume e.g.
- Protected Attributes inherited from DtReaderWriter
const DtSymbolString myName
DtReaderWriterRegistry myRegistry
DtReaderWriterRegistrymyParentRegistry
bool myValueSpecified
bool myReadOnlyFlag
bool myIsVariableReference
DtSymbolString myVariableName
bool myVariableIsBound
DtReaderWritermyDefaultValue
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 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 chartheXmlType ()
 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 DtReaderWriterFactoryfactory ()
static DtReaderWritercreateFromXmlFile (const DtFilename &, bool createAsProperty=false)
 Given a filename, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromXml (const DtString &, bool createAsProperty=false)
 Given a xml string, returns a newly created reader/writer object from the object found within.
static DtReaderWritercreateFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)
 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.
- Protected Member Functions inherited from DtReaderWriter
virtual void bindToRwAsVariable (const DtReaderWriter *rw)
 Copies values from the specified DtReaderWriter.
- Static Protected Attributes inherited from DtReaderWriter
static DtString theUnspecifiedValue
static DtGetSelfCallbackInfo thePostGetSelfCallback
static DtPutSelfCallbackInfo thePrePutSelfCallback
static const DtVariableBindingsList theEmptyVariableBindingsList
static bool theCreatorFcnSet
static DtReaderWriterFactorytheFactory
static
DtReaderWriterFactoryCreatorFcn 
theFactoryCreatorFcn
static bool thePutIndent

Detailed Description

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

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
virtual double DtSensorFieldOfViewEntry::widestXAngle ( ) const
virtual

Accessor/mutator for myWidestXAngle.

virtual void DtSensorFieldOfViewEntry::setWidestXAngle ( double  angle)
virtual
virtual double DtSensorFieldOfViewEntry::widestYAngle ( ) const
virtual

Accessor/mutator for myWidestYAngle.

virtual void DtSensorFieldOfViewEntry::setWidestYAngle ( double  angle)
virtual
virtual double DtSensorFieldOfViewEntry::minAzimuthAngle ( ) const
virtual

Accessor/mutator for myMinAzimuthAngle.

virtual void DtSensorFieldOfViewEntry::setMinAzimuthAngle ( double  angle)
virtual
virtual double DtSensorFieldOfViewEntry::maxAzimuthAngle ( ) const
virtual

Accessor/mutator for myMaxAzimuthAngle.

virtual void DtSensorFieldOfViewEntry::setMaxAzimuthAngle ( double  angle)
virtual
virtual double DtSensorFieldOfViewEntry::minElevationAngle ( ) const
virtual

Accessor/mutator for myMinElevationAngle.

virtual void DtSensorFieldOfViewEntry::setMinElevationAngle ( double  angle)
virtual
virtual double DtSensorFieldOfViewEntry::maxElevationAngle ( ) const
virtual

Accessor/mutator for myMaxElevationAngle.

virtual void DtSensorFieldOfViewEntry::setMaxElevationAngle ( double  angle)
virtual
virtual double DtSensorFieldOfViewEntry::maxZoomLevel ( ) const
virtual

Accessor/mutator for myMaxZoomLevel.

virtual void DtSensorFieldOfViewEntry::setMaxZoomLevel ( double  zoomLevel)
virtual
virtual double DtSensorFieldOfViewEntry::radius ( ) const
virtual

Accessor/mutator for myRadius.

virtual void DtSensorFieldOfViewEntry::setRadius ( double  rad)
virtual

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::myMinAzimuthAngle
protected

Parameter Name: min-azimuth-angle
Parameter Description: Minimum azimuth angle at which sensor can point.


Parameter Default Value: -pi/2 radians

DtRwReal DtSensorFieldOfViewEntry::myMaxAzimuthAngle
protected

Parameter Name: max-azimuth-angle
Parameter Description: Maximum azimuth angle at which sensor can point.


Parameter Default Value: pi/2 radians

DtRwReal DtSensorFieldOfViewEntry::myMinElevationAngle
protected

Parameter Name: min-elevation-angle
Parameter Description: Minimum elevation angle at which sensor can point.


Parameter Default Value: -pi/2 radians

DtRwReal DtSensorFieldOfViewEntry::myMaxElevationAngle
protected

Parameter Name: max-elevation-angle
Parameter Description: Maximum elevation angle at which sensor can point.


Parameter Default Value: pi/2 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:

Document ID: Generated on Thu Mar 23 18:54:12 EDT 2017 from SVN revision 174804
Copyright © 2005-2017 VT MÄK. All Rights Reserved (www.mak.com)