VR-Forces 5.0.3 Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions
DtActiveSonarBeamListEntry Class Reference

DtActiveSonarBeamListEntry; descriptor that represents members of a DtActiveSonarBeamList object.

Instances of DtActiveSonarBeamListEntry are used by the DtActiveSonarBeamList class to parse the beam parameters portion of the opd file.

Inheritance diagram for DtActiveSonarBeamListEntry:
Inheritance graph
[legend]

Public Member Functions

 DtActiveSonarBeamListEntry ()
 
 DtActiveSonarBeamListEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtActiveSonarBeamListEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 
virtual ~DtActiveSonarBeamListEntry ()
 
 DtActiveSonarBeamListEntry (const DtString &name, const DtActiveSonarBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
 DtActiveSonarBeamListEntry (const DtSymbolString &name, const DtActiveSonarBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 
DtActiveSonarBeamListEntry & operator= (const DtActiveSonarBeamListEntry &orig)
 
virtual
DtActiveSonarBeamListEntry * 		clone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual
DtActiveSonarBeamListEntry * 		clone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
 
virtual DtInt16 index () const
 
virtual void setIndex (DtInt16 index)
 
virtual DtString beamType () const
 
virtual void setBeamType (const DtString &typeString)
 
virtual DtFloat32 azimuthCenter () const
 
virtual void setAzimuthCenter (DtFloat32 value)
 
virtual DtFloat32 azimuthBeamwidth () const
 
virtual void setAzimuthBeamwidth (DtFloat32 value)
 
virtual DtFloat32 elevationCenter () const
 
virtual void setElevationCenter (DtFloat32 value)
 
virtual DtFloat32 elevationBeamwidth () const
 
virtual void setElevationBeamwidth (DtFloat32 value)
 
virtual DtU16 beamParamIndex () const
 
virtual void setBeamParamIndex (DtU16 value)
 
virtual DtU16 scanPattern () const
 
virtual void setScanPattern (DtU16 value)
 
- 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.

DtRwInt myIndex
 
DtRwString myBeamType
 
DtRwReal myAzCenter
 
DtRwReal myAzBeamwidth
 
DtRwReal myElCenter
 
DtRwReal myElBeamwidth
 
DtRwInt myBeamFunction
 
DtRwInt myBeamParamIndex
 
DtRwInt myScanPattern
 
- 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

DtActiveSonarBeamListEntry::DtActiveSonarBeamListEntry ( )

default constructor

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

real constructor

DtActiveSonarBeamListEntry::DtActiveSonarBeamListEntry ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
)
virtual DtActiveSonarBeamListEntry::~DtActiveSonarBeamListEntry ( )
virtual

destructor

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

copy constructor

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

Member Function Documentation

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

assignment operator

virtual DtActiveSonarBeamListEntry* DtActiveSonarBeamListEntry::clone ( const DtString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
) const
virtual
virtual DtActiveSonarBeamListEntry* DtActiveSonarBeamListEntry::clone ( const DtSymbolString &  name,
DtReaderWriterRegistry *  parentRegistry = NULL 
) const
virtual
virtual DtInt16 DtActiveSonarBeamListEntry::index ( ) const
virtual

Accessor/mutator for myIndex.

virtual void DtActiveSonarBeamListEntry::setIndex ( DtInt16  index)
virtual

Accessor/mutator for myIndex.

virtual DtString DtActiveSonarBeamListEntry::beamType ( ) const
virtual

Accessor/mutator for myBeamType.

virtual void DtActiveSonarBeamListEntry::setBeamType ( const DtString &  typeString)
virtual

Accessor/mutator for myBeamType.

virtual DtFloat32 DtActiveSonarBeamListEntry::azimuthCenter ( ) const
virtual

Accessor/mutator for myAzCenter.

virtual void DtActiveSonarBeamListEntry::setAzimuthCenter ( DtFloat32  value)
virtual

Accessor/mutator for myAzCenter.

virtual DtFloat32 DtActiveSonarBeamListEntry::azimuthBeamwidth ( ) const
virtual

Accessor/mutator for myAzBeamwidth.

virtual void DtActiveSonarBeamListEntry::setAzimuthBeamwidth ( DtFloat32  value)
virtual

Accessor/mutator for myAzBeamwidth.

virtual DtFloat32 DtActiveSonarBeamListEntry::elevationCenter ( ) const
virtual

Accessor/mutator for myElCenter.

virtual void DtActiveSonarBeamListEntry::setElevationCenter ( DtFloat32  value)
virtual

Accessor/mutator for myElCenter.

virtual DtFloat32 DtActiveSonarBeamListEntry::elevationBeamwidth ( ) const
virtual

Accessor/mutator for myElBeamwidth.

virtual void DtActiveSonarBeamListEntry::setElevationBeamwidth ( DtFloat32  value)
virtual

Accessor/mutator for myElBeamwidth.

virtual DtU16 DtActiveSonarBeamListEntry::beamParamIndex ( ) const
virtual

Accessor/mutator for myBeamParamIndex.

virtual void DtActiveSonarBeamListEntry::setBeamParamIndex ( DtU16  value)
virtual

Accessor/mutator for myBeamParamIndex.

virtual DtU16 DtActiveSonarBeamListEntry::scanPattern ( ) const
virtual

Accessor/mutator for myScanPattern.

virtual void DtActiveSonarBeamListEntry::setScanPattern ( DtU16  value)
virtual

Accessor/mutator for myScanPattern.

Member Data Documentation

DtRwInt DtActiveSonarBeamListEntry::myIndex
protected

Parameter Name: index
Parameter Description:
Parameter Default Value: -1.

DtRwString DtActiveSonarBeamListEntry::myBeamType
protected

Parameter Name: type
Parameter Description: The type of beam, tracking or jamming. The string must be one of the two possible values.
Parameter Default Value: "track"
Parameter Units: "track" or "jam".

DtRwReal DtActiveSonarBeamListEntry::myAzCenter
protected

Parameter Name: azimuth-center
Parameter Description: Azimuth center of beam.
Parameter Default Value: 0.
Parameter Units: radians.

DtRwReal DtActiveSonarBeamListEntry::myAzBeamwidth
protected

Parameter Name: azimuth-beamwidth
Parameter Description: Azimuth width of beam.
Parameter Default Value: 0.
Parameter Units: radians.

DtRwReal DtActiveSonarBeamListEntry::myElCenter
protected

Parameter Name: elevation-center
Parameter Description: Elevation center of beam.
Parameter Default Value: 0.
Parameter Units: radians.

DtRwReal DtActiveSonarBeamListEntry::myElBeamwidth
protected

Parameter Name: elevation-beamwidth
Parameter Description: Elevation width of beam.
Parameter Default Value: 0.
Parameter Units: radians.

DtRwInt DtActiveSonarBeamListEntry::myBeamFunction
protected

Parameter Name: beam-function-enum
Parameter Description: Beam function enumeration. (See the DIS Enumerations Document.)
Parameter Default Value: 0.

DtRwInt DtActiveSonarBeamListEntry::myBeamParamIndex
protected

Parameter Name: beam-param-index
Parameter Description: Beam parameter index.
Parameter Default Value: 0.

DtRwInt DtActiveSonarBeamListEntry::myScanPattern
protected

Parameter Name: scan-pattern
Parameter Description: Beam scan pattern.
Parameter Default Value: 0.

The documentation for this class was generated from the following file:
Document ID: Generated on Thu Jun 1 17:58:13 EDT 2023 from SVN revision 255404
Copyright © 2005-2021 MAK Technologies. All Rights Reserved (www.mak.com)