viam::sdk::MovementSensor Class Reference

#include "components/movement_sensor.hpp"

Inheritance diagram for viam::sdk::MovementSensor:

Classes
struct	compassheading
struct	orientation
	Struct version of viam::common::v1::Orientation. More...
struct	position
struct	properties

Public Member Functions
API	api () const override
	Returns the API associated with a particular resource.
Vector3	get_linear_velocity ()
virtual Vector3	get_linear_velocity (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
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
std::unordered_map< std::string, float >	get_accuracy ()
virtual std::unordered_map< std::string, float >	get_accuracy (const ProtoStruct &extra)=0
Vector3	get_linear_acceleration ()
virtual Vector3	get_linear_acceleration (const ProtoStruct &extra)=0
virtual ProtoStruct	do_command (const ProtoStruct &command)=0
	Send/receive arbitrary commands to the resource.
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.
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.

Protected Member Functions
	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

This acts as an abstract base class to be inherited from by any drivers representing specific movementsensor implementations. This class cannot be used on its own.

Member Function Documentation

api()

API viam::sdk::MovementSensor::api ( ) const

overridevirtual

Returns the API associated with a particular resource.

Implements viam::sdk::Resource.

do_command()

virtual ProtoStruct viam::sdk::MovementSensor::do_command ( const ProtoStruct & command )

pure virtual

Send/receive arbitrary commands to the resource.

Parameters

Command

the command to execute.

Returns

The result of the executed command.

Implemented in viam::sdk::impl::MovementSensorClient.

get_geometries() [1/2]

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/2]

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

pure virtual

Returns GeometryConfigs associated with the calling movementsensor.

Parameters

extra

Any additional arguments to the method.

Returns

The requested GeometryConfigs associated with the component.

Implemented in viam::sdk::impl::MovementSensorClient, and viam::sdk::impl::MovementSensorClient.

---

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

• src/viam/sdk/components/movement_sensor.hpp