switch.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <cstdint>
 
#include <string>
 
#include <viam/sdk/common/proto_value.hpp>
#include <viam/sdk/components/component.hpp>
#include <viam/sdk/resource/resource_api.hpp>
 
namespace viam {
namespace sdk {
 
 
class Switch : public Component {
   public:
    struct position_info {
        uint32_t num_positions;
        std::vector<std::string> position_labels;
    };
 
    inline void set_position(uint32_t position) {
        set_position(position, {});
    }
 
    virtual void set_position(uint32_t position, const ProtoStruct& extra) = 0;
 
    inline uint32_t get_position() {
        return get_position({});
    }
 
    virtual uint32_t get_position(const ProtoStruct& extra) = 0;
 
    inline position_info get_number_of_positions() {
        return get_number_of_positions({});
    }
 
    virtual position_info get_number_of_positions(const ProtoStruct& extra) = 0;
 
    virtual ProtoStruct do_command(const ProtoStruct& command) = 0;
 
    API api() const override;
 
   protected:
    explicit Switch(std::string name);
};
 
template <>
struct API::traits<Switch> {
    static API api();
};
 
}  // namespace sdk
}  // namespace viam