viam::sdk::impl::ButtonClient Class Reference

gRPC client implementation of a Button component More...

#include <button_client.hpp>

Inheritance diagram for viam::sdk::impl::ButtonClient:

Public Types
using	interface_type = Button

Public Member Functions
	ButtonClient (std::string name, std::shared_ptr< grpc::Channel > channel)
void	push (const ProtoStruct &extra) override
	Push the button.
ProtoStruct	do_command (const ProtoStruct &command) override
	Send/receive arbitrary commands to the resource.
void	push ()
	Push the button.
virtual void	push (const ProtoStruct &extra)=0
	Push the button.
Public Member Functions inherited from viam::sdk::Button
void	push ()
	Push the button.
API	api () const override
	Returns the API associated with a particular resource.
Public Member Functions inherited from viam::sdk::Component
Name	get_resource_name () const override
	Returns the Name for a particular resource.
Public Member Functions inherited from viam::sdk::Resource
	Resource (std::string name)
virtual std::string	name () const
	Return the resource's name.

Additional Inherited Members
Protected Member Functions inherited from viam::sdk::Button
	Button (std::string name)
Protected Member Functions inherited from viam::sdk::Component
	Component (std::string name)
Protected Member Functions inherited from viam::sdk::Resource
Name	get_resource_name (const std::string &type) const

Detailed Description

gRPC client implementation of a Button component

Member Function Documentation

do_command()

ProtoStruct viam::sdk::impl::ButtonClient::do_command ( const ProtoStruct & command )

overridevirtual

Send/receive arbitrary commands to the resource.

Parameters

Command

the command to execute.

Returns

The result of the executed command.

Implements viam::sdk::Button.

push() [1/2]

void viam::sdk::impl::ButtonClient::push ( const ProtoStruct & extra )

overridevirtual

Push the button.

Parameters

extra

Any additional arguments to the method.

Implements viam::sdk::Button.

push() [2/2]

virtual void viam::sdk::Button::push ( const ProtoStruct & extra )

virtual

Push the button.

Parameters

extra

Any additional arguments to the method.

Implements viam::sdk::Button.

---

The documentation for this class was generated from the following file:

• src/viam/sdk/components/private/button_client.hpp