entry.h

/*
 * Copyright (c) 2015, Thomas Keh
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 *    2. 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.
 *
 *    3. Neither the name of the copyright holder nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * 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.
 */
 
#pragma once

#include <cstdint>
#include <string>
#include <vector>
#include <functional>
#include <mutex>
#include <memory>

#include "types.h"
#include "value.h"
#include "access_method.h"

namespace kaco {

    class Entry {

    public:

        using ValueChangedCallback = std::function< void(const Value& value) >;

        Entry();

        Entry(const uint16_t _index, const uint8_t _subindex, const std::string& _name, const Type _type, const AccessType _access_type);

        Entry(const Entry& other) = delete;

        Entry(Entry&& other) = default;

        Entry& operator=(const Entry& other) = delete;

        Entry& operator=(Entry&& other) = default;

        void set_value(const Value& value);

        const Value& get_value() const;

        bool valid() const;

        Type get_type() const;

        void add_value_changed_callback(ValueChangedCallback callback);

        void print() const;

        bool operator<(const Entry& other) const;

        uint16_t index;

        uint8_t subindex; // only used if is_array==false

        std::string name;

        Type type;

        AccessType access_type;

        ReadAccessMethod read_access_method = ReadAccessMethod::sdo;

        WriteAccessMethod write_access_method = WriteAccessMethod::sdo;
        
        bool disabled;

        // maybe supported in future:
        //bool is_slice;
        //uint8_t slice_first_bit;
        //uint8_t slice_last_bit;

        // TODO: Add fields for default, max and min value, pdo mapping boolean, object flags, and object type.
        // TODO: Maybe the array functionality is obsolete when using EDS files...

        bool is_generic = false;

    private:

        Value m_value;
        bool m_valid = false;
        Value m_dummy_value;

        std::vector<ValueChangedCallback> m_value_changed_callbacks;
        std::unique_ptr<std::mutex> m_value_changed_callbacks_mutex;

        std::unique_ptr<std::recursive_mutex> m_read_write_mutex; // recursive_mutex because of valid() used by get_entry(), on heap because mutexes aren't movable.


    };

} // end namespace kaco