input_item.h

Go to the documentation of this file.

#ifndef INPUT_ITEM_H
#define INPUT_ITEM_H
#include <functional>
#include <map>
#include <sstream>
#include <string>
#include <vector>
 
#include "source_io/module_parameter/parameter.h"
namespace ModuleIO
{
class Input_Item
{
  public:
    Input_Item(){};
 
    Input_Item(const std::string& label_in)
    {
        label = label_in;
    }
 
    Input_Item(const Input_Item& item)
    {
        label = item.label;
        str_values = item.str_values;
        final_value.str(item.final_value.str());
        // Documentation fields
        category = item.category;
        type = item.type;
        description = item.description;
        default_value = item.default_value;
        unit = item.unit;
        availability = item.availability;
        annotation = item.annotation;
        read_value = item.read_value;
        check_value = item.check_value;
        reset_value = item.reset_value;
        get_final_value = item.get_final_value;
    }
 
    std::string label;                   
    std::vector<std::string> str_values; 
    std::stringstream final_value;       
 
    // Documentation fields for built-in help system
    std::string category;      
    std::string type;          
    std::string description;   
    std::string default_value; 
    std::string unit;          
    std::string availability;  
 
    bool is_read() const 
    {
        return !str_values.empty();
    }
 
    size_t get_size() const 
    {
        return str_values.size();
    }
 
    std::string annotation; 
 
    // ====== !!! These functions are complete.        ======
    // ====== !!! Do not add any more functions here.  ======
    std::function<void(const Input_Item&, Parameter&)> read_value = [](const Input_Item& item, Parameter& param) {};
    std::function<void(const Input_Item&, const Parameter&)> check_value = nullptr;
    std::function<void(const Input_Item&, Parameter&)> reset_value = nullptr;
    std::function<void(Input_Item&, const Parameter&)> get_final_value = nullptr;
    // ====== !!! Do not add any more functions here.  ======
};
 
} // namespace ModuleIO
#endif // INPUT_ITEM_H