can_control_function.hpp

Go to the documentation of this file.

//================================================================================================
//================================================================================================
 
#ifndef CAN_CONTROL_FUNCTION_HPP
#define CAN_CONTROL_FUNCTION_HPP
 
#include "isobus/isobus/can_NAME.hpp"
#include "isobus/utility/thread_synchronization.hpp"
 
#include <memory>
#include <string>
 
namespace isobus
{
    //================================================================================================
    //================================================================================================
    class ControlFunction : public std::enable_shared_from_this<ControlFunction>
    {
    public:
        enum class Type
        {
            Internal, 
            External, 
            Partnered 
        };
 
        virtual ~ControlFunction() = default;
 
        static std::shared_ptr<ControlFunction> create(NAME NAMEValue, std::uint8_t addressValue, std::uint8_t CANPort);
 
        virtual bool destroy(std::uint32_t expectedRefCount = 1);
 
        std::uint8_t get_address() const;
 
        bool get_address_valid() const;
 
        std::uint8_t get_can_port() const;
 
        NAME get_NAME() const;
 
        Type get_type() const;
 
        std::string get_type_string() const;
 
    protected:
        ControlFunction(NAME NAMEValue, std::uint8_t addressValue, std::uint8_t CANPort, Type type = Type::External);
 
        friend class CANNetworkManager; 
        static Mutex controlFunctionProcessingMutex; 
        const Type controlFunctionType; 
        NAME controlFunctionNAME; 
        bool claimedAddressSinceLastAddressClaimRequest = false; 
        std::uint8_t address; 
        const std::uint8_t canPortIndex; 
    };
 
} // namespace isobus
 
#endif // CAN_CONTROL_FUNCTION_HPP