RadioRX.hxx

Go to the documentation of this file.

/*
Copyright (c) 2026 Matthew H. Reilly (kb1vc)
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
    Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#pragma once
#include "SoDaBase.hxx"
#include "SoDaThread.hxx"
#include "Command.hxx"
#include "Params.hxx"
 
#include <SoDa/MailBox.hxx>
 
namespace SoDa {
  class RadioRX : public SoDa::Thread {
  public:
    RadioRX(ParamsPtr params);

    void run() final;

    virtual void init() { }
    
  protected:
    ParamsPtr params;
    virtual void execGetCommand(CommandPtr cmd) final;

    virtual void execSetCommand(CommandPtr cmd) final;

    virtual void execRepCommand(CommandPtr cmd) final;

    double getTime();
 
 
    virtual void subscribeToMailBoxes(const std::vector<MailBoxBasePtr> & mailboxes) final; 
    
 
  private:
    // These are the command handlers. They call virtual methods provided
    // by specific radio modules. They can't be over-ridden. 
    
    virtual void subExecCommand(CommandPtr cmd) { }
    virtual void subExecGetCommand(CommandPtr cmd) { }
    virtual void subExecSetCommand(CommandPtr cmd) { }
    virtual void subExecRepCommand(CommandPtr cmd) { }
    
  public:
    virtual void setNCOFreq(double freq) = 0;

    virtual bool downConvert() = 0;

    virtual void startStream() = 0;

    virtual void stopStream() = 0;

    virtual bool streamEnabled() = 0;

    virtual void enableIFStreamer(bool enable) = 0;
    
  protected:
    
    CDatMBoxPtr rx_stream;
    CDatMBoxPtr if_stream;
    CmdMBoxPtr cmd_stream;
    CmdMBox::Subscription cmd_subs;
 
    double current_IF_tuning; 
  };
}