libcyberradio  22.01.24
RadioHandler Class Reference

Radio handler class for the NDR651. More...

#include <RadioHandler.h>

Inheritance diagram for RadioHandler:
RadioHandler Configurable Debuggable

Public Member Functions

virtual ~RadioHandler ()
 Destroys a RadioHandler object.
 
virtual void queryConfiguration ()
 Tells the radio to query its hardware configuration in order to create its configuration dictionary (including the dictionaries of any components managed by the radio).
 
virtual bool isConnected () const
 Gets whether or not the handler is connected. More...
 
virtual BasicStringStringDict getVersionInfo ()
 Gets version information for the radio. More...
 
virtual BasicStringStringDict getConnectionInfo ()
 Gets connection information for the radio. More...
 
virtual bool connect (const std::string &mode, const std::string &host_or_dev, const int port_or_baudrate)
 Connects to the radio. More...
 
virtual void disconnect ()
 Disconnects from the radio.
 
virtual BasicStringList sendCommand (const std::string &cmdString, double timeout=-1)
 Sends a command to the radio. More...
 
virtual bool setConfiguration (ConfigurationDict &cfg)
 Sets the configuration dictionary for this object. More...
 
virtual std::string getLastCommandErrorInfo () const
 Gets the error message from the last command attempted. More...
 
virtual bool sendReset (int resetType=0)
 Resets the radio. More...
 
virtual bool getPps ()
 Gets the pulse-per-second (PPS) rising edge from the radio. More...
 
virtual bool setTimeNextPps (bool checkTime=false, bool useGpsTime=false)
 Sets the time for the next PPS rising edge on the radio. More...
 
virtual time_t getTimeNow ()
 Gets the current radio time. More...
 
virtual time_t getTimeNextPps ()
 Gets the time for the next PPS rising edge on the radio. More...
 
virtual unsigned int getStatus ()
 Gets the status from the radio. More...
 
virtual unsigned int getTstatus ()
 Gets the tuner status from the radio. More...
 
virtual bool setReferenceMode (int mode)
 Sets the reference mode on the radio. More...
 
virtual bool setBypassMode (int mode)
 Sets the reference bypass mode on the radio. More...
 
virtual bool setTimeAdjustment (int tunerIndex, int timeAdjustValue)
 Sets the time adjustment for tuners on the radio. More...
 
virtual BasicDoubleList getGpsPosition ()
 Gets the current GPS position the radio. More...
 
virtual int getTemperature ()
 Gets the current radio temperature. More...
 
virtual int getGpioOutput ()
 Gets the current GPIO output bits. More...
 
virtual BasicIntList getGpioOutputByIndex (int index)
 Gets the GPIO output settings for a given sequence index. More...
 
virtual bool setGpioOutput (int value)
 Sets the current GPIO output bits. More...
 
virtual bool setGpioOutputByIndex (int index, int value, int duration, int loop, int go)
 Sets the GPIO output settings for a given sequence index. More...
 
virtual double getCalibrationFrequency () const
 Gets the calibration frequency. More...
 
virtual bool setCalibrationFrequency (double freq)
 Sets the calibration frequency. More...
 
virtual int getNumDataPorts () const
 Gets the number of 10GigE data ports on the radio. More...
 
virtual BasicIntList getDataPortIndexRange () const
 Gets the range of indices 10GigE data ports on the radio. More...
 
virtual int getNumDataPortDipEntries () const
 Gets the number of UDP destination table entries for the 10GigE data ports on the radio. More...
 
virtual BasicIntList getDataPortDipEntryIndexRange () const
 Gets the list of UDP destination table indices for the 10GigE data ports on the radio. More...
 
virtual BasicStringList getConnectionModeList () const
 Gets the list of connection methods that the radio supports. More...
 
virtual bool isConnectionModeSupported (const std::string &mode) const
 Gets whether the radio supports the given connection mode. More...
 
virtual double getAdcRate () const
 Gets the ADC sample rate. More...
 
virtual int getVitaHeaderSize () const
 Gets the size of the VITA 49 header. More...
 
virtual int getVitaPayloadSize () const
 Gets the size of the VITA 49 payload. More...
 
virtual int getVitaTailSize () const
 Gets the size of the VITA 49 tail. More...
 
virtual bool isByteswapped () const
 Gets whether the VITA 49 is byte-swapped with respect to the host operating system. More...
 
virtual bool isIqSwapped () const
 Gets whether the VITA 49 format swaps real and imaginary (I and Q) portions of each sample. More...
 
virtual const char * getByteOrder () const
 Gets the byte order (endianness) of the VITA 49. More...
 
virtual int getNumTuner () const
 Gets the number of tuners on the radio. More...
 
virtual int getNumTunerBoards () const
 Gets the number of tuner boards on the radio. More...
 
virtual BasicIntList getTunerIndexRange () const
 Gets the tuner index range. More...
 
virtual BasicDoubleList getTunerFrequencyRange () const
 Gets the tunable frequency range. More...
 
virtual double getTunerFrequencyRes () const
 Gets the tuned frequency resolution. More...
 
virtual double getTunerFrequencyUnit () const
 Gets the tuned frequency units for tuners. More...
 
virtual BasicDoubleList getTunerAttenuationRange () const
 Gets the tuner attenuation range. More...
 
virtual double getTunerAttenuationRes () const
 Gets the attenuation resolution. More...
 
virtual bool isTunerEnabled (int index) const
 Gets whether or not a given tuner is enabled. More...
 
virtual bool enableTuner (int index, bool enabled=true)
 Enables a given tuner. More...
 
virtual bool disableTuner (int index)
 Disables a given tuner. More...
 
virtual double getTunerFrequency (int index) const
 Gets the tuned frequency for a given tuner. More...
 
virtual bool setTunerFrequency (int index, double freq)
 Sets the tuned frequency for a given tuner. More...
 
virtual double getTunerAttenuation (int index) const
 Gets the attenuation for a given tuner. More...
 
virtual bool setTunerAttenuation (int index, double atten)
 Sets the attenuation for a given tuner. More...
 
virtual int getTunerFilter (int index) const
 Gets the filter setting for a given tuner. More...
 
virtual bool setTunerFilter (int index, int filter)
 Sets the filter setting for a given tuner. More...
 
virtual ConfigurationDict getTunerConfiguration (int index) const
 Gets the configuration dictionary for a given tuner. More...
 
virtual bool setTunerConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given tuner. More...
 
virtual int getNumWbddc () const
 Gets the number of WBDDCs on the radio. More...
 
virtual BasicIntList getWbddcIndexRange () const
 Gets the range of WBDDC indices on the radio. More...
 
virtual bool isWbddcTunable () const
 Gets whether the WBDDCs on this radio are tunable. More...
 
virtual bool isWbddcSelectableSource () const
 Gets whether the WBDDCs on this radio support selecting their tuner source. More...
 
virtual BasicDoubleList getWbddcFrequencyRange () const
 Gets the tunable frequency range for WBDDCs. More...
 
virtual double getWbddcFrequencyRes () const
 Gets the tuned frequency resolution for WBDDCs. More...
 
virtual double getWbddcFrequencyUnit () const
 Gets the tuned frequency units for WBDDCs. More...
 
virtual WbddcRateSet getWbddcRateSet () const
 Gets the WBDDC rate set. More...
 
virtual BasicDoubleList getWbddcRateList () const
 Gets the list of allowed WBDDC sample rates, based on the rate set. More...
 
virtual bool isWbddcEnabled (int index) const
 Gets whether or not a given WBDDC is enabled. More...
 
virtual bool enableWbddc (int index, bool enabled=true)
 Enables a given WBDDC. More...
 
virtual bool disableWbddc (int index)
 Disables a given WBDDC. More...
 
virtual double getWbddcFrequency (int index) const
 Gets the tuned frequency for a given WBDDC. More...
 
virtual bool setWbddcFrequency (int index, double freq)
 Sets the tuned frequency for a given WBDDC. More...
 
virtual int getWbddcSource (int index) const
 Gets the source (which tuner is supplying the signal) for a given WBDDC. More...
 
virtual bool setWbddcSource (int index, int source)
 Sets the source (which tuner is supplying the signal) for a given WBDDC. More...
 
virtual int getWbddcRateIndex (int index) const
 Gets the rate index for a given WBDDC. More...
 
virtual bool setWbddcRateIndex (int index, int rateIndex)
 Sets the rate index for a given WBDDC. More...
 
virtual int getWbddcUdpDestination (int index) const
 Gets the UDP destination for a given WBDDC. More...
 
virtual bool setWbddcUdpDestination (int index, int dest)
 Sets the UDP destination for a given WBDDC. More...
 
virtual int getWbddcVitaEnable (int index) const
 Gets the VITA 49 setting for a given WBDDC. More...
 
virtual bool setWbddcVitaEnable (int index, int enable)
 Sets the VITA 49 setting for a given WBDDC. More...
 
virtual unsigned int getWbddcStreamId (int index) const
 Gets the VITA 49 stream ID for a given WBDDC. More...
 
virtual bool setWbddcStreamId (int index, unsigned int sid)
 Sets the VITA 49 stream ID for a given WBDDC. More...
 
virtual int getWbddcDataPort (int index) const
 Gets the data port for a given WBDDC. More...
 
virtual bool setWbddcDataPort (int index, int port)
 Sets the data port for a given WBDDC. More...
 
virtual bool setWbddcRateSet (int index, const WbddcRateSet &set)
 Sets the rate set for a given WBDDC. More...
 
virtual ConfigurationDict getWbddcConfiguration (int index) const
 Gets the configuration dictionary for a given WBDDC. More...
 
virtual bool setWbddcConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given WBDDC. More...
 
virtual int getNumNbddc () const
 Gets the number of NBDDCs on the radio. More...
 
virtual BasicIntList getNbddcIndexRange () const
 Gets the range of NBDDC indices on the radio. More...
 
virtual BasicDoubleList getNbddcFrequencyRange () const
 Gets the tunable frequency range for NBDDCs. More...
 
virtual double getNbddcFrequencyRes () const
 Gets the tuned frequency resolution for NBDDCs. More...
 
virtual double getNbddcFrequencyUnit () const
 Gets the tuned frequency units for NBDDCs. More...
 
virtual NbddcRateSet getNbddcRateSet () const
 Gets the NBDDC rate set. More...
 
virtual BasicDoubleList getNbddcRateList () const
 Gets the list of allowed NBDDC sample rates, based on the rate set. More...
 
virtual bool isNbddcEnabled (int index) const
 Gets whether or not a given NBDDC is enabled. More...
 
virtual bool enableNbddc (int index, bool enabled=true)
 Enables a given NBDDC. More...
 
virtual bool disableNbddc (int index)
 Disables a given NBDDC. More...
 
virtual double getNbddcFrequency (int index) const
 Gets the tuned frequency for a given NBDDC. More...
 
virtual bool setNbddcFrequency (int index, double freq)
 Sets the tuned frequency for a given NBDDC. More...
 
virtual int getNbddcSource (int index) const
 Gets the source (which tuner is supplying the signal) for a given NBDDC. More...
 
virtual bool setNbddcSource (int index, int source)
 Sets the source (which tuner is supplying the signal) for a given NBDDC. More...
 
virtual int getNbddcRateIndex (int index) const
 Gets the rate index for a given NBDDC. More...
 
virtual bool setNbddcRateIndex (int index, int rateIndex)
 Sets the rate index for a given NBDDC. More...
 
virtual int getNbddcUdpDestination (int index) const
 Gets the UDP destination for a given NBDDC. More...
 
virtual bool setNbddcUdpDestination (int index, int dest)
 Sets the UDP destination for a given NBDDC. More...
 
virtual int getNbddcVitaEnable (int index) const
 Gets the VITA 49 setting for a given NBDDC. More...
 
virtual bool setNbddcVitaEnable (int index, int enable)
 Sets the VITA 49 setting for a given NBDDC. More...
 
virtual unsigned int getNbddcStreamId (int index) const
 Gets the VITA 49 stream ID for a given NBDDC. More...
 
virtual bool setNbddcStreamId (int index, unsigned int sid)
 Sets the VITA 49 stream ID for a given NBDDC. More...
 
virtual int getNbddcDataPort (int index) const
 Gets the data port for a given NBDDC. More...
 
virtual bool setNbddcDataPort (int index, int port)
 Sets the data port for a given NBDDC. More...
 
virtual bool setNbddcRateSet (int index, const NbddcRateSet &set)
 Sets the rate set for a given NBDDC. More...
 
virtual ConfigurationDict getNbddcConfiguration (int index) const
 Gets the configuration dictionary for a given NBDDC. More...
 
virtual bool setNbddcConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given NBDDC. More...
 
virtual int getNumTransmitters () const
 Gets the number of transmitters on the radio. More...
 
virtual BasicIntList getTransmitterIndexRange () const
 Gets the list of transmitter indices on the radio. More...
 
virtual BasicDoubleList getTransmitterFrequencyRange () const
 Gets the frequency range for the transmitters on the radio. More...
 
virtual double getTransmitterFrequencyRes () const
 Gets the frequency resolution for transmitters on the radio. More...
 
virtual double getTransmitterFrequencyUnit () const
 Gets the frequency unit for transmitters on the radio. More...
 
virtual BasicDoubleList getTransmitterAttenuationRange () const
 Gets the attenuation range for the transmitters on the radio. More...
 
virtual double getTransmitterAttenuationRes () const
 Gets the attenuation resolution for transmitters on the radio. More...
 
virtual bool isTransmitterEnabled (int index) const
 Gets whether a given transmitter is enabled. More...
 
virtual bool enableTransmitter (int index, bool enabled=true)
 Enables a given transmitter. More...
 
virtual bool disableTransmitter (int index)
 Disables a given transmitter. More...
 
virtual double getTransmitterFrequency (int index) const
 Gets the frequency for a given transmitter. More...
 
virtual bool setTransmitterFrequency (int index, double freq)
 Sets the frequency for a given transmitter. More...
 
virtual double getTransmitterAttenuation (int index) const
 Gets the attenuation for a given transmitter. More...
 
virtual bool setTransmitterAttenuation (int index, double atten)
 Sets the attenuation for a given transmitter. More...
 
virtual ConfigurationDict getTransmitterConfiguration (int index) const
 Gets the configuration dictionary for a given transmitter. More...
 
virtual bool setTransmitterConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given transmitter. More...
 
