emitterBeamData.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2014 VT MAK
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include <portal/dllExport.h>
#include <portal/addAttribute.h>

#include <vlutil/vlMachineTypes.h>
#include <vlutil/vlString.h>

#include <ostream>
#include <vector>
#include <list>

//#include <portal/dllExport.h>
//#include <portal/addAttribute.h>
//#include <iosfwd>

namespace MAKVrExchange
{

   class DT_DLL_LIBPORTAL DtEmitterBeamData
   {
   public:

      typedef enum
      {
         RegularBeam = -1, 
         RadarBeam   =  1, 
         TrackBeam   =  1, 
         JamBeam     =  0  
      } BeamType;

   public:

      DtEmitterBeamData( const BeamType beamType = RegularBeam );

      DtEmitterBeamData( const DtEmitterBeamData& original );

      virtual ~DtEmitterBeamData();

      virtual DtEmitterBeamData& operator = ( const DtEmitterBeamData& original );


      virtual bool operator != ( const DtEmitterBeamData& rightOperand ) const;
      virtual bool operator == ( const DtEmitterBeamData& rightOperand ) const;


      virtual std::ostream& printDataToStream( std::ostream& stream ) const;


      DtDEC_ATTRIBUTE( DtString, Identifier, identifier );

      DtDEC_ATTRIBUTE( DtU32, BeamType, beamType ); //required!

      DtDEC_ATTRIBUTE( DtU16, BeamParameterIndex, beamParameterIndex );

      /* The next 4 attributes constitute the Scan Volume */

      DtDEC_ATTRIBUTE( DtFloat32, BeamAzimuthCenter, beamAzimuthCenter );

      DtDEC_ATTRIBUTE( DtFloat32, BeamAzimuthSweep, beamAzimuthSweep );

      DtDEC_ATTRIBUTE( DtFloat32, BeamElevationCenter, beamElevationCenter );

      DtDEC_ATTRIBUTE( DtFloat32, BeamElevationSweep, beamElevationSweep );

      DtDEC_ATTRIBUTE( DtU32, BeamFunctionCode, beamFunctionCode );

      DtDEC_ATTRIBUTE( DtU8, BeamIdentifier, beamIdentifier );

      DtDEC_ATTRIBUTE( DtFloat32, EffectiveRadiatedPower, effectiveRadiatedPower );

      DtDEC_ATTRIBUTE( DtFloat32, EmissionFrequency, emissionFrequency );

      DtDEC_ATTRIBUTE( DtString, EmitterSystemIdentifier, emitterSystemIdentifier );

      DtDEC_ATTRIBUTE( DtString, EventIdentifier, eventIdentifier );

      DtDEC_ATTRIBUTE( DtFloat32, FrequencyRange, frequencyRange );

      DtDEC_ATTRIBUTE( DtFloat32, PulseRepetitionFrequency, pulseRepetitionFrequency );

      DtDEC_ATTRIBUTE( DtFloat32, PulseWidth, pulseWidth );

      DtDEC_ATTRIBUTE( DtFloat32, SweepSynch, sweepSynch );

      /* The following 2 attributes are for Radar Beam Objects only.  Should only be
      set if myBeamType = DtRadarBeam */

      DtDEC_ATTRIBUTE( bool, HighDensityTrack, highDensityTrack );

      DtDEC_ATTRIBUTE( std::vector<DtString>, TrackObjectIdentifiers, trackObjectIdentifiers );

      /* The following 3 attributes are for Jammer Beam Objects only.  Should only be
      set if myBeamType = DtJamBeam */

      DtDEC_ATTRIBUTE_OVERLOAD( bool, HighDensityJam, highDensityJam, HighDensityTrack );

      DtDEC_ATTRIBUTE( DtU32, JammingModeSequence, jammingModeSequence );

      DtDEC_ATTRIBUTE_OVERLOAD( std::vector<DtString>, JammedObjectIdentifiers,
         jammedObjectIdentifiers, TrackObjectIdentifiers );


   };


   typedef std::list<DtEmitterBeamData> DtEmitterBeamList;

   DT_DLL_LIBPORTAL std::ostream& operator << ( std::ostream& stream, const DtEmitterBeamData& data );
   DT_DLL_LIBPORTAL std::ostream& operator << ( std::ostream& stream, const DtEmitterBeamList& container );

}

void DtPrintAttribute( std::ostream& stream, const char* label,
   MAKVrExchange::DtEmitterBeamData::BeamType value );

DT_DLL_LIBPORTAL const char* DtEnumString( MAKVrExchange::DtEmitterBeamData::BeamType value );