radioTransmitterRepository.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 1992-2010 MAK Technologies, Inc
** All rights reserved.
*******************************************************************************/

#ifndef DtRadioTransmitterRepository_H_
#define DtRadioTransmitterRepository_H_


#include "embeddedSystemRepository.h"
#include "antennaPatternRecord.h"
#include "sincgarsModulation.h"
#include <vlpi/thresholder.h>

#ifndef DT_ENUM_LONG_WORD_PORTION
#define DT_ENUM_LONG_WORD_PORTION
enum DtLongWordPortion
{
   DtUpperWord,
   DtLowerWord
};
#endif


class DT_DLL_VL DtRadioTransmitterRepository : 
   public DtEmbeddedSystemRepository
{
public:

   DtRadioTransmitterRepository();

   virtual ~DtRadioTransmitterRepository();

   DtRadioTransmitterRepository(const DtRadioTransmitterRepository& orig);

   DtRadioTransmitterRepository& operator=(
      const DtRadioTransmitterRepository& orig);

   virtual DtStateRepository* clone(bool copy) const; 

   virtual void setAntennaPattern(const DtAntennaPatternRecord& rec);

   virtual const DtAntennaPatternRecord& antennaPattern() const;

   virtual DtAntennaPatternRecord& antennaPattern();

   virtual void setAntennaPatternType(DtAntennaPatternType pattern);
   virtual DtAntennaPatternType antennaPatternType() const;

   virtual void setCryptoKeyId(DtU16 key);
   virtual DtU16 cryptoKeyId() const;

   virtual void setCryptoMode(DtCryptoMode mode);
   virtual DtCryptoMode cryptoMode() const;

   virtual void setCryptoSystem(DtRadioCryptoSystem system);
   virtual DtRadioCryptoSystem cryptoSystem() const;

   virtual void setDetailedModulationType(DtDetailedModulationType modulation);
   virtual DtDetailedModulationType detailedModulationType() const;


   virtual void setFrequency(unsigned long upper, unsigned long lower);

   virtual unsigned long frequency(DtLongWordPortion upperLower) const;
   

   virtual void setFrequency(DtU64 freq);
   virtual DtU64 frequency() const;

   virtual void setStreamTag(unsigned long upper, unsigned long lower);
   virtual void setStreamTag(unsigned long st);
 
   virtual unsigned long streamTag(
      DtLongWordPortion upperLower = DtLowerWord) const;

   virtual void setFrequencyBandwidth(DtFloat32 bandwidth);
   virtual DtFloat32 frequencyBandwidth() const;

   virtual void setFrequencyHopInUse(bool hopInUse);
   virtual bool frequencyHopInUse() const;

   virtual void setInputSource(DtRadioInputSource source);
   virtual DtRadioInputSource inputSource() const;

   virtual void setModulationParams(
      const void *networkRepresentation, DtU8 size);
   virtual const void *modulationParamsAddr() const;   
   virtual DtU8 modulationParamsLength() const;

   virtual void setMajorModulationType(DtRadioMajorModulation modulation);
   virtual DtRadioMajorModulation majorModulationType() const;

   virtual void setModulationSystemType(DtRadioSystem system);
   virtual DtRadioSystem modulationSystemType() const;

   virtual void setPower(DtFloat32 power);
   virtual DtFloat32 power() const;

   virtual void setPsuedoNoiseSpectrumInUse(bool inUse);
   virtual bool psuedoNoiseSpectrumInUse() const;

   virtual void setPseudoNoiseSpectrumInUse(bool inUse);
   virtual bool pseudoNoiseSpectrumInUse() const;

   virtual void setRadioId(unsigned int number);
   virtual unsigned int radioId() const;

   virtual void setRadioEntityType(const DtRadioEntityType& type);
   virtual const DtRadioEntityType& radioEntityType() const;

   virtual void setTimeHopInUse(bool inUse);
   virtual bool timeHopInUse() const;

   virtual void setTransmitState(DtRadioTransmitState state);
   virtual DtRadioTransmitState transmitState() const;

   virtual void setWorldAntennaLoc(const DtVector& location);
   virtual const DtVector& worldAntennaLoc() const;

   virtual void setRelativeAntennaLoc(const DtVector32& location);
   virtual const DtVector32& relativeAntennaLoc() const;




   virtual void setSpreadSpectrumType(DtSpreadSpectrumType ty);
   virtual DtSpreadSpectrumType spreadSpectrumType() const;

   virtual void setFHNetId(DtU16 id);
   virtual DtU16 fHNetId() const;

   virtual void setHopSetId(DtU16 id);
   virtual DtU16 hopSetId() const;

   virtual void setLockoutSetId(DtU16 id);
   virtual DtU16 lockoutSetId() const;

   virtual void setTransmissionSecurityKey(DtU16 key);
   virtual DtU16 transmissionSecurityKey() const;

   virtual void setFHSynchronizationTimeOffset(DtU32 id);
   virtual DtU32 fHSynchronizationTimeOffset() const;

   virtual void setClearChannel(DtU8 chan);
   virtual DtU8 clearChannel() const;

   virtual void setStartOfMessage(DtStartMessage mess);
   virtual DtStartMessage startOfMessage() const;



   

   virtual void setFidelityLevel(DtU16 level);
   virtual DtU16 fidelityLevel() const;
   
   virtual void setCommunicationMode(DtLink16CommunicationMode mode);
   virtual DtLink16CommunicationMode communicationMode() const;

   virtual void setPrimaryMode(DtU16 mode);
   virtual DtU16 primaryMode() const;

   virtual void setSecondaryMode(DtU16 mode);
   virtual DtU16 secondaryMode() const;

   virtual void setSynchronizationState(DtU16 val);
   virtual DtU16 synchronizationState() const;

   virtual void setNetworkSynchronizationId(int val);
   virtual int networkSynchronizationId() const;

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

   virtual DtThresholder* thresholder();
   virtual const DtThresholder& thresholder() const;

public:

   static DtRadioTransmitterRepository* create();

protected:

   DtAntennaPatternType       myAntennaPatternType;
   DtU16                      myCryptoKeyId;
   DtCryptoMode               myCryptoMode;
   DtRadioCryptoSystem        myCryptoSystem;
   DtDetailedModulationType   myDetailedModulation;
   DtU64                      myFrequency; 
   DtU32                      myStreamTagHi; 
   DtU32                      myStreamTagLo; 
   DtFloat32                  myFrequencyBandwidth;
   bool                       myFrequencyHopInUse;
   DtRadioInputSource         myInputSource;
   char*                      myModulationParamsAddr;
   DtU8                       myModulationParamsLength;
   DtAntennaPatternRecord*    myAntPat;
   DtRadioMajorModulation     myMajorModulationType;
   DtRadioSystem              myModulationSystem;
   DtFloat32                  myPower;
   bool                       myPseudoNoiseSpectrumInUse;
   DtU16                      myTransmitterRadioNumber;
   DtRadioEntityType          myRadioEntityType;
   bool                       myTimeHopInUse;
   DtRadioTransmitState       myTransmitState;
   DtVector                   myWorldLocation;
   DtSpreadSpectrumType       mySpreadSpectrumType;
   DtThresholder              myThresholder;
   DtU16                      myFHNetId;
   DtU16                      myHopSetId;
   DtU16                      myLockoutSetId;
   DtU16                      myTransmissionSecurityKey;
   DtU32                      myFHSynchronizationTimeOffset;
   DtU8                       myClearChannel;
   DtStartMessage             myStartOfMessage;
   DtU16                      myFidelityLevel;
   DtLink16CommunicationMode  myCommunicationMode;
   DtU16                      myPrimaryMode;
   DtU16                      mySecondaryMode;
   DtU16                      mySynchronizationState;
   int                        myNetworkSynchronizationId;
};

#endif   //DtRadioTransmitterRepository_H_