VR-Exchange 2.2 API Documentation
List of all members | Public Types | Public Member Functions
MAKVrExchange::DtEmitterBeamData Class Reference

Represents Emitter Beam Objects. More...

Public Types

enum  BeamType { RegularBeam = -1, RadarBeam = 1, TrackBeam = 1, JamBeam = 0 }
 Indicates the type of data contained within DtEmitterBeamData. More...

Public Member Functions

 DtEmitterBeamData (const BeamType beamType=RegularBeam)
 ~DtEmitterBeamData ()
 DtEmitterBeamData (const DtEmitterBeamData &original)
DtEmitterBeamDataoperator= (const DtEmitterBeamData &original)
bool operator== (const DtEmitterBeamData &rightOperand) const
bool operator!= (const DtEmitterBeamData &rightOperand) const
virtual std::ostream & printDataToStream (std::ostream &stream) const
 Prints the byte array to a stream in hex.
Data Exchange Attributes

The Attributes of the Emitter Beam Object.

Includes Radar Beam, and Jammer Beam attributes.

 DtDEC_ATTRIBUTE (DtU32, BeamType, beamType)
 The angle, in azimuth, of the center of the emitter beam's scan volume relative to the emitter system.
 DtDEC_ATTRIBUTE (DtU16, BeamParameterIndex, beamParameterIndex)
 The angle, in azimuth, of the center of the emitter beam's scan volume relative to the emitter system.
 DtDEC_ATTRIBUTE (DtFloat32, BeamAzimuthCenter, beamAzimuthCenter)
 The angle, in azimuth, of the center of the emitter beam's scan volume relative to the emitter system.
 DtDEC_ATTRIBUTE (DtFloat32, BeamAzimuthSweep, beamAzimuthSweep)
 The angle, relative to the emitter system, indicating the half angle that the emitter beam sweeps through, in azimuth.
 DtDEC_ATTRIBUTE (DtFloat32, BeamElevationCenter, beamElevationCenter)
 The angle, in elevation, of the center of the emitter beam's scan volume relative to the emitter system.
 DtDEC_ATTRIBUTE (DtFloat32, BeamElevationSweep, beamElevationSweep)
 The angle, relative to the emitter system, indicating the half angle that the emitter beam sweeps through, in elevation.
 DtDEC_ATTRIBUTE (DtU32, BeamFunctionCode, beamFunctionCode)
 The function of the emitter beam.
 DtDEC_ATTRIBUTE (DtU8, BeamIdentifier, beamIdentifier)
 The identification of the emitter beam (must be unique on the emitter system).
 DtDEC_ATTRIBUTE (DtFloat32, EffectiveRadiatedPower, effectiveRadiatedPower)
 The effective radiated power of the emitter beam.
 DtDEC_ATTRIBUTE (DtFloat32, EmissionFrequency, emissionFrequency)
 The center frequency of the emitter beam.
 DtDEC_ATTRIBUTE (DtString, EmitterSystemIdentifier, emitterSystemIdentifier)
 The identification of the emitter system that is generating this emitter beam.
 DtDEC_ATTRIBUTE (DtString, EventIdentifier, eventIdentifier)
 The EventIdentifier is used by the generating federate to associate related events.
 DtDEC_ATTRIBUTE (DtFloat32, FrequencyRange, frequencyRange)
 The bandwidth of the frequencies covered by the emitter beam.
 DtDEC_ATTRIBUTE (DtFloat32, PulseRepetitionFrequency, pulseRepetitionFrequency)
 The Pulse Repetition Frequency of the emitter beam.
 DtDEC_ATTRIBUTE (DtFloat32, PulseWidth, pulseWidth)
 The pulse width of the emitter beam.
 DtDEC_ATTRIBUTE (DtFloat32, SweepSynch, sweepSynch)
 The percentage of the way through the scan of the emitter beam.
 DtDEC_ATTRIBUTE (bool, HighDensityTrack, highDensityTrack)
 Indicate whether or not all targets can be considered within the scan pattern that the emitter can track.
 DtDEC_ATTRIBUTE (std::vector< DtString >, TrackObjectIdentifiers, trackObjectIdentifiers)
 Identifies the targets in an emitter track or emitters a system is attempting to jam.
 DtDEC_ATTRIBUTE_OVERLOAD (bool, HighDensityJam, highDensityJam, HighDensityTrack)
 to indicate whether or not all targets can be considered within the scan pattern that the jammer can jam.
 DtDEC_ATTRIBUTE (DtU32, JammingModeSequence, jammingModeSequence)
 jamming mode technique or series of techniques being applied.
 DtDEC_ATTRIBUTE_OVERLOAD (std::vector< DtString >, JammedObjectIdentifiers, jammedObjectIdentifiers, TrackObjectIdentifiers)
 identifies the targets in an emitter track or emitters a system is attempting to jam.

Detailed Description

Represents Emitter Beam Objects.

Note: This is not a Portal Object! DtPortalEmitterSystemObject is the actual Portal Object which contains DtEmitterBeamData. Some protocols, like DIS and TENA, have one object which contains all the emitter system and emitter beam attributes. HLA RPR FOM on the other hand, seperates the two into two different objects. The VR-Exchnage Portal uses the DIS and TENA method.

