viam::sdk::impl::SensorClient Class Reference

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

#include <sensor_client.hpp>

Inheritance diagram for viam::sdk::impl::SensorClient:

Public Types
using	interface_type = Sensor

Public Member Functions
	SensorClient (std::string name, std::shared_ptr< grpc::Channel > channel)
ProtoStruct	get_readings (const ProtoStruct &extra) override
	Returns the measurements/data specific to this sensor.
ProtoStruct	do_command (const ProtoStruct &command) override
	Send/receive arbitrary commands to the resource.
std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra) override
	Returns GeometryConfigs associated with the calling sensor.
std::vector< GeometryConfig >	get_geometries ()
	Returns GeometryConfigs associated with the calling sensor.
virtual std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra)=0
	Returns GeometryConfigs associated with the calling sensor.
ProtoStruct	get_readings ()
	Returns the measurements/data specific to this sensor.
virtual ProtoStruct	get_readings (const ProtoStruct &extra)=0
	Returns the measurements/data specific to this sensor.
Public Member Functions inherited from viam::sdk::Sensor
API	api () const override
	Returns the API associated with a particular resource.
std::vector< GeometryConfig >	get_geometries ()
	Returns GeometryConfigs associated with the calling sensor.
ProtoStruct	get_readings ()
	Returns the measurements/data specific to this sensor.
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::Sensor
	Sensor (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 Sensor component.

Member Function Documentation

do_command()

ProtoStruct viam::sdk::impl::SensorClient::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::Sensor.

get_geometries() [1/3]

std::vector< GeometryConfig > viam::sdk::Sensor::get_geometries ( )

inline

Returns GeometryConfigs associated with the calling sensor.

Returns

The requested GeometryConfigs associated with the component.

get_geometries() [2/3]

std::vector< GeometryConfig > viam::sdk::impl::SensorClient::get_geometries ( const ProtoStruct & extra )

overridevirtual

Returns GeometryConfigs associated with the calling sensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implements viam::sdk::Sensor.

get_geometries() [3/3]

virtual std::vector< GeometryConfig > viam::sdk::Sensor::get_geometries ( const ProtoStruct & extra )

virtual

Returns GeometryConfigs associated with the calling sensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implements viam::sdk::Sensor.

get_readings() [1/3]

ProtoStruct viam::sdk::Sensor::get_readings ( )

inline

Returns the measurements/data specific to this sensor.

Returns

The requested measurements/data specific to this sensor.

get_readings() [2/3]

ProtoStruct viam::sdk::impl::SensorClient::get_readings ( const ProtoStruct & extra )

overridevirtual

Returns the measurements/data specific to this sensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested measurements/data specific to this sensor.

Implements viam::sdk::Sensor.

get_readings() [3/3]

virtual ProtoStruct viam::sdk::Sensor::get_readings ( const ProtoStruct & extra )

virtual

Returns the measurements/data specific to this sensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested measurements/data specific to this sensor.

Implements viam::sdk::Sensor.

---

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

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