viam::sdk::GenericService Class Reference

A GenericService represents any service that can execute arbitrary commands. More...

#include "services/generic/generic.hpp"

Inheritance diagram for viam::sdk::GenericService:

Public Member Functions
virtual ProtoStruct	do_command (const ProtoStruct &command)=0
	Send/receive arbitrary commands to the resource.
API	api () const override
	Creates a GenericService API.
Public Member Functions inherited from viam::sdk::Service
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
	GenericService (std::string name)
Protected Member Functions inherited from viam::sdk::Service
	Service (std::string name)
Protected Member Functions inherited from viam::sdk::Resource
Name	get_resource_name (const std::string &type) const

Detailed Description

A GenericService represents any service that can execute arbitrary commands.

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

Member Function Documentation

api()

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

overridevirtual

Creates a GenericService API.

Implements viam::sdk::Resource.

do_command()

virtual ProtoStruct viam::sdk::GenericService::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::GenericServiceClient.

---

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

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