parameter.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_DATATASK_PARAMETER_HPP
#define RTCTK_DATATASK_PARAMETER_HPP
 
#include <string>
#include <stdexcept>
#include "rtctk/componentFramework/exceptions.hpp"
 
namespace rtctk::dataTask {
class ParameterNotSet : public rtctk::componentFramework::RtctkException
{
  public:
    ParameterNotSet(const std::string& par_name)
    : rtctk::componentFramework::RtctkException("Parameter '" + par_name + "' not set!") {}
};
 
class ParameterNotWriteable : public rtctk::componentFramework::RtctkException
{
  public:
    ParameterNotWriteable(const std::string& par_name)
    : rtctk::componentFramework::RtctkException("Parameter '" + par_name + "' not writeable!") {}
};
 
//TODO can we do some value range checking with traits as well here?
template<class T>
class Parameter
{
public:
 
    Parameter(std::string const& name)
        : m_name(name)
        , m_value()
        , m_is_set(false)
        , m_is_locked(false)
    { }
 
    Parameter(std::string const& name, T const& value)
        : m_name(name)
        , m_value(value)
        , m_is_set(true)
        , m_is_locked(false)
    { }
 
    void Set(T const& value)
    {
        if(m_is_locked) {
            CII_THROW(ParameterNotWriteable, m_name);
        }
        m_value = value;
        m_is_set = true;
    }
 
    void Lock() {
        m_is_locked = true;
    }
 
    void Unlock() {
        m_is_locked = false;
    }
 
 
    T& Get()
    {
        if(not m_is_set) {
            CII_THROW(ParameterNotSet, m_name);
        }
        return m_value;
    }
 
    bool IsSet() {
        return m_is_set;
    }
 
    void CheckSet() {
        if(not m_is_set) {
            CII_THROW(ParameterNotSet, m_name);
        }
    }
 
private:
    const std::string m_name; //< name of paramter
    T m_value;                //< value
    bool m_is_set;            //< bool is the value set
    bool m_is_locked;         //< bool is the value locked.
};
 
} // namespace
 
#endif