TRConfigParam.h

Go to the documentation of this file.

/* This file is part of the Transient Recorder Framework.
 * It is subject to the license terms in the LICENSE.txt file found in the
 * top-level directory of this distribution and at
 * https://confluence.slac.stanford.edu/display/ppareg/LICENSE.html. No part
 * of the Transient Recorder Framework, including this file, may be copied,
 * modified, propagated, or distributed except according to the terms
 * contained in the LICENSE.txt file.
 */

#ifndef TRANSREC_CONFIG_PARAM_H
#define TRANSREC_CONFIG_PARAM_H

#include <epicsAssert.h>

#include <asynPortDriver.h>

#include "TRNonCopyable.h"
#include "TRConfigParamTraits.h"

class TRBaseDriver;

#ifndef DOXYGEN_SHOULD_SKIP_THIS

class TRConfigParamBase
{
    friend class TRBaseDriver;
    
private:
    virtual void setSnapshotToDesired () = 0;
    virtual void setEffectiveToSnapshot () = 0;
    virtual void setEffectiveToInvalid () = 0;
};

#endif

template <typename ValueType, typename EffectiveValueType = ValueType>
class TRConfigParam :
    private TRConfigParamBase,
    private TRNonCopyable
{
    friend class TRBaseDriver;
    
    typedef TRConfigParamTraits<ValueType> Traits;
    typedef TRConfigParamTraits<EffectiveValueType> EffectiveTraits;

private:
    bool m_initialized;
    bool m_internal;
    bool m_irrelevant;
    int m_desired_param;
    int m_effective_param;
    ValueType m_snapshot_value;
    EffectiveValueType m_invalid_value;
    TRBaseDriver *m_driver;
    
public:
    inline TRConfigParam ()
    : m_initialized(false)
    {
    }
    
    inline ValueType getSnapshot ()
    {
        assert(m_initialized);
        
        return m_snapshot_value;
    }
    
    inline ValueType getSnapshotFast ()
    {
        return m_snapshot_value;
    }
    
    inline void setIrrelevant ()
    {
        assert(m_initialized);
        
        m_irrelevant = true;
    }
    
    inline void setSnapshot (ValueType value)
    {
        assert(m_initialized);
        
        m_snapshot_value = value;
    }
    
    ValueType getDesired ();
    
    void setDesired (ValueType value);
    
    inline int desiredParamIndex ()
    {
        assert(m_initialized);
        
        return m_desired_param;
    }
    
private:
    void init (TRBaseDriver *driver, char const *base_name, EffectiveValueType invalid_value, bool internal);
    void setEffectiveParam (EffectiveValueType value);
    
private:
    // Implementations of TRConfigParamBase virtual functions
    void setSnapshotToDesired ();
    void setEffectiveToSnapshot ();
    void setEffectiveToInvalid ();
};

#endif