viam::sdk::impl::MovementSensorClient Class Reference

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

#include <movement_sensor_client.hpp>

Inheritance diagram for viam::sdk::impl::MovementSensorClient:

Public Types
using	interface_type = MovementSensor

Public Member Functions
	MovementSensorClient (std::string name, std::shared_ptr< grpc::Channel > channel)
Vector3	get_linear_velocity (const ProtoStruct &extra) override
Vector3	get_angular_velocity (const ProtoStruct &extra) override
compassheading	get_compass_heading (const ProtoStruct &extra) override
orientation	get_orientation (const ProtoStruct &extra) override
position	get_position (const ProtoStruct &extra) override
properties	get_properties (const ProtoStruct &extra) override
std::unordered_map< std::string, float >	get_accuracy (const ProtoStruct &extra) override
Vector3	get_linear_acceleration (const ProtoStruct &extra) override
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 movementsensor.
std::unordered_map< std::string, float >	get_accuracy ()
virtual std::unordered_map< std::string, float >	get_accuracy (const ProtoStruct &extra)=0
Vector3	get_angular_velocity ()
virtual Vector3	get_angular_velocity (const ProtoStruct &extra)=0
compassheading	get_compass_heading ()
virtual compassheading	get_compass_heading (const ProtoStruct &extra)=0
std::vector< GeometryConfig >	get_geometries ()
	Returns GeometryConfigs associated with the calling movementsensor.
virtual std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra)=0
	Returns GeometryConfigs associated with the calling movementsensor.
Vector3	get_linear_acceleration ()
virtual Vector3	get_linear_acceleration (const ProtoStruct &extra)=0
Vector3	get_linear_velocity ()
virtual Vector3	get_linear_velocity (const ProtoStruct &extra)=0
orientation	get_orientation ()
virtual orientation	get_orientation (const ProtoStruct &extra)=0
position	get_position ()
virtual position	get_position (const ProtoStruct &extra)=0
properties	get_properties ()
virtual properties	get_properties (const ProtoStruct &extra)=0
Public Member Functions inherited from viam::sdk::MovementSensor
API	api () const override
	Returns the API associated with a particular resource.
Vector3	get_linear_velocity ()
Vector3	get_angular_velocity ()
compassheading	get_compass_heading ()
orientation	get_orientation ()
position	get_position ()
properties	get_properties ()
std::unordered_map< std::string, float >	get_accuracy ()
Vector3	get_linear_acceleration ()
std::vector< GeometryConfig >	get_geometries ()
	Returns GeometryConfigs associated with the calling movementsensor.
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::MovementSensor
	MovementSensor (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 MovementSensor component.

Member Function Documentation

do_command()

ProtoStruct viam::sdk::impl::MovementSensorClient::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::MovementSensor.

get_accuracy() [1/2]

std::unordered_map< std::string, float > viam::sdk::impl::MovementSensorClient::get_accuracy ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_accuracy() [2/2]

virtual std::unordered_map< std::string, float > viam::sdk::MovementSensor::get_accuracy ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_angular_velocity() [1/2]

Vector3 viam::sdk::impl::MovementSensorClient::get_angular_velocity ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_angular_velocity() [2/2]

virtual Vector3 viam::sdk::MovementSensor::get_angular_velocity ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_compass_heading() [1/2]

compassheading viam::sdk::impl::MovementSensorClient::get_compass_heading ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_compass_heading() [2/2]

virtual compassheading viam::sdk::MovementSensor::get_compass_heading ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_geometries() [1/3]

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

inline

Returns GeometryConfigs associated with the calling movementsensor.

Returns

The requested GeometryConfigs associated with the component.

get_geometries() [2/3]

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

overridevirtual

Returns GeometryConfigs associated with the calling movementsensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implements viam::sdk::MovementSensor.

get_geometries() [3/3]

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

virtual

Returns GeometryConfigs associated with the calling movementsensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implements viam::sdk::MovementSensor.

get_linear_acceleration() [1/2]

Vector3 viam::sdk::impl::MovementSensorClient::get_linear_acceleration ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_linear_acceleration() [2/2]

virtual Vector3 viam::sdk::MovementSensor::get_linear_acceleration ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_linear_velocity() [1/2]

Vector3 viam::sdk::impl::MovementSensorClient::get_linear_velocity ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_linear_velocity() [2/2]

virtual Vector3 viam::sdk::MovementSensor::get_linear_velocity ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_orientation() [1/2]

orientation viam::sdk::impl::MovementSensorClient::get_orientation ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_orientation() [2/2]

virtual orientation viam::sdk::MovementSensor::get_orientation ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_position() [1/2]

position viam::sdk::impl::MovementSensorClient::get_position ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_position() [2/2]

virtual position viam::sdk::MovementSensor::get_position ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

get_properties() [1/2]

properties viam::sdk::impl::MovementSensorClient::get_properties ( const ProtoStruct & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

get_properties() [2/2]

virtual properties viam::sdk::MovementSensor::get_properties ( const ProtoStruct & extra )

virtual

Implements viam::sdk::MovementSensor.

---

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

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