virtual bool transmitterSupportsCW () const
 Gets whether transmitters support continuous-wave (CW) tone generation. More...
 
virtual int getTransmitterCWNum () const
 Gets the number of CW tone generators associated with transmitters on this radio. More...
 
virtual BasicIntList getTransmitterCWIndexRange () const
 Gets the range of indices for CW tone generators. More...
 
virtual BasicDoubleList getTransmitterCWFrequencyRange () const
 Gets the CW frequency range. More...
 
virtual double getTransmitterCWFrequencyRes () const
 Gets the CW frequency resolution. More...
 
virtual BasicDoubleList getTransmitterCWAmplitudeRange () const
 Gets the CW amplitude range. More...
 
virtual double getTransmitterCWAmplitudeRes () const
 Gets the CW amplitude resolution. More...
 
virtual BasicDoubleList getTransmitterCWPhaseRange () const
 Gets the CW phase range. More...
 
virtual int getTransmitterCWPhaseRes () const
 Gets the CW phase resolution. More...
 
virtual bool transmitterSupportsCWSweep () const
 Gets whether the transmitter supports CW tone sweeping. More...
 
virtual bool transmitterSupportsCWSweep (int index, int cwIndex) const
 Gets whether or not a given CW tone generator supports signal sweeps. More...
 
virtual BasicDoubleList getTransmitterCWSweepStartRange () const
 Gets the CW start frequency range. More...
 
virtual double getTransmitterCWSweepStartRes () const
 Gets the CW start frequency resolution. More...
 
virtual BasicDoubleList getTransmitterCWSweepStopRange () const
 Gets the CW stop frequency range. More...
 
virtual double getTransmitterCWSweepStopRes () const
 Gets the CW stop frequency resolution. More...
 
virtual BasicDoubleList getTransmitterCWSweepStepRange () const
 Gets the CW frequency step range. More...
 
virtual double getTransmitterCWSweepStepRes () const
 Gets the CW frequency step resolution. More...
 
virtual BasicDoubleList getTransmitterCWSweepDwellRange () const
 Gets the CW dwell time range. More...
 
virtual double getTransmitterCWSweepDwellRes () const
 Gets the CW dwell time resolution. More...
 
virtual bool enableTransmitterCW (int index, int cwIndex, bool enabled=true)
 Enables a given CW tone generator. More...
 
virtual bool disableTransmitterCW (int index, int cwIndex)
 Disables a given CW tone generator. More...
 
virtual ConfigurationDict getTransmitterCWConfiguration (int index, int cwIndex) const
 Gets the configuration for a given CW tone generator. More...
 
