VR-Forces 4.0.4 Class Documentation
Public Member Functions
DtEmitterBeamListEntry Class Reference

DtEmitterBeamListEntry; descriptor that represents members of a DtEmitterBeamList object. More...

Inheritance diagram for DtEmitterBeamListEntry:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 DtEmitterBeamListEntry ()
 default constructor
 DtEmitterBeamListEntry (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL)
 real constructor
 DtEmitterBeamListEntry (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL)
virtual ~DtEmitterBeamListEntry ()
 destructor
 DtEmitterBeamListEntry (const DtString &name, const DtEmitterBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
 copy constructor
 DtEmitterBeamListEntry (const DtSymbolString &name, const DtEmitterBeamListEntry &orig, DtReaderWriterRegistry *parentRegistry=NULL)
DtEmitterBeamListEntryoperator= (const DtEmitterBeamListEntry &orig)
 assignment operator
virtual DtEmitterBeamListEntryclone (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtEmitterBeamListEntryclone (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL) const
virtual DtInt16 index () const
 Accessor/mutator for myIndex.
virtual void setIndex (DtInt16 index)
 Accessor/mutator for myIndex.
virtual DtString beamType () const
 Accessor/mutator for myBeamType.
virtual void setBeamType (const DtString &typeString)
 Accessor/mutator for myBeamType.
virtual DtFloat32 frequency () const
 Accessor/mutator for myFrequency.
virtual void setFrequency (DtFloat32 value)
 Accessor/mutator for myFrequency.
virtual DtFloat32 frequencyRange () const
 Accessor/mutator for myFrequencyRange.
virtual void setFrequencyRange (DtFloat32 value)
 Accessor/mutator for myFrequencyRange.
virtual DtFloat32 power () const
 Accessor/mutator for myPower.
virtual void setPower (DtFloat32 value)
 Accessor/mutator for myPower.
virtual DtFloat32 prf () const
 Accessor/mutator for myPrf.
virtual void setPrf (DtFloat32 value)
 Accessor/mutator for myPrf.
virtual DtFloat32 pulseWidth () const
 Accessor/mutator for myPulseWidth.
virtual void setPulseWidth (DtFloat32 value)
 Accessor/mutator for myPulseWidth.
virtual DtFloat32 azimuthCenter () const
 Accessor/mutator for myAzCenter.
virtual void setAzimuthCenter (DtFloat32 value)
 Accessor/mutator for myAzCenter.
virtual DtFloat32 azimuthSweep () const
 Accessor/mutator for myAzSweep.
virtual void setAzimuthSweep (DtFloat32 value)
 Accessor/mutator for myAzSweep.
virtual DtFloat32 elevationCenter () const
 Accessor/mutator for myElCenter.
virtual void setElevationCenter (DtFloat32 value)
 Accessor/mutator for myElCenter.
virtual DtFloat32 elevationSweep () const
 Accessor/mutator for myElSweep.
virtual void setElevationSweep (DtFloat32 value)
 Accessor/mutator for myElSweep.
virtual DtFloat32 sweepSync () const
 Accessor/mutator for mySweepSync.
virtual void setSweepSync (DtFloat32 value)
 Accessor/mutator for mySweepSync.
virtual DtU16 beamFunction () const
 Accessor/mutator for myBeamFunction.
virtual void setBeamFunction (DtU16 functionEnum)
 Accessor/mutator for myBeamFunction.
virtual DtU16 beamParamIndex () const
 Accessor/mutator for myBeamParamIndex.
virtual void setBeamParamIndex (DtU16 value)
 Accessor/mutator for myBeamParamIndex.

Protected Attributes

Parameters

These parameters are available for setting in the OPD files.

DtRwInt myIndex
 Parameter Name: index
Parameter Description:
Parameter Default Value: -1.
DtRwString myBeamType
 Parameter Name: type
Parameter Description: The type of beam, tracking or jamming.
DtRwReal myFrequency
 Parameter Name: frequency
Parameter Description: Center frequency of emission.
DtRwReal myFrequencyRange
 Parameter Name: frequency-range
Parameter Description: Frequency range around center.
DtRwReal myPower
 Parameter Name: power
Parameter Description: Effective radiated power.
DtRwReal myPrf
 Parameter Name: pulse-repetition-frequency
Parameter Description: Pulse repetition frequency.
DtRwReal myPulseWidth
 Parameter Name: pulse-width
Parameter Description: Pulse width.
DtRwReal myAzCenter
 Parameter Name: azimuth-center
Parameter Description: Azimuth center of emission.
DtRwReal myAzSweep
 Parameter Name: azimuth-sweep
Parameter Description: Azimuth range around center.
DtRwReal myElCenter
 Parameter Name: elevation-center
Parameter Description: Elevation center of emission.
DtRwReal myElSweep
 Parameter Name: elevation-sweep
Parameter Description: Elevation range around center.
DtRwReal mySweepSync
 Parameter Name: sweep-sync
Parameter Description: Sweep sync, as a percentage.
DtRwInt myBeamFunction
 Parameter Name: beam-function-enum
Parameter Description: Beam function enumeration.
DtRwInt myBeamParamIndex
 Parameter Name: beam-param-index
Parameter Description: Beam parameter index.

Detailed Description

DtEmitterBeamListEntry; descriptor that represents members of a DtEmitterBeamList object.

Instances of DtEmitterBeamListEntry are used by the DtEmitterBeamList class to parse the beam parameters portion of the opd file.


Constructor & Destructor Documentation

default constructor

DtEmitterBeamListEntry::DtEmitterBeamListEntry ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
)

real constructor

destructor

DtEmitterBeamListEntry::DtEmitterBeamListEntry ( const DtString name,
const DtEmitterBeamListEntry orig,
DtReaderWriterRegistry parentRegistry = NULL 
)

copy constructor


Member Function Documentation

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

assignment operator

virtual DtEmitterBeamListEntry* DtEmitterBeamListEntry::clone ( const DtString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]
virtual DtEmitterBeamListEntry* DtEmitterBeamListEntry::clone ( const DtSymbolString name,
DtReaderWriterRegistry parentRegistry = NULL 
) const [virtual]
virtual DtInt16 DtEmitterBeamListEntry::index ( ) const [virtual]

Accessor/mutator for myIndex.

virtual void DtEmitterBeamListEntry::setIndex ( DtInt16  index) [virtual]

Accessor/mutator for myIndex.

virtual DtString DtEmitterBeamListEntry::beamType ( ) const [virtual]

Accessor/mutator for myBeamType.

virtual void DtEmitterBeamListEntry::setBeamType ( const DtString typeString) [virtual]

Accessor/mutator for myBeamType.

virtual DtFloat32 DtEmitterBeamListEntry::frequency ( ) const [virtual]

Accessor/mutator for myFrequency.

virtual void DtEmitterBeamListEntry::setFrequency ( DtFloat32  value) [virtual]

Accessor/mutator for myFrequency.

virtual DtFloat32 DtEmitterBeamListEntry::frequencyRange ( ) const [virtual]

Accessor/mutator for myFrequencyRange.

virtual void DtEmitterBeamListEntry::setFrequencyRange ( DtFloat32  value) [virtual]

Accessor/mutator for myFrequencyRange.

virtual DtFloat32 DtEmitterBeamListEntry::power ( ) const [virtual]

Accessor/mutator for myPower.

virtual void DtEmitterBeamListEntry::setPower ( DtFloat32  value) [virtual]

Accessor/mutator for myPower.

virtual DtFloat32 DtEmitterBeamListEntry::prf ( ) const [virtual]

Accessor/mutator for myPrf.

virtual void DtEmitterBeamListEntry::setPrf ( DtFloat32  value) [virtual]

Accessor/mutator for myPrf.

virtual DtFloat32 DtEmitterBeamListEntry::pulseWidth ( ) const [virtual]

Accessor/mutator for myPulseWidth.

virtual void DtEmitterBeamListEntry::setPulseWidth ( DtFloat32  value) [virtual]

Accessor/mutator for myPulseWidth.

virtual DtFloat32 DtEmitterBeamListEntry::azimuthCenter ( ) const [virtual]

Accessor/mutator for myAzCenter.

virtual void DtEmitterBeamListEntry::setAzimuthCenter ( DtFloat32  value) [virtual]

Accessor/mutator for myAzCenter.

virtual DtFloat32 DtEmitterBeamListEntry::azimuthSweep ( ) const [virtual]

Accessor/mutator for myAzSweep.

virtual void DtEmitterBeamListEntry::setAzimuthSweep ( DtFloat32  value) [virtual]

Accessor/mutator for myAzSweep.

virtual DtFloat32 DtEmitterBeamListEntry::elevationCenter ( ) const [virtual]

Accessor/mutator for myElCenter.

virtual void DtEmitterBeamListEntry::setElevationCenter ( DtFloat32  value) [virtual]

Accessor/mutator for myElCenter.

virtual DtFloat32 DtEmitterBeamListEntry::elevationSweep ( ) const [virtual]

Accessor/mutator for myElSweep.

virtual void DtEmitterBeamListEntry::setElevationSweep ( DtFloat32  value) [virtual]

Accessor/mutator for myElSweep.

virtual DtFloat32 DtEmitterBeamListEntry::sweepSync ( ) const [virtual]

Accessor/mutator for mySweepSync.

virtual void DtEmitterBeamListEntry::setSweepSync ( DtFloat32  value) [virtual]

Accessor/mutator for mySweepSync.

virtual DtU16 DtEmitterBeamListEntry::beamFunction ( ) const [virtual]

Accessor/mutator for myBeamFunction.

virtual void DtEmitterBeamListEntry::setBeamFunction ( DtU16  functionEnum) [virtual]

Accessor/mutator for myBeamFunction.

virtual DtU16 DtEmitterBeamListEntry::beamParamIndex ( ) const [virtual]

Accessor/mutator for myBeamParamIndex.

virtual void DtEmitterBeamListEntry::setBeamParamIndex ( DtU16  value) [virtual]

Accessor/mutator for myBeamParamIndex.


Member Data Documentation

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

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".

Parameter Name: frequency
Parameter Description: Center frequency of emission.


Parameter Default Value: 0.
Parameter Units: Hertz

Parameter Name: frequency-range
Parameter Description: Frequency range around center.


Parameter Default Value: 0.
Parameter Units: Hertz

Parameter Name: power
Parameter Description: Effective radiated power.


Parameter Default Value: 0.
Parameter Units: dBm

Parameter Name: pulse-repetition-frequency
Parameter Description: Pulse repetition frequency.


Parameter Default Value: 0.
Parameter Units: Hertz

Parameter Name: pulse-width
Parameter Description: Pulse width.


Parameter Default Value:
Parameter Units: milliseconds

Parameter Name: azimuth-center
Parameter Description: Azimuth center of emission.


Parameter Default Value: 0.
Parameter Units: radians

Parameter Name: azimuth-sweep
Parameter Description: Azimuth range around center.


Parameter Default Value: 0.
Parameter Units: radians

Parameter Name: elevation-center
Parameter Description: Elevation center of emission.


Parameter Default Value: 0.
Parameter Units: radians

Parameter Name: elevation-sweep
Parameter Description: Elevation range around center.


Parameter Default Value: 0.
Parameter Units: radians

Parameter Name: sweep-sync
Parameter Description: Sweep sync, as a percentage.


Parameter Default Value: 0.

Parameter Name: beam-function-enum
Parameter Description: Beam function enumeration.

(See the DIS Enumerations Document.)
Parameter Default Value: 0

Parameter Name: beam-param-index
Parameter Description: Beam parameter index.


Parameter Default Value: 0


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

Document ID: Generated on Fri Jun 29 16:33:32 EDT 2012 from SVN revision 116588
Copyright © 2005-2012 VT MÄK Inc. All Rights Reserved (www.mak.com)