Member Enumeration Documentation

Indicates the type of data contained within DtEmitterBeamData.

DtEmitterBeamData contains the attributes for an Emitter Beam Object; as well as its sub-classes, Radar Beam Object, and Jammer Beam Object. For this reason, it is necessary to indicate what kind of data this class hold.

Enumerator:
RegularBeam 

equivalent to VR-Link's DtBeamType::DtRegularBeam

RadarBeam 

equivalent to VR-Link's DtBeamType::DtRadarBeam

TrackBeam 

equivalent to VR-Link's DtBeamType::DtTrackBeam

JamBeam 

equivalent to VR-Link's DtBeamType::DtJamBeam

Constructor & Destructor Documentation

MAKVrExchange::DtEmitterBeamData::DtEmitterBeamData ( const BeamType  beamType = RegularBeam)
MAKVrExchange::DtEmitterBeamData::~DtEmitterBeamData ( )
MAKVrExchange::DtEmitterBeamData::DtEmitterBeamData ( const DtEmitterBeamData original)

Member Function Documentation

DtEmitterBeamData& MAKVrExchange::DtEmitterBeamData::operator= ( const DtEmitterBeamData original)
bool MAKVrExchange::DtEmitterBeamData::operator== ( const DtEmitterBeamData rightOperand) const
bool MAKVrExchange::DtEmitterBeamData::operator!= ( const DtEmitterBeamData rightOperand) const
virtual std::ostream& MAKVrExchange::DtEmitterBeamData::printDataToStream ( std::ostream &  stream) const
virtual

Prints the byte array to a stream in hex.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtU32  ,
BeamType  ,
beamType   
)

The angle, in azimuth, of the center of the emitter beam's scan volume relative to the emitter system.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtU16  ,
BeamParameterIndex  ,
beamParameterIndex   
)

The angle, in azimuth, of the center of the emitter beam's scan volume relative to the emitter system.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
BeamAzimuthCenter  ,
beamAzimuthCenter   
)

The angle, in azimuth, of the center of the emitter beam's scan volume relative to the emitter system.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
BeamAzimuthSweep  ,
beamAzimuthSweep   
)

The angle, relative to the emitter system, indicating the half angle that the emitter beam sweeps through, in azimuth.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
BeamElevationCenter  ,
beamElevationCenter   
)

The angle, in elevation, of the center of the emitter beam's scan volume relative to the emitter system.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
BeamElevationSweep  ,
beamElevationSweep   
)

The angle, relative to the emitter system, indicating the half angle that the emitter beam sweeps through, in elevation.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtU32  ,
BeamFunctionCode  ,
beamFunctionCode   
)

The function of the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtU8  ,
BeamIdentifier  ,
beamIdentifier   
)

The identification of the emitter beam (must be unique on the emitter system).

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
EffectiveRadiatedPower  ,
effectiveRadiatedPower   
)

The effective radiated power of the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
EmissionFrequency  ,
emissionFrequency   
)

The center frequency of the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtString  ,
EmitterSystemIdentifier  ,
emitterSystemIdentifier   
)

The identification of the emitter system that is generating this emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtString  ,
EventIdentifier  ,
eventIdentifier   
)

The EventIdentifier is used by the generating federate to associate related events.

The event number shall start at one at the beginning of the exercise, and be incremented by one for each event.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
FrequencyRange  ,
frequencyRange   
)

The bandwidth of the frequencies covered by the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
PulseRepetitionFrequency  ,
pulseRepetitionFrequency   
)

The Pulse Repetition Frequency of the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
PulseWidth  ,
pulseWidth   
)

The pulse width of the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtFloat32  ,
SweepSynch  ,
sweepSynch   
)

The percentage of the way through the scan of the emitter beam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( bool  ,
HighDensityTrack  ,
highDensityTrack   
)

Indicate whether or not all targets can be considered within the scan pattern that the emitter can track.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( std::vector< DtString ,
TrackObjectIdentifiers  ,
trackObjectIdentifiers   
)

Identifies the targets in an emitter track or emitters a system is attempting to jam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE_OVERLOAD ( bool  ,
HighDensityJam  ,
highDensityJam  ,
HighDensityTrack   
)

to indicate whether or not all targets can be considered within the scan pattern that the jammer can jam.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE ( DtU32  ,
JammingModeSequence  ,
jammingModeSequence   
)

jamming mode technique or series of techniques being applied.

MAKVrExchange::DtEmitterBeamData::DtDEC_ATTRIBUTE_OVERLOAD ( std::vector< DtString ,
JammedObjectIdentifiers  ,
jammedObjectIdentifiers  ,
TrackObjectIdentifiers   
)

identifies the targets in an emitter track or emitters a system is attempting to jam.


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

Document ID: Generated on Mon Apr 15 17:15:50 EDT 2013 from SVN revision 126154
Copyright © 2005-2012 VT MÄK. All Rights Reserved (www.mak.com)