virtual bool setTransmitterCWConfiguration (int index, int cwIndex, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given CW tone generator. More...
 
virtual double getTransmitterCWFrequency (int index, int cwIndex) const
 Gets the constant frequency for a given CW tone generator. More...
 
virtual bool setTransmitterCWFrequency (int index, int cwIndex, double freq)
 Sets the constant frequency for a given CW tone generator. More...
 
virtual double getTransmitterCWAmplitude (int index, int cwIndex) const
 Gets the signal amplitude for a given CW tone generator. More...
 
virtual bool setTransmitterCWAmplitude (int index, int cwIndex, double amp)
 Sets the signal amplitude for a given CW tone generator. More...
 
virtual double getTransmitterCWPhase (int index, int cwIndex) const
 Gets the signal phase for a given CW tone generator. More...
 
virtual bool setTransmitterCWPhase (int index, int cwIndex, double phase)
 Sets the signal phase for a given CW tone generator. More...
 
virtual double getTransmitterCWSweepStartFrequency (int index, int cwIndex) const
 Gets the start frequency for a signal sweep for a given CW tone generator. More...
 
virtual double getTransmitterCWSweepStopFrequency (int index, int cwIndex) const
 Gets the stop frequency for a signal sweep for a given CW tone generator. More...
 
virtual double getTransmitterCWSweepFrequencyStep (int index, int cwIndex) const
 Gets the frequency step for a signal sweep for a given CW tone generator. More...
 
virtual double getTransmitterCWSweepDwellTime (int index, int cwIndex) const
 Gets the dwell time for a signal sweep for a given CW tone generator. More...
 
virtual bool setTransmitterCWFrequencySweep (int index, int cwIndex, double start, double stop, double step, double dwell)
 Sets the parameters for a frequency sweep for a given CW tone generator. More...
 
virtual int getNumDuc () const
 Gets the number of DUCs on the radio. More...
 
virtual BasicIntList getDucIndexRange () const
 Gets the range of DUC indices on the radio. More...
 
virtual bool ducSupportsSnapshotLoad () const
 Gets whether DUCs support loading snapshot files. More...
 
virtual bool ducSupportsSnapshotTransmit () const
 Gets whether DUCs support transmitting snapshots. More...
 
virtual bool enableDuc (int index, bool enabled)
 Enables a given DUC. More...
 
virtual bool disableDuc (int index)
 Disables a given DUC. More...
 
virtual ConfigurationDict getDucConfiguration (int index) const
 Gets the configuration dictionary for a given DUC. More...
 
virtual bool setDucConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given DUC. More...
 
virtual int getDucDataPort (int index) const
 Gets the data port for a given DUC. More...
 
virtual bool setDucDataPort (int index, int port)
 Sets the data port for a given DUC. More...
 
virtual double getDucFrequency (int index) const
 Gets the tuned frequency for a given DUC. More...
 
virtual bool setDucFrequency (int index, double freq)
 Sets the tuned frequency for a given DUC. More...
 
virtual BasicDoubleList getDucFrequencyRange () const
 Gets the tunable frequency range for DUCs. More...
 
virtual double getDucFrequencyRes () const
 Gets the tuned frequency resolution for DUCs. More...
 
virtual double getDucFrequencyUnit () const
 Gets the tuned frequency units for DUCs. More...
 
virtual double getDucAttenuation (int index) const
 Gets the attenuation for a given DUC. More...
 
virtual bool setDucAttenuation (int index, double atten)
 Sets the attenuation for a given DUC. More...
 
virtual BasicDoubleList getDucAttenuationRange () const
 Gets the DUC attenuation range. More...
 
virtual double getDucAttenuationRes () const
 Gets the DUC attenuation resolution. More...
 
virtual int getDucRateIndex (int index) const
 Gets the rate index for a given DUC. More...
 
virtual bool setDucRateIndex (int index, int rateIndex)
 Sets the rate index for a given DUC. More...
 
virtual int getDucTxChannelBitmap (int index) const
 Gets the transmit channel bitmap for a given DUC. More...
 
virtual bool setDucTxChannelBitmap (int index, int txChannels)
 Sets the transmit channel bitmap for a given DUC. More...
 
virtual int getDucMode (int index) const
 Gets the mode for a given DUC. More...
 
virtual bool setDucMode (int index, int mode)
 Sets the mode for a given DUC. More...
 
virtual unsigned int getDucStreamId (int index) const
 Gets the VITA 49 stream ID for a given DUC. More...
 
virtual bool setDucStreamId (int index, unsigned int sid)
 Sets the VITA 49 stream ID for a given DUC. More...
 
virtual bool loadDucSnapshot (int index, const std::string &filename, unsigned int startSample=0, unsigned int samples=0)
 Load a snapshot file into a given DUC's memory block. More...
 
virtual DucRateSet getDucRateSet () const
 Gets the DUC's rate set. More...
 
virtual BasicDoubleList getDucRateList () const
 Gets the list of allowed DUC sample rates, based on the rate set. More...
 
virtual int getNumWbddcGroups () const
 Gets the number of WBDDC groups on the radio. More...
 
virtual BasicIntList getWbddcGroupIndexRange () const
 Gets the range of WBDDC group indices on the radio. More...
 
virtual bool isWbddcGroupEnabled (int index) const
 Gets whether or not a given WBDDC group is enabled. More...
 
virtual bool enableWbddcGroup (int index, bool enabled)
 Enables a given WBDDC group. More...
 
virtual bool disableWbddcGroup (int index)
 Disables a given WBDDC group. More...
 
virtual ConfigurationDict getWbddcGroupConfiguration (int index) const
 Gets the configuration dictionary for a given WBDDC group. More...
 
virtual bool setWbddcGroupConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given WBDDC group. More...
 
virtual BasicIntList getWbddcGroupMembers (int index) const
 Gets the list of group members for a given WBDDC group. More...
 
virtual bool setWbddcGroupMembers (int index, const BasicIntList &groupMembers)
 Sets the list of group members for a given WBDDC group. More...
 
virtual bool addWbddcGroupMember (int index, int member)
 Adds a WBDDC to the given WBDDC group. More...
 
virtual bool removeWbddcGroupMember (int index, int member)
 Removes a WBDDC from the given WBDDC group. More...
 
virtual int getNumNbddcGroups () const
 Gets the number of NBDDC groups on the radio. More...
 
virtual BasicIntList getNbddcGroupIndexRange () const
 Gets the range of NBDDC group indices on the radio. More...
 
virtual bool isNbddcGroupEnabled (int index) const
 Gets whether or not a given NBDDC group is enabled. More...
 
virtual bool enableNbddcGroup (int index, bool enabled)
 Enables a given NBDDC group. More...
 
virtual bool disableNbddcGroup (int index)
 Disables a given NBDDC group. More...
 
virtual ConfigurationDict getNbddcGroupConfiguration (int index) const
 Gets the configuration dictionary for a given NBDDC group. More...
 
virtual bool setNbddcGroupConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given NBDDC group. More...
 
virtual BasicIntList getNbddcGroupMembers (int index) const
 Gets the list of group members for a given NBDDC group. More...
 
virtual bool setNbddcGroupMembers (int index, const BasicIntList &groupMembers)
 Sets the list of group members for a given NBDDC group. More...
 
virtual bool addNbddcGroupMember (int index, int member)
 Adds a NBDDC to the given NBDDC group. More...
 
virtual bool removeNbddcGroupMember (int index, int member)
 Removes a NBDDC from the given NBDDC group. More...
 
virtual bool disableTenGigFlowControl ()
 Disables flow control on all 10GigE data ports. More...
 
virtual bool enableTenGigFlowControl ()
 Enables flow control on all 10GigE data ports. More...
 
virtual bool setTenGigFlowControlStatus (bool enable)
 Sets flow control status on all 10GigE data ports. More...
 
virtual BasicIntBoolDict getTenGigFlowControlStatus ()
 Gets flow control status on all 10GigE data ports. More...
 
virtual ConfigurationDict getDataPortConfiguration (int index) const
 Gets the configuration dictionary for a given data port. More...
 
virtual bool setDataPortConfiguration (int index, ConfigurationDict &cfg)
 Sets the configuration dictionary for a given data port. More...
 
virtual std::string getDataPortSourceIP (int index) const
 Gets the source IP address for a given data port. More...
 
virtual bool setDataPortSourceIP (int index, const std::string &ipAddr)
 Sets the source IP address for a given data port. More...
 
virtual bool enableDataPortErrors (int index, bool enabled=true)
 Enables errors on the data port. More...
 
virtual bool disableDataPortErrors (int index)
 Disables errors on the data port. More...
 
virtual bool enableDataPortFlowControl (int index, bool enabled=true)
 Enables flow control on the data port. More...
 
virtual bool disableDataPortFlowControl (int index)
 Disables flow control on the data port. More...
 
virtual std::string getDataPortDestMACAddress (int index, int dipIndex) const
 Gets the MAC address for a given entry in the destination IP table on a given data port. More...
 
virtual bool setDataPortDestMACAddress (int index, int dipIndex, const std::string &macAddr)
 Sets the MAC address for a given entry in the destination IP table on a given data port. More...
 
virtual std::string getDataPortDestIPAddress (int index, int dipIndex) const
 Gets the IP address for a given entry in the destination IP table on a given data port. More...
 
virtual bool setDataPortDestIPAddress (int index, int dipIndex, const std::string &ipAddr)
 Sets the IP address for a given entry in the destination IP table on a given data port. More...
 
virtual unsigned int getDataPortDestSourcePort (int index, int dipIndex) const
 Gets the source UDP port number for a given entry in the destination IP table on a given data port. More...
 
virtual bool setDataPortDestSourcePort (int index, int dipIndex, unsigned int sourcePort)
 Sets the UDP port number for a given entry in the destination IP table on a given data port. More...
 
virtual unsigned int getDataPortDestDestPort (int index, int dipIndex) const
 Gets the destination UDP port number for a given entry in the destination IP table on a given data port. More...
 
virtual bool setDataPortDestDestPort (int index, int dipIndex, unsigned int destPort)
 Sets the VITA stream ID for a given entry in the destination IP table on a given data port. More...
 
virtual bool setDataPortDestInfo (int index, int dipIndex, const std::string &ipAddr, const std::string &macAddr, unsigned int sourcePort, unsigned int destPort)
 Sets the destination table information for a given entry in the DIP table on a given data port. More...
 
virtual ConfigurationDict getSimpleIPConfiguration () const
 Gets the "simple" IP configuration dictionary for radios without 10Gig data ports. More...
 
virtual bool setSimpleIPConfiguration (ConfigurationDict &cfg)
 Sets the "simple" IP configuration dictionary for radios without 10Gig data ports. More...
 
virtual std::string getSimpleSourceMACAddress () const
 Gets the source MAC address for radios without 10Gig data ports. More...
 
virtual std::string getSimpleSourceIPAddress () const
 Gets the source IP address for radios without 10Gig data ports. More...
 
virtual bool setSimpleSourceIPAddress (const std::string &ipAddr)
 Sets the source IP address for radios without 10Gig data ports. More...
 
virtual std::string getSimpleDestMACAddress () const
 Gets the destination MAC address for radios without 10Gig data ports. More...
 
virtual bool setSimpleDestMACAddress (const std::string &macAddr)
 Sets the destination MAC address for radios without 10Gig data ports. More...
 
virtual std::string getSimpleDestIPAddress () const
 Gets the destination IP address for radios without 10Gig data ports. More...
 
virtual bool setSimpleDestIPAddress (const std::string &ipAddr)
 Sets the destination IP address for radios without 10Gig data ports. More...
 
virtual int getDefaultDeviceInfo () const
 Gets the default device information. More...
 
virtual uint32_t getMessageId (void)
 Get a json Message ID.
 
virtual std::string getName () const
 Gets the name of the configurable object. More...
 
virtual void setName (const std::string &name)
 Sets the name of the configurable object. More...
 
virtual ConfigurationDict getConfiguration () const
 Gets the configuration dictionary for this object. More...
 
virtual ConfigString getConfigurationValue (const std::string &key) const
 Gets a named configuration value as a string. More...
 
virtual bool getConfigurationValueAsBool (const std::string &key) const
 Gets a named configuration value as a Boolean. More...
 
virtual int getConfigurationValueAsInt (const std::string &key) const
 Gets a named configuration value as an integer value. More...
 
virtual unsigned int getConfigurationValueAsUInt (const std::string &key) const
 Gets a named configuration value as an unsigned integer value. More...
 
virtual double getConfigurationValueAsDbl (const std::string &key) const
 Gets a named configuration value as a double value. More...
 
virtual bool setConfigurationValue (const std::string &key, const std::string &value)
 Sets a named configuration value to a string. More...
 
virtual bool setConfigurationValueToBool (const std::string &key, const bool value)
 Sets a named configuration value to a Boolean. More...
 
virtual bool setConfigurationValueToInt (const std::string &key, const int value)
 Sets a named configuration value to an integer value. More...
 
virtual bool setConfigurationValueToUInt (const std::string &key, const unsigned int value)
 Sets a named configuration value to an unsigned integer value. More...
 
virtual bool setConfigurationValueToDbl (const std::string &key, const double value)
 Sets a named configuration value to a double value. More...
 
virtual void setDebugName (const std::string &debug_name)
 Sets the debug name for this object. More...
 
virtual void setDebugFile (FILE *debug_fp)
 Sets the debug file pointer for this object. More...
 
virtual void setDebugTimeFormat (const std::string &debug_timefmt)
 Sets the debug time format for this object. More...
 
virtual int debug (const char *format,...)
 Outputs debug information. More...
 
virtual const char * debugBool (bool x)
 Gets a debug output string for a Boolean value. More...
 
virtual bool isDebug () const
 Gets whether this object produces debug output. More...
 
virtual std::string getDebugName () const
 Gets the debug name for this object. More...
 
virtual std::string rawString (const std::string &data)
 Gets a "raw" string representation of a given data string. More...
 

Protected Member Functions

virtual void initConfigurationDict ()
 Initializes the configuration dictionary, defining the allowed keys. More...
 
virtual void updateConfigurationDict ()
 Updates the configuration dictionary from object settings. More...
 
virtual ConfigurationDict normalizedConfigurationDict (const ConfigurationDict &cfg)
 Normalizes an incoming configuration dictionary. More...
 
virtual std::string normalizedBool (const std::string &val)
 Normalizes a Boolean string value. More...
 
virtual void dumpConfiguration ()
 Dumps this object's configuration dictionary to debug output.
 

Detailed Description

Radio handler class for the NDR651.

Radio

This radio has the following settings:

  • Calibration frequency: 20.0 MHz - 6.0 GHz
  • Configuration mode: 0 (off) or 1 (on)
  • Reference mode:
    • 0: Internal 10MHz
    • 1: External 10MHz
    • 2: Internal GPS Disciplined internal 10MHz
    • 3: External 1PPS
    • 4: External 1PPS pass-through
    • 5: External 10MHz and 1PPS
  • Reference bypass mode: 0 (internal) or 1 (external)
  • Frequency normalization mode: 0 (off) or 1 (on)
  • GPS enabled: 0 (off) or 1 (on)
  • Reference tuning voltage value: 0-65565

Configuration dictionary items:

  • "calibFrequency": Calibration frequency, in MHz [double/string]
  • "configMode": Configuration mode [Boolean/integer/string]
  • "referenceMode": Reference mode [integer/string]
  • "bypassMode": Reference bypass mode [integer/string]
  • "freqNormalization": Whether frequency normalization is in effect [Boolean/integer/string]
  • "gpsEnable": Whether GPS is enabled [Boolean/integer/string]
  • "referenceTuningVoltage": Reference tuning voltage value [integer/string]

Tuners

The NDR651 has two tuners, indexed 1-2.

  • Frequency range: 20.0 MHz - 6.0 GHz
  • Attenuation range: 0.0 dB - 46.0 dB
  • Filter settings: 0 (LC), 1 (SAW)

Configuration dictionary elements:

  • "enable": Whether or not this tuner is enabled [Boolean/integer/string]
  • "frequency": Tuned frequency (Hz) [double/string]
  • "attenuation": Attenuation (dB) [double/string]
  • "filter": Filter setting [integer/string]

WBDDCs

The NDR651 has two WBDDCs, indexed 1-2. Each WBDDC corresponds to the tuner with the same index.

Configuration dictionary elements:

  • "enable": Whether or not this DDC is enabled [Boolean/integer/string]
  • "rateIndex": Rate index [integer/string]
  • "udpDestination": UDP destination [integer/string]
  • "vitaEnable": VITA 49 framing setting [integer/string]
  • "streamId": VITA 49 streamId [integer/string]
  • "dataPort": Data port index [integer/string]

Rate indices:

Rate IndexWBDDC Rate (samples per second)Sample Type
051200000.0Complex
125600000.0Complex
212800000.0Complex
3102400000.0Real
46400000.0Complex
53200000.0Complex

WBDDC Groups

The NDR651 has four WBDDC groups, indexed 1-4.

Configuration dictionary elements:

  • "enable": Whether or not this DDC group is enabled [Boolean/integer/string]
  • "members": Comma-separated list of WBDDCs in this group [string]

NBDDCs

The NDR651 has 16 NBDDCs, indexed 1-16.

Configuration dictionary elements:

  • "enable": Whether or not this DDC is enabled [Boolean/integer/string]
  • "rateIndex": Rate index [integer/string]
  • "udpDestination": UDP destination [integer/string]
  • "vitaEnable": VITA 49 framing setting [integer/string]
  • "streamId": VITA 49 streamId [integer/string]
  • "frequency": Tuned frequency (Hz) [double/string]
  • "source": Source tuner index [integer/string]
  • "dataPort": Data port index [integer/string]

Rate indices:

Rate IndexNBDDC Rate (samples per second)Sample Type
01600000.0Complex
1800000.0Complex
2400000.0Complex
3200000.0Complex
4100000.0Complex
550000.0Complex
625000.0Complex
712500.0Complex

NBDDC Groups

The NDR651 has eight NBDDC groups, indexed 1-8.

Configuration dictionary elements:

  • "enable": Whether or not this DDC group is enabled [Boolean/integer/string]
  • "members": Comma-separated list of NBDDCs in this group [string]

Transmitters

The NDR651 has two transmitters, indexed 1-2.

Configuration dictionary elements:

  • "enable": Whether or not this transmitter is enabled [Boolean/integer/string]
  • "frequency": Tuned frequency (Hz) [double]
  • "attenuation": Attenuation (dB) [double]

DUCs

The NDR651 has eight DUCs, indexed 1-8.

Configuration dictionary elements:

  • "enable": Whether or not this DUC is enabled [Boolean/integer/string]
  • "dataPort": Data port index [integer/string]
  • "frequency": Tuned frequency (Hz) [double/string]
  • "attenuation": Attenuation (dB) [double/string]
  • "rateIndex": Rate index [integer/string]
  • "txChannels": Transmit channel bitmap [integer/string]
  • "mode": DUC mode [integer/string]
  • "streamId": VITA stream ID [integer/string]
  • "filename": Snapshot file name [string]
  • "startSample": Start sample number [integer/string]
  • "samples": Number of samples [integer/string]
  • "singlePlayback": Whether or not to do a single playback [Boolean/integer/string]
  • "pauseUntilEnabled": Whether or not to pause snapshot until enabled [Boolean/integer/string]
Rate IndexWBDUC Rate (samples per second)Sample Type
0102400000.0Complex
151200000.0Complex
225600000.0Complex
312800000.0Complex
46400000.0Complex
53200000.0Complex
61600000.0Complex
7800000.0Complex
8400000.0Complex
9200000.0Complex
10100000.0Complex
1150000.0Complex
1225000.0Complex
1312500.0Complex
16270833.0Complex
205600000.0Complex

Data Ports

The NDR651 has two 10GigE data ports, indexed 1-2.

Configuration dictionary items:

  • "sourceIP": Source IP address [string]
  • "errors": Whether errors are enabled [Boolean/integer/string]
  • "flowControl": Whether flow control is enabled [Boolean/integer/string]

Each data port has 32 destination table entries, indexed 0-31.

VITA 49 Enabling Options for DDCs

VITA Enable OptionMeaning
0VITA-49 header disabled
1VITA-49 header enabled, fractional timestamp in picoseconds
2VITA-49 header disabled
3VITA-49 header enabled, fractional timestamp in sample counts

Definition at line 218 of file RadioHandler.h.

Member Function Documentation

◆ addNbddcGroupMember()

bool addNbddcGroupMember ( int  index,
int  member 
)
virtualinherited

Adds a NBDDC to the given NBDDC group.

Parameters
indexThe NBDDC group index number.
memberNBDDC to add.
Returns
True if successful, false otherwise.

Definition at line 2272 of file RadioHandler.cpp.

◆ addWbddcGroupMember()

bool addWbddcGroupMember ( int  index,
int  member 
)
virtualinherited

Adds a WBDDC to the given WBDDC group.

Parameters
indexThe WBDDC group index number.
memberWBDDC to add.
Returns
True if successful, false otherwise.

Definition at line 2182 of file RadioHandler.cpp.

◆ connect()

bool connect ( const std::string &  mode,
const std::string &  host_or_dev,
const int  port_or_baudrate 
)
virtualinherited

Connects to the radio.

Parameters
modeConnection mode. One of "tcp", "udp", or "tty".
host_or_devEither the host name or IP address (TCP/UDP) or the serial device name (TTY).
port_or_baudrateEither the port number (TCP/UDP) or the serial baud rate (TTY).
Returns
True if successful, false otherwise.

Definition at line 260 of file RadioHandler.cpp.

◆ debug()

int debug ( const char *  format,
  ... 
)
virtualinherited

Outputs debug information.

This method follows the same semantics as printf(). Output is preceded by a timestamp and the name of the object, if provided.

Parameters
formatThe printf()-style format string.
...Comma-separated list of arguments to print. Note that these need to be arguments that can be supported natively through printf().
Returns
The number of characters outputted.

Definition at line 95 of file Debuggable.cpp.

◆ debugBool()

const char * debugBool ( bool  x)
virtualinherited

Gets a debug output string for a Boolean value.

Parameters
xBoolean value
Returns
A constant string, either "true" or "false".

Definition at line 126 of file Debuggable.cpp.

◆ disableDataPortErrors()

bool disableDataPortErrors ( int  index)
virtualinherited

Disables errors on the data port.

Parameters
indexData port index number.
Returns
True if successful, false otherwise.

Definition at line 2368 of file RadioHandler.cpp.

◆ disableDataPortFlowControl()

bool disableDataPortFlowControl ( int  index)
virtualinherited

Disables flow control on the data port.

Parameters
indexData port index number.
Returns
True if successful, false otherwise.

Definition at line 2382 of file RadioHandler.cpp.

◆ disableDuc()

bool disableDuc ( int  index)
virtualinherited

Disables a given DUC.

Parameters
indexThe DUC index number.
Returns
True if successful, false otherwise.

Definition at line 1885 of file RadioHandler.cpp.

◆ disableNbddc()

bool disableNbddc ( int  index)
virtualinherited

Disables a given NBDDC.

Parameters
indexNBDDC index number.
Returns
True if successful, false otherwise.

Definition at line 1246 of file RadioHandler.cpp.

◆ disableNbddcGroup()

bool disableNbddcGroup ( int  index)
virtualinherited

Disables a given NBDDC group.

Parameters
indexThe NBDDC group index number.
Returns
True if successful, false otherwise.

Definition at line 2231 of file RadioHandler.cpp.

◆ disableTenGigFlowControl()

bool disableTenGigFlowControl ( )
virtualinherited

Disables flow control on all 10GigE data ports.

Returns
True if successful, false otherwise.

Definition at line 2290 of file RadioHandler.cpp.

◆ disableTransmitter()

bool disableTransmitter ( int  index)
virtualinherited

Disables a given transmitter.

Parameters
indexTransmitter index.
Returns
True if successful, false otherwise.

Definition at line 1481 of file RadioHandler.cpp.

◆ disableTransmitterCW()

bool disableTransmitterCW ( int  index,
int  cwIndex 
)
virtualinherited

Disables a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
True if successful, false otherwise.

Definition at line 1711 of file RadioHandler.cpp.

◆ disableTuner()

bool disableTuner ( int  index)
virtualinherited

Disables a given tuner.

Parameters
indexThe tuner index number.
Returns
True if successful, false otherwise.

Definition at line 841 of file RadioHandler.cpp.

◆ disableWbddc()

bool disableWbddc ( int  index)
virtualinherited

Disables a given WBDDC.

Parameters
indexWBDDC index number.
Returns
True if successful, false otherwise.

Definition at line 1012 of file RadioHandler.cpp.

◆ disableWbddcGroup()

bool disableWbddcGroup ( int  index)
virtualinherited

Disables a given WBDDC group.

Parameters
indexThe WBDDC group index number.
Returns
True if successful, false otherwise.

Definition at line 2141 of file RadioHandler.cpp.

◆ ducSupportsSnapshotLoad()

bool ducSupportsSnapshotLoad ( ) const
virtualinherited

Gets whether DUCs support loading snapshot files.

Returns
True if supported, false otherwise.

Definition at line 1858 of file RadioHandler.cpp.

◆ ducSupportsSnapshotTransmit()

bool ducSupportsSnapshotTransmit ( ) const
virtualinherited

Gets whether DUCs support transmitting snapshots.

Returns
True if supported, false otherwise.

Definition at line 1867 of file RadioHandler.cpp.

◆ enableDataPortErrors()

bool enableDataPortErrors ( int  index,
bool  enabled = true 
)
virtualinherited

Enables errors on the data port.

Parameters
indexData port index number.
enabledWhether or not errors should be enabled.
Returns
True if successful, false otherwise.

Definition at line 2359 of file RadioHandler.cpp.

◆ enableDataPortFlowControl()

bool enableDataPortFlowControl ( int  index,
bool  enabled = true 
)
virtualinherited

Enables flow control on the data port.

Parameters
indexData port index number.
enabledWhether or not errors should be enabled.
Returns
True if successful, false otherwise.

Definition at line 2373 of file RadioHandler.cpp.

◆ enableDuc()

bool enableDuc ( int  index,
bool  enabled 
)
virtualinherited

Enables a given DUC.

Parameters
indexThe DUC index number.
enabledWhether or not the DUC should be enabled.
Returns
True if successful, false otherwise.

Definition at line 1876 of file RadioHandler.cpp.

◆ enableNbddc()

bool enableNbddc ( int  index,
bool  enabled = true 
)
virtualinherited

Enables a given NBDDC.

Parameters
indexNBDDC index number.
enabledWhether or not this component should be enabled.
Returns
True if successful, false otherwise.

Definition at line 1237 of file RadioHandler.cpp.

◆ enableNbddcGroup()

bool enableNbddcGroup ( int  index,
bool  enabled 
)
virtualinherited

Enables a given NBDDC group.

Parameters
indexThe NBDDC group index number.
enabledWhether or not the NBDDC group should be enabled.
Returns
True if successful, false otherwise.

Definition at line 2222 of file RadioHandler.cpp.

◆ enableTenGigFlowControl()

bool enableTenGigFlowControl ( )
virtualinherited

Enables flow control on all 10GigE data ports.

Returns
True if successful, false otherwise.

Definition at line 2295 of file RadioHandler.cpp.

◆ enableTransmitter()

bool enableTransmitter ( int  index,
bool  enabled = true 
)
virtualinherited

Enables a given transmitter.

Parameters
indexTransmitter index.
enabledWhether or not to enable the transmitter.
Returns
True if successful, false otherwise.

Definition at line 1472 of file RadioHandler.cpp.

◆ enableTransmitterCW()

bool enableTransmitterCW ( int  index,
int  cwIndex,
bool  enabled = true 
)
virtualinherited

Enables a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
enabledWhether or not this component should be enabled.
Returns
True if successful, false otherwise.

Definition at line 1702 of file RadioHandler.cpp.

◆ enableTuner()

bool enableTuner ( int  index,
bool  enabled = true 
)
virtualinherited

Enables a given tuner.

Parameters
indexThe tuner index number.
enabledWhether or not this tuner should be enabled.
Returns
True if successful, false otherwise.

Definition at line 832 of file RadioHandler.cpp.

◆ enableWbddc()

bool enableWbddc ( int  index,
bool  enabled = true 
)
virtualinherited

Enables a given WBDDC.

Parameters
indexWBDDC index number.
enabledWhether or not this component should be enabled.
Returns
True if successful, false otherwise.

Definition at line 1003 of file RadioHandler.cpp.

◆ enableWbddcGroup()

bool enableWbddcGroup ( int  index,
bool  enabled 
)
virtualinherited

Enables a given WBDDC group.

Parameters
indexThe WBDDC group index number.
enabledWhether or not the WBDDC group should be enabled.
Returns
True if successful, false otherwise.

Definition at line 2132 of file RadioHandler.cpp.

◆ getAdcRate()

double getAdcRate ( ) const
virtualinherited

Gets the ADC sample rate.

Returns
The sample rate, in Hz.

Definition at line 720 of file RadioHandler.cpp.

◆ getByteOrder()

const char * getByteOrder ( ) const
virtualinherited

Gets the byte order (endianness) of the VITA 49.

Returns
The byte order, either "little" or "big".

Definition at line 755 of file RadioHandler.cpp.

◆ getCalibrationFrequency()

double getCalibrationFrequency ( ) const
virtualinherited

Gets the calibration frequency.

Returns
The calibration frequency, in MHz. A value of 0 means that the calibration function is not on.

Definition at line 662 of file RadioHandler.cpp.

◆ getConfiguration()

ConfigurationDict getConfiguration ( ) const
virtualinherited

Gets the configuration dictionary for this object.

Returns
The configuration dictionary.

Definition at line 93 of file Configurable.cpp.

◆ getConfigurationValue()

ConfigString getConfigurationValue ( const std::string &  key) const
virtualinherited

Gets a named configuration value as a string.

Parameters
keyThe key string in the configuration dictionary.
Returns
The value represented by this key. Returns an empty string if the key is not in the configuration dictionary.

Definition at line 98 of file Configurable.cpp.

◆ getConfigurationValueAsBool()

bool getConfigurationValueAsBool ( const std::string &  key) const
virtualinherited

Gets a named configuration value as a Boolean.

Parameters
keyThe key string in the configuration dictionary.
Returns
The Boolean value represented by this key. Returns false if the key is not in the configuration dictionary, or cannot be represented as a Boolean.

Definition at line 109 of file Configurable.cpp.

◆ getConfigurationValueAsDbl()

double getConfigurationValueAsDbl ( const std::string &  key) const
virtualinherited

Gets a named configuration value as a double value.

Parameters
keyThe key string in the configuration dictionary.
Returns
The double value represented by this key. Returns 0.0 if the key is not in the configuration dictionary, or if the value cannot be represented as a double.

Definition at line 148 of file Configurable.cpp.

◆ getConfigurationValueAsInt()

int getConfigurationValueAsInt ( const std::string &  key) const
virtualinherited

Gets a named configuration value as an integer value.

Parameters
keyThe key string in the configuration dictionary.
Returns
The integer value represented by this key. Returns 0 if the key is not in the configuration dictionary, or if the value cannot be represented as an integer.

Definition at line 122 of file Configurable.cpp.

◆ getConfigurationValueAsUInt()

unsigned int getConfigurationValueAsUInt ( const std::string &  key) const
virtualinherited

Gets a named configuration value as an unsigned integer value.

Parameters
keyThe key string in the configuration dictionary.
Returns
The integer value represented by this key. Returns 0 if the key is not in the configuration dictionary, or if the value cannot be represented as an integer.

Definition at line 135 of file Configurable.cpp.

◆ getConnectionInfo()

BasicStringStringDict getConnectionInfo ( )
virtualinherited

Gets connection information for the radio.

Returns
The connection info dictionary.

Definition at line 255 of file RadioHandler.cpp.

◆ getConnectionModeList()

BasicStringList getConnectionModeList ( ) const
virtualinherited

Gets the list of connection methods that the radio supports.

Returns
The mode list.

Definition at line 705 of file RadioHandler.cpp.

◆ getDataPortConfiguration()

ConfigurationDict getDataPortConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given data port.

Parameters
indexData port index number.
Returns
The configuration dictionary.

Definition at line 2323 of file RadioHandler.cpp.

◆ getDataPortDestDestPort()

unsigned int getDataPortDestDestPort ( int  index,
int  dipIndex 
) const
virtualinherited

Gets the destination UDP port number for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
Returns
The stream ID.

Definition at line 2444 of file RadioHandler.cpp.

◆ getDataPortDestIPAddress()

std::string getDataPortDestIPAddress ( int  index,
int  dipIndex 
) const
virtualinherited

Gets the IP address for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
Returns
The IP address.

Definition at line 2406 of file RadioHandler.cpp.

◆ getDataPortDestMACAddress()

std::string getDataPortDestMACAddress ( int  index,
int  dipIndex 
) const
virtualinherited

Gets the MAC address for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
Returns
The MAC address.

Definition at line 2387 of file RadioHandler.cpp.

◆ getDataPortDestSourcePort()

unsigned int getDataPortDestSourcePort ( int  index,
int  dipIndex 
) const
virtualinherited

Gets the source UDP port number for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
Returns
The port number.

Definition at line 2425 of file RadioHandler.cpp.

◆ getDataPortDipEntryIndexRange()

BasicIntList getDataPortDipEntryIndexRange ( ) const
virtualinherited

Gets the list of UDP destination table indices for the 10GigE data ports on the radio.

Returns
The list of destination indices.

Definition at line 696 of file RadioHandler.cpp.

◆ getDataPortIndexRange()

BasicIntList getDataPortIndexRange ( ) const
virtualinherited

Gets the range of indices 10GigE data ports on the radio.

Returns
The list of 10GigE indices.

Definition at line 679 of file RadioHandler.cpp.

◆ getDataPortSourceIP()

std::string getDataPortSourceIP ( int  index) const
virtualinherited

Gets the source IP address for a given data port.

Parameters
indexData port index number.
Returns
The source IP address.

Definition at line 2341 of file RadioHandler.cpp.

◆ getDebugName()

std::string getDebugName ( ) const
virtualinherited

Gets the debug name for this object.

Returns
The debug name, as a string.

Definition at line 138 of file Debuggable.cpp.

◆ getDefaultDeviceInfo()

int getDefaultDeviceInfo ( ) const
virtualinherited

Gets the default device information.

The default device information is either a default port to use for network connections, or a default baud rate to use for serial connections.

Returns
Default device info [integer]

Definition at line 2540 of file RadioHandler.cpp.

◆ getDucAttenuation()

double getDucAttenuation ( int  index) const
virtualinherited

Gets the attenuation for a given DUC.

Parameters
indexThe DUC index number.
Returns
The attenuation, in dB.

Definition at line 1971 of file RadioHandler.cpp.

◆ getDucAttenuationRange()

BasicDoubleList getDucAttenuationRange ( ) const
virtualinherited

Gets the DUC attenuation range.

Returns
A list containing the minimum and maximum attenuation values.

Definition at line 1989 of file RadioHandler.cpp.

◆ getDucAttenuationRes()

double getDucAttenuationRes ( ) const
virtualinherited

Gets the DUC attenuation resolution.

Returns
The resolution.

Definition at line 1998 of file RadioHandler.cpp.

◆ getDucConfiguration()

ConfigurationDict getDucConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given DUC.

Parameters
indexDUC index number.
Returns
The configuration dictionary.

Definition at line 1890 of file RadioHandler.cpp.

◆ getDucDataPort()

int getDucDataPort ( int  index) const
virtualinherited

Gets the data port for a given DUC.

Parameters
indexThe DUC index number.
Returns
The data port.

Definition at line 1908 of file RadioHandler.cpp.

◆ getDucFrequency()

double getDucFrequency ( int  index) const
virtualinherited

Gets the tuned frequency for a given DUC.

Parameters
indexThe DUC index number.
Returns
The tuned frequency, in Hz.

Definition at line 1926 of file RadioHandler.cpp.

◆ getDucFrequencyRange()

BasicDoubleList getDucFrequencyRange ( ) const
virtualinherited

Gets the tunable frequency range for DUCs.

Returns
A list containing the minimum and maximum frequencies.

Definition at line 1944 of file RadioHandler.cpp.

◆ getDucFrequencyRes()

double getDucFrequencyRes ( ) const
virtualinherited

Gets the tuned frequency resolution for DUCs.

Returns
The frequency resolution, in Hz.

Definition at line 1953 of file RadioHandler.cpp.

◆ getDucFrequencyUnit()

double getDucFrequencyUnit ( ) const
virtualinherited

Gets the tuned frequency units for DUCs.

Returns
The frequency units, in Hz.

Definition at line 1962 of file RadioHandler.cpp.

◆ getDucIndexRange()

BasicIntList getDucIndexRange ( ) const
virtualinherited

Gets the range of DUC indices on the radio.

Returns
A list of DUC indices.

Definition at line 1850 of file RadioHandler.cpp.

◆ getDucMode()

int getDucMode ( int  index) const
virtualinherited

Gets the mode for a given DUC.

Parameters
indexThe DUC index number.
Returns
The mode. This is either 0 (streaming) or 1 (playback).

Definition at line 2043 of file RadioHandler.cpp.

◆ getDucRateIndex()

int getDucRateIndex ( int  index) const
virtualinherited

Gets the rate index for a given DUC.

Parameters
indexThe DUC index number.
Returns
The rate index.

Definition at line 2007 of file RadioHandler.cpp.

◆ getDucRateList()

BasicDoubleList getDucRateList ( ) const
virtualinherited

Gets the list of allowed DUC sample rates, based on the rate set.

Returns
The rate list.

Definition at line 2101 of file RadioHandler.cpp.

◆ getDucRateSet()

DucRateSet getDucRateSet ( ) const
virtualinherited

Gets the DUC's rate set.

Returns
The rate set.

Definition at line 2092 of file RadioHandler.cpp.

◆ getDucStreamId()

unsigned int getDucStreamId ( int  index) const
virtualinherited

Gets the VITA 49 stream ID for a given DUC.

Parameters
indexThe DUC index number.
Returns
The VITA 49 stream ID.

Definition at line 2061 of file RadioHandler.cpp.

◆ getDucTxChannelBitmap()

int getDucTxChannelBitmap ( int  index) const
virtualinherited

Gets the transmit channel bitmap for a given DUC.

Parameters
indexThe DUC index number.
Returns
Bitmap indicating which transmitters are outputting the signal from this DUC. If a bit position is 1, the associated transmitter is active. The LSB corresponds to TX 1, and each succeeding bit corresponds to the other transmitters.

Definition at line 2025 of file RadioHandler.cpp.

◆ getGpioOutput()

int getGpioOutput ( )
virtualinherited

Gets the current GPIO output bits.

Returns
The GPIO output bits, as an integer bitmask. If the GPIO module is running in sequence mode, then this value is undefined.

Definition at line 614 of file RadioHandler.cpp.

◆ getGpioOutputByIndex()

BasicIntList getGpioOutputByIndex ( int  index)
virtualinherited

Gets the GPIO output settings for a given sequence index.

Parameters
indexThe GPIO sequence index.
Returns
A list of three integers: (bitmask, duration, loop).

Definition at line 625 of file RadioHandler.cpp.

◆ getGpsPosition()

BasicDoubleList getGpsPosition ( )
virtualinherited

Gets the current GPS position the radio.

Returns
A 2-element list of floating-point values: [latitude, longitude]. Both values are in decimal degrees. If the GPS position is unavailable, this method returns zeros.

Definition at line 585 of file RadioHandler.cpp.

◆ getLastCommandErrorInfo()

std::string getLastCommandErrorInfo ( ) const
virtualinherited

Gets the error message from the last command attempted.

Returns
The error message. This is an empty string if the last command executed successfully.

Definition at line 463 of file RadioHandler.cpp.

◆ getName()

std::string getName ( ) const
virtualinherited

Gets the name of the configurable object.

Returns
The name, as a string.

Definition at line 83 of file Configurable.cpp.

◆ getNbddcConfiguration()

ConfigurationDict getNbddcConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The configuration dictionary.

Definition at line 1251 of file RadioHandler.cpp.

◆ getNbddcDataPort()

int getNbddcDataPort ( int  index) const
virtualinherited

Gets the data port for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The data port. This number has no meaning if the radio does not use data ports.

Definition at line 1377 of file RadioHandler.cpp.

◆ getNbddcFrequency()

double getNbddcFrequency ( int  index) const
virtualinherited

Gets the tuned frequency for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The tuned frequency, in Hz. This value has no meaning if the NBDDC is not tunable.

Definition at line 1269 of file RadioHandler.cpp.

◆ getNbddcFrequencyRange()

BasicDoubleList getNbddcFrequencyRange ( ) const
virtualinherited

Gets the tunable frequency range for NBDDCs.

Returns
A list containing the minimum and maximum frequencies. These numbers have no meaning if the NBDDCs are not tunable.

Definition at line 1183 of file RadioHandler.cpp.

◆ getNbddcFrequencyRes()

double getNbddcFrequencyRes ( ) const
virtualinherited

Gets the tuned frequency resolution for NBDDCs.

Returns
The frequency resolution, in Hz. This value has no meaning if the NBDDCs are not tunable.

Definition at line 1192 of file RadioHandler.cpp.

◆ getNbddcFrequencyUnit()

double getNbddcFrequencyUnit ( ) const
virtualinherited

Gets the tuned frequency units for NBDDCs.

The frequency unit is a floating-point value that indicates how the frequency is specified in commands given to the radio.

  • 1.0: Frequency given in Hz
  • 1.0e6: Frequency given in MHz
Returns
The frequency unit.

Definition at line 1201 of file RadioHandler.cpp.

◆ getNbddcGroupConfiguration()

ConfigurationDict getNbddcGroupConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given NBDDC group.

Parameters
indexNBDDC group index number.
Returns
The configuration dictionary.

Definition at line 2236 of file RadioHandler.cpp.

◆ getNbddcGroupIndexRange()

BasicIntList getNbddcGroupIndexRange ( ) const
virtualinherited

Gets the range of NBDDC group indices on the radio.

Returns
A list of NBDDC group indices.

Definition at line 2205 of file RadioHandler.cpp.

◆ getNbddcGroupMembers()

BasicIntList getNbddcGroupMembers ( int  index) const
virtualinherited

Gets the list of group members for a given NBDDC group.

Parameters
indexThe NBDDC group index number.
Returns
List of NBDDC group members.

Definition at line 2254 of file RadioHandler.cpp.

◆ getNbddcIndexRange()

BasicIntList getNbddcIndexRange ( ) const
virtualinherited

Gets the range of NBDDC indices on the radio.

Returns
A list of NBDDC indices.

Definition at line 1175 of file RadioHandler.cpp.

◆ getNbddcRateIndex()

int getNbddcRateIndex ( int  index) const
virtualinherited

Gets the rate index for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The rate index.

Definition at line 1305 of file RadioHandler.cpp.

◆ getNbddcRateList()

BasicDoubleList getNbddcRateList ( ) const
virtualinherited

Gets the list of allowed NBDDC sample rates, based on the rate set.

Returns
The rate list.

Definition at line 1219 of file RadioHandler.cpp.

◆ getNbddcRateSet()

NbddcRateSet getNbddcRateSet ( ) const
virtualinherited

Gets the NBDDC rate set.

Returns
The rate set.

Definition at line 1210 of file RadioHandler.cpp.

◆ getNbddcSource()

int getNbddcSource ( int  index) const
virtualinherited

Gets the source (which tuner is supplying the signal) for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The source index. This value has no meaning if the NBDDC does not support selectable source.

Definition at line 1287 of file RadioHandler.cpp.

◆ getNbddcStreamId()

unsigned int getNbddcStreamId ( int  index) const
virtualinherited

Gets the VITA 49 stream ID for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The VITA 49 stream ID.

Definition at line 1359 of file RadioHandler.cpp.

◆ getNbddcUdpDestination()

int getNbddcUdpDestination ( int  index) const
virtualinherited

Gets the UDP destination for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The UDP destination.

Definition at line 1323 of file RadioHandler.cpp.

◆ getNbddcVitaEnable()

int getNbddcVitaEnable ( int  index) const
virtualinherited

Gets the VITA 49 setting for a given NBDDC.

Parameters
indexNBDDC index number.
Returns
The VITA 49 setting.

Definition at line 1341 of file RadioHandler.cpp.

◆ getNumDataPortDipEntries()

int getNumDataPortDipEntries ( ) const
virtualinherited

Gets the number of UDP destination table entries for the 10GigE data ports on the radio.

Returns
The number of entries. Returns 0 if the radio does not have 10GigE data ports.

Definition at line 687 of file RadioHandler.cpp.

◆ getNumDataPorts()

int getNumDataPorts ( ) const
virtualinherited

Gets the number of 10GigE data ports on the radio.

Returns
The number of data ports.

Definition at line 609 of file RadioHandler.cpp.

◆ getNumDuc()

int getNumDuc ( ) const
virtualinherited

Gets the number of DUCs on the radio.

Returns
The number of DUCs.

Definition at line 1845 of file RadioHandler.cpp.

◆ getNumNbddc()

int getNumNbddc ( ) const
virtualinherited

Gets the number of NBDDCs on the radio.

Returns
The number of NBDDCs.

Definition at line 1170 of file RadioHandler.cpp.

◆ getNumNbddcGroups()

int getNumNbddcGroups ( ) const
virtualinherited

Gets the number of NBDDC groups on the radio.

Returns
The number of NBDDC groups.

Definition at line 2200 of file RadioHandler.cpp.

◆ getNumTransmitters()

int getNumTransmitters ( ) const
virtualinherited

Gets the number of transmitters on the radio.

Returns
The number of transmitters.

Definition at line 1404 of file RadioHandler.cpp.

◆ getNumTuner()

int getNumTuner ( ) const
virtualinherited

Gets the number of tuners on the radio.

Returns
The number of tuners.

Definition at line 760 of file RadioHandler.cpp.

◆ getNumTunerBoards()

int getNumTunerBoards ( ) const
virtualinherited

Gets the number of tuner boards on the radio.

Returns
The number of tuners.

Definition at line 765 of file RadioHandler.cpp.

◆ getNumWbddc()

int getNumWbddc ( ) const
virtualinherited

Gets the number of WBDDCs on the radio.

Returns
The number of WBDDCs.

Definition at line 918 of file RadioHandler.cpp.

◆ getNumWbddcGroups()

int getNumWbddcGroups ( ) const
virtualinherited

Gets the number of WBDDC groups on the radio.

Returns
The number of WBDDC groups.

Definition at line 2110 of file RadioHandler.cpp.

◆ getPps()

bool getPps ( )
virtualinherited

Gets the pulse-per-second (PPS) rising edge from the radio.

Note
This method does not return until the PPS edge occurs.
Returns
True if successful, false otherwise.

Definition at line 473 of file RadioHandler.cpp.

◆ getSimpleDestIPAddress()

std::string getSimpleDestIPAddress ( ) const
virtualinherited

Gets the destination IP address for radios without 10Gig data ports.

Returns
The destination IP address [string]

Definition at line 2528 of file RadioHandler.cpp.

◆ getSimpleDestMACAddress()

std::string getSimpleDestMACAddress ( ) const
virtualinherited

Gets the destination MAC address for radios without 10Gig data ports.

Returns
The destination MAC address [string]

Definition at line 2516 of file RadioHandler.cpp.

◆ getSimpleIPConfiguration()

ConfigurationDict getSimpleIPConfiguration ( ) const
virtualinherited

Gets the "simple" IP configuration dictionary for radios without 10Gig data ports.

Returns
The configuration dictionary.

Definition at line 2478 of file RadioHandler.cpp.

◆ getSimpleSourceIPAddress()

std::string getSimpleSourceIPAddress ( ) const
virtualinherited

Gets the source IP address for radios without 10Gig data ports.

Returns
The source IP address [string]

Definition at line 2504 of file RadioHandler.cpp.

◆ getSimpleSourceMACAddress()

std::string getSimpleSourceMACAddress ( ) const
virtualinherited

Gets the source MAC address for radios without 10Gig data ports.

Returns
The source MAC address [string]

Definition at line 2498 of file RadioHandler.cpp.

◆ getStatus()

unsigned int getStatus ( )
virtualinherited

Gets the status from the radio.

Returns
The status bitmask provided by the radio, as an integer value. This command returns 0 if the radio does not support status queries.

Definition at line 540 of file RadioHandler.cpp.

◆ getTemperature()

int getTemperature ( )
virtualinherited

Gets the current radio temperature.

Returns
The temperature, in degrees Celsius. If the radio does not support temperature querying, this method returns 0.

Definition at line 598 of file RadioHandler.cpp.

◆ getTenGigFlowControlStatus()

BasicIntBoolDict getTenGigFlowControlStatus ( )
virtualinherited

Gets flow control status on all 10GigE data ports.

Returns
A dictionary of flow control statuses (Booleans) keyed by data port indices (integers).

Definition at line 2311 of file RadioHandler.cpp.

◆ getTimeNextPps()

time_t getTimeNextPps ( )
virtualinherited

Gets the time for the next PPS rising edge on the radio.

Returns
The time, in seconds since the Epoch.

Definition at line 529 of file RadioHandler.cpp.

◆ getTimeNow()

time_t getTimeNow ( )
virtualinherited

Gets the current radio time.

Returns
The time, in seconds since the Epoch.

Definition at line 515 of file RadioHandler.cpp.

◆ getTransmitterAttenuation()

double getTransmitterAttenuation ( int  index) const
virtualinherited

Gets the attenuation for a given transmitter.

Parameters
indexTransmitter index.
Returns
The attenuation (dB).

Definition at line 1504 of file RadioHandler.cpp.

◆ getTransmitterAttenuationRange()

BasicDoubleList getTransmitterAttenuationRange ( ) const
virtualinherited

Gets the attenuation range for the transmitters on the radio.

Returns
A list containing the minimum and maximum attenuation values.

Definition at line 1445 of file RadioHandler.cpp.

◆ getTransmitterAttenuationRes()

double getTransmitterAttenuationRes ( ) const
virtualinherited

Gets the attenuation resolution for transmitters on the radio.

Returns
The attenuation resolution.

Definition at line 1454 of file RadioHandler.cpp.

◆ getTransmitterConfiguration()

ConfigurationDict getTransmitterConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given transmitter.

Parameters
indexTransmitter index number.
Returns
The configuration dictionary.

Definition at line 1522 of file RadioHandler.cpp.

◆ getTransmitterCWAmplitude()

double getTransmitterCWAmplitude ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the signal amplitude for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The signal amplitude, in scale units.

Definition at line 1754 of file RadioHandler.cpp.

◆ getTransmitterCWAmplitudeRange()

BasicDoubleList getTransmitterCWAmplitudeRange ( ) const
virtualinherited

Gets the CW amplitude range.

Returns
A list containing the minimum and maximum amplitude values.

Definition at line 1585 of file RadioHandler.cpp.

◆ getTransmitterCWAmplitudeRes()

double getTransmitterCWAmplitudeRes ( ) const
virtualinherited

Gets the CW amplitude resolution.

Returns
The resolution.

Definition at line 1594 of file RadioHandler.cpp.

◆ getTransmitterCWConfiguration()

ConfigurationDict getTransmitterCWConfiguration ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the configuration for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The configuration dictionary.

Definition at line 1716 of file RadioHandler.cpp.

◆ getTransmitterCWFrequency()

double getTransmitterCWFrequency ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the constant frequency for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The constant frequency, in Hz.

Definition at line 1736 of file RadioHandler.cpp.

◆ getTransmitterCWFrequencyRange()

BasicDoubleList getTransmitterCWFrequencyRange ( ) const
virtualinherited

Gets the CW frequency range.

Returns
A list containing the minimum and maximum frequencies.

Definition at line 1567 of file RadioHandler.cpp.

◆ getTransmitterCWFrequencyRes()

double getTransmitterCWFrequencyRes ( ) const
virtualinherited

Gets the CW frequency resolution.

Returns
The frequency resolution, in Hz.

Definition at line 1576 of file RadioHandler.cpp.

◆ getTransmitterCWIndexRange()

BasicIntList getTransmitterCWIndexRange ( ) const
virtualinherited

Gets the range of indices for CW tone generators.

Returns
A list containing the generator indices.

Definition at line 1558 of file RadioHandler.cpp.

◆ getTransmitterCWNum()

int getTransmitterCWNum ( ) const
virtualinherited

Gets the number of CW tone generators associated with transmitters on this radio.

Returns
The number of generators.

Definition at line 1549 of file RadioHandler.cpp.

◆ getTransmitterCWPhase()

double getTransmitterCWPhase ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the signal phase for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The signal phase, in degrees.

Definition at line 1772 of file RadioHandler.cpp.

◆ getTransmitterCWPhaseRange()

BasicDoubleList getTransmitterCWPhaseRange ( ) const
virtualinherited

Gets the CW phase range.

Returns
A list containing the minimum and maximum phase values.

Definition at line 1603 of file RadioHandler.cpp.

◆ getTransmitterCWPhaseRes()

int getTransmitterCWPhaseRes ( ) const
virtualinherited

Gets the CW phase resolution.

Returns
The resolution.

Definition at line 1612 of file RadioHandler.cpp.

◆ getTransmitterCWSweepDwellRange()

BasicDoubleList getTransmitterCWSweepDwellRange ( ) const
virtualinherited

Gets the CW dwell time range.

Returns
A list containing the minimum and maximum dwell time values.

Definition at line 1684 of file RadioHandler.cpp.

◆ getTransmitterCWSweepDwellRes()

double getTransmitterCWSweepDwellRes ( ) const
virtualinherited

Gets the CW dwell time resolution.

Returns
The resolution.

Definition at line 1693 of file RadioHandler.cpp.

◆ getTransmitterCWSweepDwellTime()

double getTransmitterCWSweepDwellTime ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the dwell time for a signal sweep for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The dwell time, in ADC samples.

Definition at line 1826 of file RadioHandler.cpp.

◆ getTransmitterCWSweepFrequencyStep()

double getTransmitterCWSweepFrequencyStep ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the frequency step for a signal sweep for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The frequency step, in Hz.

Definition at line 1817 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStartFrequency()

double getTransmitterCWSweepStartFrequency ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the start frequency for a signal sweep for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The start frequency, in Hz.

Definition at line 1799 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStartRange()

BasicDoubleList getTransmitterCWSweepStartRange ( ) const
virtualinherited

Gets the CW start frequency range.

Returns
A list containing the minimum and maximum frequency values.

Definition at line 1630 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStartRes()

double getTransmitterCWSweepStartRes ( ) const
virtualinherited

Gets the CW start frequency resolution.

Returns
The resolution.

Definition at line 1639 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStepRange()

BasicDoubleList getTransmitterCWSweepStepRange ( ) const
virtualinherited

Gets the CW frequency step range.

Returns
A list containing the minimum and maximum frequency values.

Definition at line 1666 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStepRes()

double getTransmitterCWSweepStepRes ( ) const
virtualinherited

Gets the CW frequency step resolution.

Returns
The resolution.

Definition at line 1675 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStopFrequency()

double getTransmitterCWSweepStopFrequency ( int  index,
int  cwIndex 
) const
virtualinherited

Gets the stop frequency for a signal sweep for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
The stop frequency, in Hz.

Definition at line 1808 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStopRange()

BasicDoubleList getTransmitterCWSweepStopRange ( ) const
virtualinherited

Gets the CW stop frequency range.

Returns
A list containing the minimum and maximum frequency values.

Definition at line 1648 of file RadioHandler.cpp.

◆ getTransmitterCWSweepStopRes()

double getTransmitterCWSweepStopRes ( ) const
virtualinherited

Gets the CW stop frequency resolution.

Returns
The resolution.

Definition at line 1657 of file RadioHandler.cpp.

◆ getTransmitterFrequency()

double getTransmitterFrequency ( int  index) const
virtualinherited

Gets the frequency for a given transmitter.

Parameters
indexTransmitter index.
Returns
The frequency (Hz).

Definition at line 1486 of file RadioHandler.cpp.

◆ getTransmitterFrequencyRange()

BasicDoubleList getTransmitterFrequencyRange ( ) const
virtualinherited

Gets the frequency range for the transmitters on the radio.

Returns
A list containing the minimum and maximum frequency values.

Definition at line 1418 of file RadioHandler.cpp.

◆ getTransmitterFrequencyRes()

double getTransmitterFrequencyRes ( ) const
virtualinherited

Gets the frequency resolution for transmitters on the radio.

Returns
The frequency resolution.

Definition at line 1427 of file RadioHandler.cpp.

◆ getTransmitterFrequencyUnit()

double getTransmitterFrequencyUnit ( ) const
virtualinherited

Gets the frequency unit for transmitters on the radio.

The frequency unit is a floating-point value that indicates how the frequency is specified in commands given to the radio.

  • 1.0: Frequency given in Hz
  • 1.0e6: Frequency given in MHz
Returns
The frequency unit.

Definition at line 1436 of file RadioHandler.cpp.

◆ getTransmitterIndexRange()

BasicIntList getTransmitterIndexRange ( ) const
virtualinherited

Gets the list of transmitter indices on the radio.

Returns
The list of transmitter indices.

Definition at line 1409 of file RadioHandler.cpp.

◆ getTstatus()

unsigned int getTstatus ( )
virtualinherited

Gets the tuner status from the radio.

Returns
The status bitmask provided by the radio, as an integer value. This command returns 0 if the radio does not support status queries.

Definition at line 551 of file RadioHandler.cpp.

◆ getTunerAttenuation()

double getTunerAttenuation ( int  index) const
virtualinherited

Gets the attenuation for a given tuner.

Parameters
indexThe tuner index number.
Returns
The attenuation, in dB.

Definition at line 864 of file RadioHandler.cpp.

◆ getTunerAttenuationRange()

BasicDoubleList getTunerAttenuationRange ( ) const
virtualinherited

Gets the tuner attenuation range.

Returns
A list containing the minimum and maximum attenuation values.

Definition at line 805 of file RadioHandler.cpp.

◆ getTunerAttenuationRes()

double getTunerAttenuationRes ( ) const
virtualinherited

Gets the attenuation resolution.

Returns
The resolution.

Definition at line 814 of file RadioHandler.cpp.

◆ getTunerConfiguration()

ConfigurationDict getTunerConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given tuner.

Parameters
indexThe tuner index number.
Returns
The configuration dictionary.

Definition at line 900 of file RadioHandler.cpp.

◆ getTunerFilter()

int getTunerFilter ( int  index) const
virtualinherited

Gets the filter setting for a given tuner.

Parameters
indexThe tuner index number.
Returns
The filter setting.

Definition at line 882 of file RadioHandler.cpp.

◆ getTunerFrequency()

double getTunerFrequency ( int  index) const
virtualinherited

Gets the tuned frequency for a given tuner.

Parameters
indexThe tuner index number.
Returns
The tuned frequency, in Hz.

Definition at line 846 of file RadioHandler.cpp.

◆ getTunerFrequencyRange()

BasicDoubleList getTunerFrequencyRange ( ) const
virtualinherited

Gets the tunable frequency range.

Returns
A list containing the minimum and maximum frequencies.

Definition at line 778 of file RadioHandler.cpp.

◆ getTunerFrequencyRes()

double getTunerFrequencyRes ( ) const
virtualinherited

Gets the tuned frequency resolution.

Returns
The frequency resolution, in Hz.

Definition at line 787 of file RadioHandler.cpp.

◆ getTunerFrequencyUnit()

double getTunerFrequencyUnit ( ) const
virtualinherited

Gets the tuned frequency units for tuners.

The frequency unit is a floating-point value that indicates how the frequency is specified in commands given to the radio.

  • 1.0: Frequency given in Hz
  • 1.0e6: Frequency given in MHz
Returns
The frequency unit.

Definition at line 796 of file RadioHandler.cpp.

◆ getTunerIndexRange()

BasicIntList getTunerIndexRange ( ) const
virtualinherited

Gets the tuner index range.

Returns
A list containing the tuner indices.

Definition at line 770 of file RadioHandler.cpp.

◆ getVersionInfo()

BasicStringStringDict getVersionInfo ( )
virtualinherited

Gets version information for the radio.

Returns
The version info dictionary.

Definition at line 250 of file RadioHandler.cpp.

◆ getVitaHeaderSize()

int getVitaHeaderSize ( ) const
virtualinherited

Gets the size of the VITA 49 header.

Returns
The header size, in bytes.

Definition at line 725 of file RadioHandler.cpp.

◆ getVitaPayloadSize()

int getVitaPayloadSize ( ) const
virtualinherited

Gets the size of the VITA 49 payload.

Returns
The payload size, in bytes.

Definition at line 730 of file RadioHandler.cpp.

◆ getVitaTailSize()

int getVitaTailSize ( ) const
virtualinherited

Gets the size of the VITA 49 tail.

Returns
The tail size, in bytes.

Definition at line 735 of file RadioHandler.cpp.

◆ getWbddcConfiguration()

ConfigurationDict getWbddcConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The configuration dictionary.

Definition at line 1152 of file RadioHandler.cpp.

◆ getWbddcDataPort()

int getWbddcDataPort ( int  index) const
virtualinherited

Gets the data port for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The data port. This number has no meaning if the radio does not use data ports.

Definition at line 1125 of file RadioHandler.cpp.

◆ getWbddcFrequency()

double getWbddcFrequency ( int  index) const
virtualinherited

Gets the tuned frequency for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The tuned frequency, in Hz. This value has no meaning if the WBDDC is not tunable.

Definition at line 1017 of file RadioHandler.cpp.

◆ getWbddcFrequencyRange()

BasicDoubleList getWbddcFrequencyRange ( ) const
virtualinherited

Gets the tunable frequency range for WBDDCs.

Returns
A list containing the minimum and maximum frequencies. These numbers have no meaning if the WBDDCs are not tunable.

Definition at line 949 of file RadioHandler.cpp.

◆ getWbddcFrequencyRes()

double getWbddcFrequencyRes ( ) const
virtualinherited

Gets the tuned frequency resolution for WBDDCs.

Returns
The frequency resolution, in Hz. This value has no meaning if the WBDDCs are not tunable.

Definition at line 958 of file RadioHandler.cpp.

◆ getWbddcFrequencyUnit()

double getWbddcFrequencyUnit ( ) const
virtualinherited

Gets the tuned frequency units for WBDDCs.

The frequency unit is a floating-point value that indicates how the frequency is specified in commands given to the radio.

  • 1.0: Frequency given in Hz
  • 1.0e6: Frequency given in MHz
Returns
The frequency unit.

Definition at line 967 of file RadioHandler.cpp.

◆ getWbddcGroupConfiguration()

ConfigurationDict getWbddcGroupConfiguration ( int  index) const
virtualinherited

Gets the configuration dictionary for a given WBDDC group.

Parameters
indexWBDDC group index number.
Returns
The configuration dictionary.

Definition at line 2146 of file RadioHandler.cpp.

◆ getWbddcGroupIndexRange()

BasicIntList getWbddcGroupIndexRange ( ) const
virtualinherited

Gets the range of WBDDC group indices on the radio.

Returns
A list of WBDDC group indices.

Definition at line 2115 of file RadioHandler.cpp.

◆ getWbddcGroupMembers()

BasicIntList getWbddcGroupMembers ( int  index) const
virtualinherited

Gets the list of group members for a given WBDDC group.

Parameters
indexThe WBDDC group index number.
Returns
List of WBDDC group members.

Definition at line 2164 of file RadioHandler.cpp.

◆ getWbddcIndexRange()

BasicIntList getWbddcIndexRange ( ) const
virtualinherited

Gets the range of WBDDC indices on the radio.

Returns
A list of WBDDC indices.

Definition at line 923 of file RadioHandler.cpp.

◆ getWbddcRateIndex()

int getWbddcRateIndex ( int  index) const
virtualinherited

Gets the rate index for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The rate index.

Definition at line 1053 of file RadioHandler.cpp.

◆ getWbddcRateList()

BasicDoubleList getWbddcRateList ( ) const
virtualinherited

Gets the list of allowed WBDDC sample rates, based on the rate set.

Returns
The rate list.

Definition at line 985 of file RadioHandler.cpp.

◆ getWbddcRateSet()

WbddcRateSet getWbddcRateSet ( ) const
virtualinherited

Gets the WBDDC rate set.

Returns
The rate set.

Definition at line 976 of file RadioHandler.cpp.

◆ getWbddcSource()

int getWbddcSource ( int  index) const
virtualinherited

Gets the source (which tuner is supplying the signal) for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The source index. This value has no meaning if the WBDDC does not support selectable source.

Definition at line 1035 of file RadioHandler.cpp.

◆ getWbddcStreamId()

unsigned int getWbddcStreamId ( int  index) const
virtualinherited

Gets the VITA 49 stream ID for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The VITA 49 stream ID.

Definition at line 1107 of file RadioHandler.cpp.

◆ getWbddcUdpDestination()

int getWbddcUdpDestination ( int  index) const
virtualinherited

Gets the UDP destination for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The UDP destination.

Definition at line 1071 of file RadioHandler.cpp.

◆ getWbddcVitaEnable()

int getWbddcVitaEnable ( int  index) const
virtualinherited

Gets the VITA 49 setting for a given WBDDC.

Parameters
indexWBDDC index number.
Returns
The VITA 49 setting.

Definition at line 1089 of file RadioHandler.cpp.

◆ initConfigurationDict()

void initConfigurationDict ( )
protectedvirtualinherited

Initializes the configuration dictionary, defining the allowed keys.

Derived classes should use this method to define which settings are configurable through a configuration dictionary.

Note
Derived classes must also call this method explicitly in order to initialize their configuration dictionary.

Reimplemented from Configurable.

Reimplemented in RadioHandler, RadioHandler, RadioHandler, and RadioHandler.

Definition at line 2546 of file RadioHandler.cpp.

◆ isByteswapped()

bool isByteswapped ( ) const
virtualinherited

Gets whether the VITA 49 is byte-swapped with respect to the host operating system.

Returns
True if byte-swapped, false otherwise.

Definition at line 740 of file RadioHandler.cpp.

◆ isConnected()

bool isConnected ( ) const
virtualinherited

Gets whether or not the handler is connected.

Returns
True if connected, false otherwise.

Definition at line 245 of file RadioHandler.cpp.

◆ isConnectionModeSupported()

bool isConnectionModeSupported ( const std::string &  mode) const
virtualinherited

Gets whether the radio supports the given connection mode.

Returns
True if the mode is supported, false otherwise.

Definition at line 710 of file RadioHandler.cpp.

◆ isDebug()

bool isDebug ( ) const
virtualinherited

Gets whether this object produces debug output.

Returns
True if producing debug, false otherwise.

Definition at line 133 of file Debuggable.cpp.

◆ isIqSwapped()

bool isIqSwapped ( ) const
virtualinherited

Gets whether the VITA 49 format swaps real and imaginary (I and Q) portions of each sample.

Returns
True if I and Q are swapped, false otherwise.

Definition at line 750 of file RadioHandler.cpp.

◆ isNbddcEnabled()

bool isNbddcEnabled ( int  index) const
virtualinherited

Gets whether or not a given NBDDC is enabled.

Parameters
indexNBDDC index number.
Returns
True if enabled, false otherwise.

Definition at line 1228 of file RadioHandler.cpp.

◆ isNbddcGroupEnabled()

bool isNbddcGroupEnabled ( int  index) const
virtualinherited

Gets whether or not a given NBDDC group is enabled.

Parameters
indexNBDDC group index number.
Returns
True if enabled, false otherwise.

Definition at line 2213 of file RadioHandler.cpp.

◆ isTransmitterEnabled()

bool isTransmitterEnabled ( int  index) const
virtualinherited

Gets whether a given transmitter is enabled.

Parameters
indexTransmitter index.
Returns
True if enabled, false otherwise.

Definition at line 1463 of file RadioHandler.cpp.

◆ isTunerEnabled()

bool isTunerEnabled ( int  index) const
virtualinherited

Gets whether or not a given tuner is enabled.

Parameters
indexThe tuner index number.
Returns
True if the tuner is enabled, false otherwise.

Definition at line 823 of file RadioHandler.cpp.

◆ isWbddcEnabled()

bool isWbddcEnabled ( int  index) const
virtualinherited

Gets whether or not a given WBDDC is enabled.

Parameters
indexWBDDC index number.
Returns
True if enabled, false otherwise.

Definition at line 994 of file RadioHandler.cpp.

◆ isWbddcGroupEnabled()

bool isWbddcGroupEnabled ( int  index) const
virtualinherited

Gets whether or not a given WBDDC group is enabled.

Parameters
indexWBDDC group index number.
Returns
True if enabled, false otherwise.

Definition at line 2123 of file RadioHandler.cpp.

◆ isWbddcSelectableSource()

bool isWbddcSelectableSource ( ) const
virtualinherited

Gets whether the WBDDCs on this radio support selecting their tuner source.

Returns
True if selectable, false otherwise.

Definition at line 940 of file RadioHandler.cpp.

◆ isWbddcTunable()

bool isWbddcTunable ( ) const
virtualinherited

Gets whether the WBDDCs on this radio are tunable.

Returns
True if tunable, false otherwise.

Definition at line 931 of file RadioHandler.cpp.

◆ loadDucSnapshot()

bool loadDucSnapshot ( int  index,
const std::string &  filename,
unsigned int  startSample = 0,
unsigned int  samples = 0 
)
virtualinherited

Load a snapshot file into a given DUC's memory block.

Snapshot files contain 16-bit complex I/Q data samples.

Parameters
indexThe DUC index number.
filenameSnapshot file name. The snapshot file needs to be present on the radio.
startSampleStarting address in DUC's memory block. Must be a multiple of 1024.
samplesNumber of I/Q samples to load. Must be a multiple of 16. If specified as 0, load the maximum number of samples from the file.
Returns
True if successful, false otherwise. Returns false if the DUC does not support snapshot loading.

Definition at line 2079 of file RadioHandler.cpp.

◆ normalizedBool()

std::string normalizedBool ( const std::string &  val)
protectedvirtualinherited

Normalizes a Boolean string value.

Returns
The "normalized" string value.

Definition at line 241 of file Configurable.cpp.

◆ normalizedConfigurationDict()

ConfigurationDict normalizedConfigurationDict ( const ConfigurationDict cfg)
protectedvirtualinherited

Normalizes an incoming configuration dictionary.

"Normalizing" a configuration dictionary replaces certain strings representing Boolean values ("yes", "on", "true", "no", "off", and "false", case is irrelevant) with standard values ("0" and "1").

Note
The default behavior of this method normalizes every string in the configuration dictionary. Override this method if certain configuration items need to be protected from normalization.
Returns
The new configuration dictionary.

Definition at line 232 of file Configurable.cpp.

◆ rawString()

std::string rawString ( const std::string &  data)
virtualinherited

Gets a "raw" string representation of a given data string.

"Raw" string representations mimic Python string representations. Whitespace characters are denoted by backslash representations ("\\r", "\\n", "\\t", "\\v", "\\f"), while other non-printable characters are represented with hex representation ("\\x00", etc.)

Parameters
dataData string
Returns
The data's "raw" representation.

Definition at line 143 of file Debuggable.cpp.

◆ removeNbddcGroupMember()

bool removeNbddcGroupMember ( int  index,
int  member 
)
virtualinherited

Removes a NBDDC from the given NBDDC group.

Parameters
indexThe NBDDC group index number.
memberNBDDC to remove.
Returns
True if successful, false otherwise.

Definition at line 2281 of file RadioHandler.cpp.

◆ removeWbddcGroupMember()

bool removeWbddcGroupMember ( int  index,
int  member 
)
virtualinherited

Removes a WBDDC from the given WBDDC group.

Parameters
indexThe WBDDC group index number.
memberWBDDC to remove.
Returns
True if successful, false otherwise.

Definition at line 2191 of file RadioHandler.cpp.

◆ sendCommand()

BasicStringList sendCommand ( const std::string &  cmdString,
double  timeout = -1 
)
virtualinherited

Sends a command to the radio.

Parameters
cmdStringThe command string.
timeoutTimeout value (seconds). If this is -1, use the transport's default timeout.
Returns
A list of response strings from the radio.

Definition at line 307 of file RadioHandler.cpp.

◆ sendReset()

bool sendReset ( int  resetType = 0)
virtualinherited

Resets the radio.

Parameters
resetTypeThe type of reset to perform. Varies by radio.
Returns
True if successful, false otherwise.

Definition at line 468 of file RadioHandler.cpp.

◆ setBypassMode()

bool setBypassMode ( int  mode)
virtualinherited

Sets the reference bypass mode on the radio.

Parameters
modeAn integer indicating the bypass mode to set. Valid bypass mode numbers vary by radio.
Returns
True if successful, false if unsuccessful or if bypass mode setting is not supported on the radio.

Definition at line 569 of file RadioHandler.cpp.

◆ setCalibrationFrequency()

bool setCalibrationFrequency ( double  freq)
virtualinherited

Sets the calibration frequency.

Parameters
freqThe new calibration frequency, in MHz. A value of 0 turns off the calibration function.
Returns
True if the call succeeds, false otherwise.

Definition at line 667 of file RadioHandler.cpp.

◆ setConfiguration()

bool setConfiguration ( ConfigurationDict cfg)
virtualinherited

Sets the configuration dictionary for this object.

This method is intended to allow users to change the object's settings based on the configuration dictionary. It should not be used to set configuration dictionary elements that the object does not use.

Parameters
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Reimplemented from Configurable.

Definition at line 394 of file RadioHandler.cpp.

◆ setConfigurationValue()

bool setConfigurationValue ( const std::string &  key,
const std::string &  value 
)
virtualinherited

Sets a named configuration value to a string.

Note
The default behavior of this method is to normalize the incoming value.
Parameters
keyThe key string in the configuration dictionary.
valueThe new value.
Returns
True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 177 of file Configurable.cpp.

◆ setConfigurationValueToBool()

bool setConfigurationValueToBool ( const std::string &  key,
const bool  value 
)
virtualinherited

Sets a named configuration value to a Boolean.

Parameters
keyThe key string in the configuration dictionary.
valueThe new value.
Returns
True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 193 of file Configurable.cpp.

◆ setConfigurationValueToDbl()

bool setConfigurationValueToDbl ( const std::string &  key,
const double  value 
)
virtualinherited

Sets a named configuration value to a double value.

Parameters
keyThe key string in the configuration dictionary.
valueThe new value.
Returns
True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 211 of file Configurable.cpp.

◆ setConfigurationValueToInt()

bool setConfigurationValueToInt ( const std::string &  key,
const int  value 
)
virtualinherited

Sets a named configuration value to an integer value.

Parameters
keyThe key string in the configuration dictionary.
valueThe new value.
Returns
True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 199 of file Configurable.cpp.

◆ setConfigurationValueToUInt()

bool setConfigurationValueToUInt ( const std::string &  key,
const unsigned int  value 
)
virtualinherited

Sets a named configuration value to an unsigned integer value.

Parameters
keyThe key string in the configuration dictionary.
valueThe new value.
Returns
True if the key was set, false otherwise. Returns false if the key is not in the configuration dictionary.

Definition at line 205 of file Configurable.cpp.

◆ setDataPortConfiguration()

bool setDataPortConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given data port.

Parameters
indexData port index number.
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 2332 of file RadioHandler.cpp.

◆ setDataPortDestDestPort()

bool setDataPortDestDestPort ( int  index,
int  dipIndex,
unsigned int  destPort 
)
virtualinherited

Sets the VITA stream ID for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
destPortThe destination UDP port number.
Returns
True if successful, false otherwise.

Definition at line 2453 of file RadioHandler.cpp.

◆ setDataPortDestInfo()

bool setDataPortDestInfo ( int  index,
int  dipIndex,
const std::string &  ipAddr,
const std::string &  macAddr,
unsigned int  sourcePort,
unsigned int  destPort 
)
virtualinherited

Sets the destination table information for a given entry in the DIP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
ipAddrThe IP address.
macAddrThe MAC address.
sourcePortThe source UDP port number.
destPortThe destination UDP port number.
Returns
True if successful, false otherwise.

Definition at line 2463 of file RadioHandler.cpp.

◆ setDataPortDestIPAddress()

bool setDataPortDestIPAddress ( int  index,
int  dipIndex,
const std::string &  ipAddr 
)
virtualinherited

Sets the IP address for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
ipAddrThe new IP address.
Returns
True if successful, false otherwise.

Definition at line 2415 of file RadioHandler.cpp.

◆ setDataPortDestMACAddress()

bool setDataPortDestMACAddress ( int  index,
int  dipIndex,
const std::string &  macAddr 
)
virtualinherited

Sets the MAC address for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
macAddrThe new MAC address.
Returns
True if successful, false otherwise.

Definition at line 2396 of file RadioHandler.cpp.

◆ setDataPortDestSourcePort()

bool setDataPortDestSourcePort ( int  index,
int  dipIndex,
unsigned int  sourcePort 
)
virtualinherited

Sets the UDP port number for a given entry in the destination IP table on a given data port.

Parameters
indexData port index number.
dipIndexIndex number for the entry in the DIP table.
sourcePortThe source UDP port number.
Returns
True if successful, false otherwise.

Definition at line 2434 of file RadioHandler.cpp.

◆ setDataPortSourceIP()

bool setDataPortSourceIP ( int  index,
const std::string &  ipAddr 
)
virtualinherited

Sets the source IP address for a given data port.

Parameters
indexData port index number.
ipAddrThe new source IP address.
Returns
True if successful, false otherwise.

Definition at line 2350 of file RadioHandler.cpp.

◆ setDebugFile()

void setDebugFile ( FILE *  debug_fp)
virtualinherited

Sets the debug file pointer for this object.

Parameters
debug_fpFile to send debug output to.

Definition at line 81 of file Debuggable.cpp.

◆ setDebugName()

void setDebugName ( const std::string &  debug_name)
virtualinherited

Sets the debug name for this object.

Use this method to set unique debug names for objects of the same class for easy differentiation.

Parameters
debug_nameName for identifying this object in debug output.

Definition at line 74 of file Debuggable.cpp.

◆ setDebugTimeFormat()

void setDebugTimeFormat ( const std::string &  debug_timefmt)
virtualinherited

Sets the debug time format for this object.

Parameters
debug_timefmtFormat string for displaying timestamp, as compatible with strftime(). If this is an empty string, don't display a timestamp.

Definition at line 88 of file Debuggable.cpp.

◆ setDucAttenuation()

bool setDucAttenuation ( int  index,
double  atten 
)
virtualinherited

Sets the attenuation for a given DUC.

Parameters
indexThe DUC index number.
attenThe new attenuation (dB).
Returns
True if successful, false otherwise.

Definition at line 1980 of file RadioHandler.cpp.

◆ setDucConfiguration()

bool setDucConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given DUC.

Parameters
indexThe DUC index number.
cfgThe component configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 1899 of file RadioHandler.cpp.

◆ setDucDataPort()

bool setDucDataPort ( int  index,
int  port 
)
virtualinherited

Sets the data port for a given DUC.

Parameters
indexThe DUC index number.
portThe new data port. Setting this to 0 disables streaming.
Returns
True if successful, false otherwise.

Definition at line 1917 of file RadioHandler.cpp.

◆ setDucFrequency()

bool setDucFrequency ( int  index,
double  freq 
)
virtualinherited

Sets the tuned frequency for a given DUC.

Parameters
indexThe DUC index number.
freqThe new tuned frequency (Hz).
Returns
True if successful, false otherwise.

Definition at line 1935 of file RadioHandler.cpp.

◆ setDucMode()

bool setDucMode ( int  index,
int  mode 
)
virtualinherited

Sets the mode for a given DUC.

Parameters
indexThe DUC index number.
modeThe new mode. This is either 0 (streaming) or 1 (playback).
Returns
True if successful, false otherwise.

Definition at line 2052 of file RadioHandler.cpp.

◆ setDucRateIndex()

bool setDucRateIndex ( int  index,
int  rateIndex 
)
virtualinherited

Sets the rate index for a given DUC.

Parameters
indexThe DUC index number.
rateIndexThe new rate index.
Returns
True if successful, false otherwise.

Definition at line 2016 of file RadioHandler.cpp.

◆ setDucStreamId()

bool setDucStreamId ( int  index,
unsigned int  sid 
)
virtualinherited

Sets the VITA 49 stream ID for a given DUC.

Parameters
indexThe DUC index number.
sidThe new stream ID.
Returns
True if successful, false otherwise.

Definition at line 2070 of file RadioHandler.cpp.

◆ setDucTxChannelBitmap()

bool setDucTxChannelBitmap ( int  index,
int  txChannels 
)
virtualinherited

Sets the transmit channel bitmap for a given DUC.

Parameters
indexThe DUC index number.
txChannelsBitmap indicating which transmitters output the signal from this DUC. Setting a bit position to 1 enables transmit on the associated transmitter. The LSB corresponds to TX 1, and each succeeding bit corresponds to the other transmitters.
Returns
True if successful, false otherwise.

Definition at line 2034 of file RadioHandler.cpp.

◆ setGpioOutput()

bool setGpioOutput ( int  value)
virtualinherited

Sets the current GPIO output bits.

Note
Executing this method puts the GPIO module into static mode.
Parameters
valueThe GPIO output value, as an integer bitmask.
Returns
True if successful, false if unsuccessful or if setting GPIO output is not supported.

Definition at line 640 of file RadioHandler.cpp.

◆ setGpioOutputByIndex()

bool setGpioOutputByIndex ( int  index,
int  value,
int  duration,
int  loop,
int  go 
)
virtualinherited

Sets the GPIO output settings for a given sequence index.

Note
Executing this method puts the GPIO module into sequence mode if the "go" parameter is 1.
Parameters
indexThe GPIO sequence index.
valueThe GPIO output value, as an integer bitmask.
durationThe duration for that value, as a number of ADC clock cycles.
loopWhether the sequence loops back to the beginning after this step (1) or not (0).
goWhether to execute the sequence (1) or not (0).
Returns
True if successful, false if unsuccessful or if setting GPIO output is not supported.

Definition at line 649 of file RadioHandler.cpp.

◆ setName()

void setName ( const std::string &  name)
virtualinherited

Sets the name of the configurable object.

Parameters
nameThe new name.

Definition at line 88 of file Configurable.cpp.

◆ setNbddcConfiguration()

bool setNbddcConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given NBDDC.

Parameters
indexNBDDC index number.
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 1260 of file RadioHandler.cpp.

◆ setNbddcDataPort()

bool setNbddcDataPort ( int  index,
int  port 
)
virtualinherited

Sets the data port for a given NBDDC.

Parameters
indexNBDDC index number.
portThe new data port.
Returns
True if successful, false otherwise. Returns false if the radio does not use data ports.

Definition at line 1386 of file RadioHandler.cpp.

◆ setNbddcFrequency()

bool setNbddcFrequency ( int  index,
double  freq 
)
virtualinherited

Sets the tuned frequency for a given NBDDC.

Parameters
indexNBDDC index number.
freqThe new tuned frequency (Hz).
Returns
True if successful, false otherwise. Returns false if the NBDDC is not tunable.

Definition at line 1278 of file RadioHandler.cpp.

◆ setNbddcGroupConfiguration()

bool setNbddcGroupConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given NBDDC group.

Parameters
indexThe NBDDC group index number.
cfgThe component configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 2245 of file RadioHandler.cpp.

◆ setNbddcGroupMembers()

bool setNbddcGroupMembers ( int  index,
const BasicIntList groupMembers 
)
virtualinherited

Sets the list of group members for a given NBDDC group.

Parameters
indexThe NBDDC group index number.
groupMembersList of NBDDC group members.
Returns
True if successful, false otherwise.

Definition at line 2263 of file RadioHandler.cpp.

◆ setNbddcRateIndex()

bool setNbddcRateIndex ( int  index,
int  rateIndex 
)
virtualinherited

Sets the rate index for a given NBDDC.

Parameters
indexNBDDC index number.
rateIndexThe new rate index.
Returns
True if successful, false otherwise.

Definition at line 1314 of file RadioHandler.cpp.

◆ setNbddcRateSet()

bool setNbddcRateSet ( int  index,
const NbddcRateSet set 
)
virtualinherited

Sets the rate set for a given NBDDC.

Parameters
indexNBDDC index number.
setThe new rate set.
Returns
True if successful, false otherwise.

Definition at line 1395 of file RadioHandler.cpp.

◆ setNbddcSource()

bool setNbddcSource ( int  index,
int  source 
)
virtualinherited

Sets the source (which tuner is supplying the signal) for a given NBDDC.

Parameters
indexNBDDC index number.
sourceThe new NBDDC source index.
Returns
True if successful, false otherwise. Returns false if the NBDDC does not support selectable source.

Definition at line 1296 of file RadioHandler.cpp.

◆ setNbddcStreamId()

bool setNbddcStreamId ( int  index,
unsigned int  sid 
)
virtualinherited

Sets the VITA 49 stream ID for a given NBDDC.

Parameters
indexNBDDC index number.
sidThe new stream ID.
Returns
True if successful, false otherwise.

Definition at line 1368 of file RadioHandler.cpp.

◆ setNbddcUdpDestination()

bool setNbddcUdpDestination ( int  index,
int  dest 
)
virtualinherited

Sets the UDP destination for a given NBDDC.

Parameters
indexNBDDC index number.
destThe new UDP destination.
Returns
True if successful, false otherwise.

Definition at line 1332 of file RadioHandler.cpp.

◆ setNbddcVitaEnable()

bool setNbddcVitaEnable ( int  index,
int  enable 
)
virtualinherited

Sets the VITA 49 setting for a given NBDDC.

Parameters
indexNBDDC index number.
enableThe new VITA 49 setting.
Returns
True if successful, false otherwise.

Definition at line 1350 of file RadioHandler.cpp.

◆ setReferenceMode()

bool setReferenceMode ( int  mode)
virtualinherited

Sets the reference mode on the radio.

Parameters
modeAn integer indicating the reference mode to set. Valid reference mode numbers vary by radio.
Returns
True if successful, false if unsuccessful or if reference mode setting is not supported on the radio.

Definition at line 562 of file RadioHandler.cpp.

◆ setSimpleDestIPAddress()

bool setSimpleDestIPAddress ( const std::string &  ipAddr)
virtualinherited

Sets the destination IP address for radios without 10Gig data ports.

Parameters
ipAddrThe IP address [string]
Returns
True if successful, false otherwise.

Definition at line 2534 of file RadioHandler.cpp.

◆ setSimpleDestMACAddress()

bool setSimpleDestMACAddress ( const std::string &  macAddr)
virtualinherited

Sets the destination MAC address for radios without 10Gig data ports.

Parameters
macAddrThe MAC address [string]
Returns
True if successful, false otherwise.

Definition at line 2522 of file RadioHandler.cpp.

◆ setSimpleIPConfiguration()

bool setSimpleIPConfiguration ( ConfigurationDict cfg)
virtualinherited

Sets the "simple" IP configuration dictionary for radios without 10Gig data ports.

Parameters
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 2488 of file RadioHandler.cpp.

◆ setSimpleSourceIPAddress()

bool setSimpleSourceIPAddress ( const std::string &  ipAddr)
virtualinherited

Sets the source IP address for radios without 10Gig data ports.

Parameters
ipAddrThe IP address [string]
Returns
True if successful, false otherwise.

Definition at line 2510 of file RadioHandler.cpp.

◆ setTenGigFlowControlStatus()

bool setTenGigFlowControlStatus ( bool  enable)
virtualinherited

Sets flow control status on all 10GigE data ports.

Parameters
enableTrue if flow control should be enabled, false if not.
Returns
True if successful, false otherwise.

Definition at line 2300 of file RadioHandler.cpp.

◆ setTimeAdjustment()

bool setTimeAdjustment ( int  tunerIndex,
int  timeAdjustValue 
)
virtualinherited

Sets the time adjustment for tuners on the radio.

Parameters
tunerIndexTuner index number.
timeAdjustValueTime adjustment value.
Returns
True if successful, false if unsuccessful or if adjusting the time is not supported.

Definition at line 576 of file RadioHandler.cpp.

◆ setTimeNextPps()

bool setTimeNextPps ( bool  checkTime = false,
bool  useGpsTime = false 
)
virtualinherited

Sets the time for the next PPS rising edge on the radio.

Parameters
checkTimeWhether to check that the set time is the time we wanted.
useGpsTimeWhether to use the radio's GPS time for this.
Returns
True if successful, false otherwise.

Definition at line 478 of file RadioHandler.cpp.

◆ setTransmitterAttenuation()

bool setTransmitterAttenuation ( int  index,
double  atten 
)
virtualinherited

Sets the attenuation for a given transmitter.

Parameters
indexTransmitter index.
attenThe new attenuation, in dB.
Returns
True if successful, false otherwise.

Definition at line 1513 of file RadioHandler.cpp.

◆ setTransmitterConfiguration()

bool setTransmitterConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given transmitter.

Parameters
indexTransmitter index number.
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 1531 of file RadioHandler.cpp.

◆ setTransmitterCWAmplitude()

bool setTransmitterCWAmplitude ( int  index,
int  cwIndex,
double  amp 
)
virtualinherited

Sets the signal amplitude for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
ampThe new signal amplitude (scale units).
Returns
True if successful, false otherwise.

Definition at line 1763 of file RadioHandler.cpp.

◆ setTransmitterCWConfiguration()

bool setTransmitterCWConfiguration ( int  index,
int  cwIndex,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
cfgThe component configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 1726 of file RadioHandler.cpp.

◆ setTransmitterCWFrequency()

bool setTransmitterCWFrequency ( int  index,
int  cwIndex,
double  freq 
)
virtualinherited

Sets the constant frequency for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
freqThe new constant frequency (Hz).
Returns
True if successful, false otherwise.

Definition at line 1745 of file RadioHandler.cpp.

◆ setTransmitterCWFrequencySweep()

bool setTransmitterCWFrequencySweep ( int  index,
int  cwIndex,
double  start,
double  stop,
double  step,
double  dwell 
)
virtualinherited

Sets the parameters for a frequency sweep for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
startThe new start frequency (Hz).
stopThe new stop frequency (Hz).
stepThe new frequency step (Hz).
dwellThe new dwell time (ADC samples).
Returns
True if successful, false otherwise.

Definition at line 1835 of file RadioHandler.cpp.

◆ setTransmitterCWPhase()

bool setTransmitterCWPhase ( int  index,
int  cwIndex,
double  phase 
)
virtualinherited

Sets the signal phase for a given CW tone generator.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
phaseThe new signal phase (degrees).
Returns
True if successful, false otherwise.

Definition at line 1781 of file RadioHandler.cpp.

◆ setTransmitterFrequency()

bool setTransmitterFrequency ( int  index,
double  freq 
)
virtualinherited

Sets the frequency for a given transmitter.

Parameters
indexTransmitter index.
freqThe new transmitter frequency, in Hz.
Returns
True if successful, false otherwise.

Definition at line 1495 of file RadioHandler.cpp.

◆ setTunerAttenuation()

bool setTunerAttenuation ( int  index,
double  atten 
)
virtualinherited

Sets the attenuation for a given tuner.

Parameters
indexThe tuner index number.
attenThe new attenuation (dB).
Returns
True if successful, false otherwise.

Definition at line 873 of file RadioHandler.cpp.

◆ setTunerConfiguration()

bool setTunerConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given tuner.

Parameters
indexThe tuner index number.
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 909 of file RadioHandler.cpp.

◆ setTunerFilter()

bool setTunerFilter ( int  index,
int  filter 
)
virtualinherited

Sets the filter setting for a given tuner.

Parameters
indexThe tuner index number.
filterThe new filter setting.
Returns
True if successful, false otherwise.

Definition at line 891 of file RadioHandler.cpp.

◆ setTunerFrequency()

bool setTunerFrequency ( int  index,
double  freq 
)
virtualinherited

Sets the tuned frequency for a given tuner.

Parameters
indexThe tuner index number.
freqThe new tuned frequency (Hz).
Returns
True if successful, false otherwise.

Definition at line 855 of file RadioHandler.cpp.

◆ setWbddcConfiguration()

bool setWbddcConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given WBDDC.

Parameters
indexWBDDC index number.
cfgThe configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 1161 of file RadioHandler.cpp.

◆ setWbddcDataPort()

bool setWbddcDataPort ( int  index,
int  port 
)
virtualinherited

Sets the data port for a given WBDDC.

Parameters
indexWBDDC index number.
portThe new data port.
Returns
True if successful, false otherwise. Returns false if the radio does not use data ports.

Definition at line 1134 of file RadioHandler.cpp.

◆ setWbddcFrequency()

bool setWbddcFrequency ( int  index,
double  freq 
)
virtualinherited

Sets the tuned frequency for a given WBDDC.

Parameters
indexWBDDC index number.
freqThe new tuned frequency (Hz).
Returns
True if successful, false otherwise. Returns false if the WBDDC is not tunable.

Definition at line 1026 of file RadioHandler.cpp.

◆ setWbddcGroupConfiguration()

bool setWbddcGroupConfiguration ( int  index,
ConfigurationDict cfg 
)
virtualinherited

Sets the configuration dictionary for a given WBDDC group.

Parameters
indexThe WBDDC group index number.
cfgThe component configuration dictionary.
Returns
True if successful, false otherwise.

Definition at line 2155 of file RadioHandler.cpp.

◆ setWbddcGroupMembers()

bool setWbddcGroupMembers ( int  index,
const BasicIntList groupMembers 
)
virtualinherited

Sets the list of group members for a given WBDDC group.

Parameters
indexThe WBDDC group index number.
groupMembersList of WBDDC group members.
Returns
True if successful, false otherwise.

Definition at line 2173 of file RadioHandler.cpp.

◆ setWbddcRateIndex()

bool setWbddcRateIndex ( int  index,
int  rateIndex 
)
virtualinherited

Sets the rate index for a given WBDDC.

Parameters
indexWBDDC index number.
rateIndexThe new rate index.
Returns
True if successful, false otherwise.

Definition at line 1062 of file RadioHandler.cpp.

◆ setWbddcRateSet()

bool setWbddcRateSet ( int  index,
const WbddcRateSet set 
)
virtualinherited

Sets the rate set for a given WBDDC.

Parameters
indexWBDDC index number.
setThe new rate set.
Returns
True if successful, false otherwise.

Definition at line 1143 of file RadioHandler.cpp.

◆ setWbddcSource()

bool setWbddcSource ( int  index,
int  source 
)
virtualinherited

Sets the source (which tuner is supplying the signal) for a given WBDDC.

Parameters
indexWBDDC index number.
sourceThe new WBDDC source index.
Returns
True if successful, false otherwise. Returns false if the WBDDC does not support selectable source.

Definition at line 1044 of file RadioHandler.cpp.

◆ setWbddcStreamId()

bool setWbddcStreamId ( int  index,
unsigned int  sid 
)
virtualinherited

Sets the VITA 49 stream ID for a given WBDDC.

Parameters
indexWBDDC index number.
sidThe new stream ID.
Returns
True if successful, false otherwise.

Definition at line 1116 of file RadioHandler.cpp.

◆ setWbddcUdpDestination()

bool setWbddcUdpDestination ( int  index,
int  dest 
)
virtualinherited

Sets the UDP destination for a given WBDDC.

Parameters
indexWBDDC index number.
destThe new UDP destination.
Returns
True if successful, false otherwise.

Definition at line 1080 of file RadioHandler.cpp.

◆ setWbddcVitaEnable()

bool setWbddcVitaEnable ( int  index,
int  enable 
)
virtualinherited

Sets the VITA 49 setting for a given WBDDC.

Parameters
indexWBDDC index number.
enableThe new VITA 49 setting.
Returns
True if successful, false otherwise.

Definition at line 1098 of file RadioHandler.cpp.

◆ transmitterSupportsCW()

bool transmitterSupportsCW ( ) const
virtualinherited

Gets whether transmitters support continuous-wave (CW) tone generation.

Returns
True if supported, false otherwise.

Definition at line 1540 of file RadioHandler.cpp.

◆ transmitterSupportsCWSweep() [1/2]

bool transmitterSupportsCWSweep ( ) const
virtualinherited

Gets whether the transmitter supports CW tone sweeping.

Returns
True if supported, false otherwise.

Definition at line 1621 of file RadioHandler.cpp.

◆ transmitterSupportsCWSweep() [2/2]

bool transmitterSupportsCWSweep ( int  index,
int  cwIndex 
) const
virtualinherited

Gets whether or not a given CW tone generator supports signal sweeps.

Parameters
indexTransmitter index.
cwIndexCW tone generator index.
Returns
True if supported, false otherwise.

Definition at line 1790 of file RadioHandler.cpp.

◆ updateConfigurationDict()

void updateConfigurationDict ( )
protectedvirtualinherited

Updates the configuration dictionary from object settings.

Derived classes should use this method to convert the object's configurable settings into a configuration dictionary.

Reimplemented from Configurable.

Definition at line 2561 of file RadioHandler.cpp.


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