viam::sdk::impl::SwitchClient Class Reference

gRPC client implementation of a Switch component. More...

#include <switch_client.hpp>

Inheritance diagram for viam::sdk::impl::SwitchClient:

Public Types
using	interface_type = Switch

Public Member Functions
	SwitchClient (std::string name, const ViamChannel &channel)
const ViamChannel &	channel () const
void	set_position (uint32_t position, const ProtoStruct &extra) override
	Set the position of the switch.
uint32_t	get_position (const ProtoStruct &extra) override
	Get the current position of the switch.
Switch::position_info	get_number_of_positions (const ProtoStruct &extra) override
	Get the position_info supported by this switch.
ProtoStruct	do_command (const ProtoStruct &command) override
	Send/receive arbitrary commands to the resource.
ProtoStruct	get_status () override
	Get the status of the switch.
position_info	get_number_of_positions ()
	Get the position_info supported by this switch.
virtual position_info	get_number_of_positions (const ProtoStruct &extra)=0
	Get the position_info supported by this switch.
uint32_t	get_position ()
	Get the current position of the switch.
virtual uint32_t	get_position (const ProtoStruct &extra)=0
	Get the current position of the switch.
void	set_position (uint32_t position)
	Set the position of the switch.
virtual void	set_position (uint32_t position, const ProtoStruct &extra)=0
	Set the position of the switch.
Public Member Functions inherited from viam::sdk::Switch
void	set_position (uint32_t position)
	Set the position of the switch.
uint32_t	get_position ()
	Get the current position of the switch.
position_info	get_number_of_positions ()
	Get the position_info supported by this switch.
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)
	Resource (const ResourceConfig &cfg)
	Construct from a resource config. Use this overload to ensure Viam App log filtering works immediately during object construction.
virtual std::string	name () const
	Return the resource's name.
void	set_log_level (log_level) const
	Set the log level for log messages originating from this Resource.

Additional Inherited Members
Protected Member Functions inherited from viam::sdk::Switch
	Switch (std::string name)
	Switch (const ResourceConfig &cfg)
Protected Member Functions inherited from viam::sdk::Component
	Component (std::string name)
	Component (const ResourceConfig &cfg)
Protected Member Functions inherited from viam::sdk::Resource
Name	get_resource_name (const std::string &type) const
Protected Attributes inherited from viam::sdk::Resource
LogSource	logger_

Detailed Description

gRPC client implementation of a Switch component.

Member Function Documentation

do_command()

ProtoStruct viam::sdk::impl::SwitchClient::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::Switch.

get_number_of_positions() [1/3]

position_info viam::sdk::Switch::get_number_of_positions ( )

inline

Get the position_info supported by this switch.

Returns

The number of positions that the switch supports, and their labels.

get_number_of_positions() [2/3]

Switch::position_info viam::sdk::impl::SwitchClient::get_number_of_positions ( const ProtoStruct & extra )

overridevirtual

Get the position_info supported by this switch.

Parameters

extra

Any additional arguments to the method.

Returns

The number of positions that the switch supports, and their labels.

Implements viam::sdk::Switch.

get_number_of_positions() [3/3]

virtual position_info viam::sdk::Switch::get_number_of_positions ( const ProtoStruct & extra )

virtual

Get the position_info supported by this switch.

Parameters

extra

Any additional arguments to the method.

Returns

The number of positions that the switch supports, and their labels.

Implements viam::sdk::Switch.

get_position() [1/3]

uint32_t viam::sdk::Switch::get_position ( )

inline

Get the current position of the switch.

Returns

The current position of the switch.

get_position() [2/3]

uint32_t viam::sdk::impl::SwitchClient::get_position ( const ProtoStruct & extra )

overridevirtual

Get the current position of the switch.

Parameters

extra

Any additional arguments to the method.

Returns

The current position of the switch.

Implements viam::sdk::Switch.

get_position() [3/3]

virtual uint32_t viam::sdk::Switch::get_position ( const ProtoStruct & extra )

virtual

Get the current position of the switch.

Parameters

extra

Any additional arguments to the method.

Returns

The current position of the switch.

Implements viam::sdk::Switch.

get_status()

ProtoStruct viam::sdk::impl::SwitchClient::get_status ( )

overridevirtual

Get the status of the switch.

Returns

A ProtoStruct containing the status of the switch.

Implements viam::sdk::Switch.

set_position() [1/3]

void viam::sdk::Switch::set_position ( uint32_t position )

inline

Set the position of the switch.

Parameters

position

The position to set the switch to.

set_position() [2/3]

void viam::sdk::impl::SwitchClient::set_position ( uint32_t position, const ProtoStruct & extra )

overridevirtual

Set the position of the switch.

Parameters

position	The position to set the switch to.
extra	Any additional arguments to the method.

Implements viam::sdk::Switch.

set_position() [3/3]

virtual void viam::sdk::Switch::set_position ( uint32_t position, const ProtoStruct & extra )

virtual

Set the position of the switch.

Parameters

position	The position to set the switch to.
extra	Any additional arguments to the method.

Implements viam::sdk::Switch.

---

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

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