Viam C++ SDK current
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Protected Member Functions | List of all members
viam::sdk::impl::GenericComponentClient Class Reference

gRPC client implementation of a GenericComponent. More...

#include <generic_client.hpp>

+ Inheritance diagram for viam::sdk::impl::GenericComponentClient:

Public Types

using interface_type = GenericComponent
 

Public Member Functions

 GenericComponentClient (std::string name, std::shared_ptr< grpc::Channel > channel)
 
ProtoStruct do_command (const ProtoStruct &command) override
 Send/receive arbitrary commands to the resource.
 
std::vector< GeometryConfigget_geometries (const ProtoStruct &extra) override
 
- Public Member Functions inherited from viam::sdk::GenericComponent
std::vector< GeometryConfigget_geometries ()
 Returns GeometryConfigs associated with the calling camera.
 
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

 GenericComponentClient (std::string name, std::unique_ptr< viam::component::generic::v1::GenericService::StubInterface > stub)
 
- Protected Member Functions inherited from viam::sdk::GenericComponent
 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

gRPC client implementation of a GenericComponent.

Member Function Documentation

◆ do_command()

ProtoStruct viam::sdk::impl::GenericComponentClient::do_command ( const ProtoStruct & command)
overridevirtual

Send/receive arbitrary commands to the resource.

Parameters
commandthe command to execute.
Returns
The result of the executed command.

Implements viam::sdk::GenericComponent.

◆ get_geometries()

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

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