viam::sdk::GenericComponent Class Reference

A GenericComponent represents any component that can execute arbitrary commands. More...

#include "components/generic.hpp"

Inheritance diagram for viam::sdk::GenericComponent:

Public Member Functions
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 camera.
virtual std::vector< GeometryConfig >	get_geometries (const ProtoStruct &extra)=0
API	api () const override
	Creates a GenericComponent API.
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
	GenericComponent (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

A GenericComponent represents any component that can execute arbitrary commands.

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

Member Function Documentation

api()

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

overridevirtual

Creates a GenericComponent API.

Implements viam::sdk::Resource.

do_command()

virtual ProtoStruct viam::sdk::GenericComponent::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::GenericComponentClient.

get_geometries()

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

inline

Returns GeometryConfigs associated with the calling camera.

Returns

The requested GeometryConfigs associated with the component.

---

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

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