CommandLineDriver.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* 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.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "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 AUTHORS BE HELD 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.                                                                                          *
*                                                                                                                      *
***********************************************************************************************************************/
 
#ifndef CommandLineDriver_h
#define CommandLineDriver_h
 
class CommandLineDriver: public virtual SCPIDevice
{
public:
    CommandLineDriver(SCPITransport* transport);
    ~CommandLineDriver();
 
 
protected:
    // Make sure several request don't collide before we received the corresponding response
    std::recursive_mutex m_transportMutex;
 
    std::string ConverseSingle(const std::string& commandString, bool hasEcho = true);
 
 
    size_t ConverseMultiple(
        const std::string& commandString,
        std::vector<std::string> &readLines,
        bool hasEcho = true,
        std::function<void(float)> progress = nullptr,
        size_t expecedLines = 0);
 
    bool ConverseSweep(int64_t &sweepStart, int64_t &sweepStop, int64_t &points, bool setFreqValues = false);
 
    bool ConverseSweep(int64_t &sweepStart, int64_t &sweepStop, bool setFreqValues = false)
    {
        int64_t unused;
        return ConverseSweep(sweepStart, sweepStop, unused, setFreqValues);
    }
 
    std::string ConverseString(
        const std::string& commandString,
        std::function<void(float)> progress = nullptr,
        size_t expecedLines = 0);
 
    std::string DrainTransport();
 
    size_t m_maxResponseSize;
    double m_communicationTimeout;
 
    // @brief Trailer string expected at the end of a response from the device (command prompt)
    inline static const std::string TRAILER_STRING = "ch> ";
    // @brief Legth of the trailer string expected at the end of a response from the device (command prompt)
    inline static const size_t TRAILER_STRING_LENGTH = TRAILER_STRING.size();
    // @brief End Of Line string
    inline static const std::string EOL_STRING = "\r\n";
    // @brief Size of the EOL string
    inline static const size_t EOL_STRING_LENGTH = EOL_STRING.size();
};
#endif