Viam C++ SDK current
Loading...
Searching...
No Matches
gantry_client.hpp
Go to the documentation of this file.
1
4#pragma once
5
6#include <viam/api/component/gantry/v1/gantry.grpc.pb.h>
7
9#include <viam/sdk/rpc/dial.hpp>
10
11namespace viam {
12namespace sdk {
13namespace impl {
14
18class GantryClient : public Gantry {
19 public:
20 using interface_type = Gantry;
21 GantryClient(std::string name, const ViamChannel& channel);
22
23 const ViamChannel& channel() const {
24 return *channel_;
25 }
26
27 std::vector<double> get_position(const ProtoStruct& extra) override;
28 void move_to_position(const std::vector<movement_coordinate>& coordinates,
29 const ProtoStruct& extra) override;
30 bool home(const ProtoStruct& extra) override;
31 std::vector<double> get_lengths(const ProtoStruct& extra) override;
32 bool is_moving() override;
33 void stop(const ProtoStruct& extra) override;
34 ProtoStruct do_command(const ProtoStruct& command) override;
35 std::vector<GeometryConfig> get_geometries(const ProtoStruct& extra) override;
36
40 using Gantry::home;
42 using Gantry::stop;
43
44 private:
45 using StubType = viam::component::gantry::v1::GantryService::StubInterface;
46 std::unique_ptr<StubType> stub_;
47 const ViamChannel* channel_;
48};
49
50} // namespace impl
51} // namespace sdk
52} // namespace viam
A Gantry represents a physical gantry and can be used for controlling gantries of N axes.
Definition gantry.hpp:20
std::vector< double > get_position()
Get the positions of the axes of the gantry in millimeters.
Definition gantry.hpp:35
bool home()
Run the homing sequence of the gantry to re-calibrate the axes with respect to the limit switches.
Definition gantry.hpp:62
void move_to_position(const std::vector< movement_coordinate > &coordinates)
Move the axes of the gantry to the desired positions (mm) at the requested speeds (mm/sec).
Definition gantry.hpp:47
std::vector< double > get_lengths()
Get the lengths of the axes of the gantry in millimeters.
Definition gantry.hpp:73
std::vector< GeometryConfig > get_geometries()
Returns GeometryConfigs associated with the calling gantry.
Definition gantry.hpp:90
virtual std::string name() const
Return the resource's name.
void stop()
Stops a resource from running.
Definition stoppable.hpp:16
Definition dial.hpp:25
gRPC client implementation of a Gantry component.
Definition gantry_client.hpp:18
std::vector< GeometryConfig > get_geometries(const ProtoStruct &extra) override
Returns GeometryConfigs associated with the calling gantry.
bool is_moving() override
Reports if the gantry is in motion.
void move_to_position(const std::vector< movement_coordinate > &coordinates, const ProtoStruct &extra) override
Move the axes of the gantry to the desired positions (mm) at the requested speeds (mm/sec).
void stop(const ProtoStruct &extra) override
Stops a resource from running.
bool home(const ProtoStruct &extra) override
Run the homing sequence of the gantry to re-calibrate the axes with respect to the limit switches.
std::vector< double > get_lengths(const ProtoStruct &extra) override
Get the lengths of the axes of the gantry in millimeters.
ProtoStruct do_command(const ProtoStruct &command) override
Send/receive arbitrary commands to the resource.
std::vector< double > get_position(const ProtoStruct &extra) override
Get the positions of the axes of the gantry in millimeters.
Defines a Gantry component.
Definition pose.hpp:20