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 AttributeMap &extra) override

Vector3	get_angular_velocity (const AttributeMap &extra) override

compassheading	get_compass_heading (const AttributeMap &extra) override

orientation	get_orientation (const AttributeMap &extra) override

position	get_position (const AttributeMap &extra) override

properties	get_properties (const AttributeMap &extra) override

std::unordered_map< std::string, float >	get_accuracy (const AttributeMap &extra) override

Vector3	get_linear_acceleration (const AttributeMap &extra) override

AttributeMap	do_command (const AttributeMap &command) override
	Send/receive arbitrary commands to the resource.

std::vector< GeometryConfig >	get_geometries (const AttributeMap &extra) override
	Returns `GeometryConfig`s associated with the calling movementsensor.

std::unordered_map< std::string, float >	get_accuracy ()

virtual std::unordered_map< std::string, float >	get_accuracy (const AttributeMap &extra)=0

Vector3	get_angular_velocity ()

virtual Vector3	get_angular_velocity (const AttributeMap &extra)=0

compassheading	get_compass_heading ()

virtual compassheading	get_compass_heading (const AttributeMap &extra)=0

std::vector< GeometryConfig >	get_geometries ()
	Returns `GeometryConfig`s associated with the calling movementsensor.

virtual std::vector< GeometryConfig >	get_geometries (const AttributeMap &extra)=0
	Returns `GeometryConfig`s associated with the calling movementsensor.

Vector3	get_linear_acceleration ()

virtual Vector3	get_linear_acceleration (const AttributeMap &extra)=0

Vector3	get_linear_velocity ()

virtual Vector3	get_linear_velocity (const AttributeMap &extra)=0

orientation	get_orientation ()

virtual orientation	get_orientation (const AttributeMap &extra)=0

position	get_position ()

virtual position	get_position (const AttributeMap &extra)=0

properties	get_properties ()

virtual properties	get_properties (const AttributeMap &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 `GeometryConfig`s associated with the calling movementsensor.

Public Member Functions inherited from viam::sdk::Component
viam::common::v1::ResourceName	get_resource_name (std::string name) const override
	Returns a `ResourceName` for a particular resource name.

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
Static Public Member Functions inherited from viam::sdk::MovementSensor
static compassheading	from_proto (const viam::component::movementsensor::v1::GetCompassHeadingResponse &proto)
	Creates a `compassheading` struct from its proto representation.

static position	from_proto (const viam::component::movementsensor::v1::GetPositionResponse &proto)
	Creates a `position` struct from its proto representation.

static orientation	from_proto (const viam::common::v1::Orientation &proto)
	Creates an `orientation` struct from its proto representation.

static properties	from_proto (const viam::component::movementsensor::v1::GetPropertiesResponse &proto)
	Creates a `properties` struct from its proto representation.

static viam::component::movementsensor::v1::GetCompassHeadingResponse	to_proto (const compassheading &compassheading)
	Converts a `compassheading` struct to its proto representation.

static viam::component::movementsensor::v1::GetPositionResponse	to_proto (const position &position)
	Converts a `position` struct to its proto representation.

static viam::common::v1::Orientation	to_proto (const orientation &orientation)
	Converts an `orientation` struct to its proto representation.

static viam::component::movementsensor::v1::GetPropertiesResponse	to_proto (const properties &properties)
	Converts a `properties` struct to its proto representation.

Protected Member Functions inherited from viam::sdk::MovementSensor
	MovementSensor (std::string name)

Protected Member Functions inherited from viam::sdk::Component
	Component (std::string name)

Detailed Description

gRPC client implementation of a MovementSensor component.

Member Function Documentation

◆ do_command()

AttributeMap viam::sdk::impl::MovementSensorClient::do_command ( const AttributeMap & 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 AttributeMap & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_accuracy() [2/2]

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

virtual

Implements viam::sdk::MovementSensor.

◆ get_angular_velocity() [1/2]

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

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_angular_velocity() [2/2]

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

virtual

Implements viam::sdk::MovementSensor.

◆ get_compass_heading() [1/2]

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

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_compass_heading() [2/2]

virtual compassheading viam::sdk::MovementSensor::get_compass_heading ( const AttributeMap & 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 AttributeMap & 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 AttributeMap & 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 AttributeMap & extra )

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_linear_acceleration() [2/2]

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

virtual

Implements viam::sdk::MovementSensor.

◆ get_linear_velocity() [1/2]

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

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_linear_velocity() [2/2]

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

virtual

Implements viam::sdk::MovementSensor.

◆ get_orientation() [1/2]

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

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_orientation() [2/2]

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

virtual

Implements viam::sdk::MovementSensor.

◆ get_position() [1/2]

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

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_position() [2/2]

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

virtual

Implements viam::sdk::MovementSensor.

◆ get_properties() [1/2]

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

overridevirtual

Implements viam::sdk::MovementSensor.

◆ get_properties() [2/2]

virtual properties viam::sdk::MovementSensor::get_properties ( const AttributeMap & 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

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ do_command()

◆ get_accuracy() [1/2]

◆ get_accuracy() [2/2]

◆ get_angular_velocity() [1/2]

◆ get_angular_velocity() [2/2]

◆ get_compass_heading() [1/2]

◆ get_compass_heading() [2/2]

◆ get_geometries() [1/3]

◆ get_geometries() [2/3]

◆ get_geometries() [3/3]

◆ get_linear_acceleration() [1/2]

◆ get_linear_acceleration() [2/2]

◆ get_linear_velocity() [1/2]

◆ get_linear_velocity() [2/2]

◆ get_orientation() [1/2]

◆ get_orientation() [2/2]

◆ get_position() [1/2]

◆ get_position() [2/2]

◆ get_properties() [1/2]

◆ get_properties() [2/2]