CDRTrigger.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2024 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 CDRTrigger_h
#define CDRTrigger_h
 
class CDRTrigger : public Trigger
{
public:
    CDRTrigger(Oscilloscope* scope);
    virtual ~CDRTrigger();
 
    virtual bool ValidateChannel(size_t i, StreamDescriptor stream);
 
    void SetBitRate(int64_t rate)
    { m_parameters[m_bitRateName].SetIntVal(rate); }
 
    int64_t GetBitRate()
    { return m_parameters[m_bitRateName].GetIntVal(); }
 
    void CalculateBitRate()
    { m_calculateBitRateSignal.emit(); }
 
    sigc::signal<void()> signal_calculateBitRate()
    { return m_calculateBitRateSignal; }
 
    bool IsAutomaticBitRateCalculationAvailable();
 
    bool IsCDRLocked();
 
    const std::string GetBitRateName()
    { return m_bitRateName; }
 
    enum LeCroyEqualizerMode
    {
        LECROY_EQ_NONE,
 
        LECROY_EQ_LOW,
 
        LECROY_EQ_MEDIUM,
 
        LECROY_EQ_HIGH
    };
 
    enum TriggerPosition
    {
        POSITION_END,
 
        POSITION_START
    };
 
    enum Polarity
    {
        POLARITY_NORMAL,
 
        POLARITY_INVERTED
    };
 
    TriggerPosition GetTriggerPosition()
    { return static_cast<TriggerPosition>(m_parameters[m_positionName].GetIntVal()); }
 
    void SetTriggerPosition(TriggerPosition p)
    { m_parameters[m_positionName].SetIntVal(p); }
 
    LeCroyEqualizerMode GetEqualizerMode()
    { return static_cast<LeCroyEqualizerMode>(m_parameters[m_lecroyEqName].GetIntVal()); }
 
    void SetEqualizerMode(LeCroyEqualizerMode mode)
    { m_parameters[m_lecroyEqName].SetIntVal(mode); }
 
    Polarity GetPolarity()
    { return static_cast<Polarity>(m_parameters[m_polarityName].GetIntVal()); }
 
    void SetPolarity(Polarity mode)
    { m_parameters[m_polarityName].SetIntVal(mode); }
 
protected:
 
    std::string m_bitRateName;
 
    std::string m_positionName;
 
    std::string m_lecroyEqName;
 
    std::string m_polarityName;
 
    sigc::signal<void()> m_calculateBitRateSignal;
};
 
#endif