Instrument.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 Instrument_h
#define Instrument_h
 
#include "InstrumentChannel.h"
#include "ConfigWarningList.h"
#include "SerializableObject.h"
 
class Instrument
    : public std::enable_shared_from_this<Instrument>
    , public SerializableObject
{
public:
    virtual ~Instrument();
 
    // Instrument identification
 
    /*
        @brief Types of instrument.
 
        Note that we can't use RTTI for this because of software options that may or may not be present,
        and we don't know at object instantiation time.
 
        For example, some WaveSurfer 3000 devices have the function generator option and others don't.
        While the WaveSurfer 3000 DMM option is now no-cost, there's no guarantee any given instrument's
        owner has installed it!
     */
    enum InstrumentTypes
    {
        //An oscilloscope or logic analyzer
        INST_OSCILLOSCOPE       =  0x01,
 
        //A multimeter (query to see what measurements it supports)
        INST_DMM                =  0x02,
 
        //A power supply
        INST_PSU                =  0x04,
 
        //A function generator
        INST_FUNCTION           =  0x08,
 
        //An RF signal generator
        INST_RF_GEN             =  0x10,
 
        //An electronic load
        INST_LOAD               =  0x20,
 
        //A bit error rate tester
        INST_BERT               =  0x40,
 
        //A miscellaneous instrument that doesn't fit any other category
        INST_MISC               =  0x80,
 
        //A switch matrix
        INST_SWITCH_MATRIX      = 0x100
    };
 
    virtual unsigned int GetInstrumentTypes() const =0;
 
    //Device information
    virtual std::string GetName() const =0;
    virtual std::string GetVendor() const =0;
    virtual std::string GetSerial() const =0;
 
    std::string m_nickname;
 
    virtual std::string GetTransportConnectionString() =0;
 
    virtual std::string GetTransportName() =0;
 
    virtual bool IsOffline();
 
    // Channel enumeration and identification
 
    virtual uint32_t GetInstrumentTypesForChannel(size_t i) const =0;
 
    size_t GetChannelCount() const
    { return m_channels.size(); }
 
    InstrumentChannel* GetChannel(size_t i) const
    {
        if(i >= m_channels.size())
            return nullptr;
 
        return m_channels[i];
    }
 
    virtual std::string GetChannelDisplayName(size_t i);
 
    virtual void SetChannelDisplayName(size_t i, std::string name);
 
    InstrumentChannel* GetChannelByDisplayName(const std::string& name);
    InstrumentChannel* GetChannelByHwName(const std::string& name);
 
    // Data capture
 
    virtual void BackgroundProcessing();
 
    virtual bool AcquireData() =0;
 
    virtual void FlushConfigCache();
 
    // Serialization
 
public:
 
    virtual YAML::Node SerializeConfiguration(IDTable& table) const;
 
    virtual void LoadConfiguration(int version, const YAML::Node& node, IDTable& idmap);
 
    virtual void PreLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap, ConfigWarningList& warnings);
 
protected:
 
    std::list< sigc::slot<void(YAML::Node&, IDTable&)> > m_serializers;
 
    std::list< sigc::slot<void(int, const YAML::Node&, IDTable&)> > m_loaders;
 
    std::list< sigc::slot<void(int, const YAML::Node&, IDTable&, ConfigWarningList&)> > m_preloaders;
 
protected:
 
    std::vector<InstrumentChannel*> m_channels;
 
};
 
#endif