Viam C++ SDK current
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | Friends | List of all members
viam::sdk::API Class Reference

Extends APIType to additionally define a resource's subtype (e.g., camera). More...

#include <resource_api.hpp>

+ Inheritance diagram for viam::sdk::API:

Classes

struct  traits
 
struct  traits< Arm >
 
struct  traits< Base >
 
struct  traits< Board >
 
struct  traits< Camera >
 
struct  traits< Encoder >
 
struct  traits< Gantry >
 
struct  traits< GenericComponent >
 
struct  traits< GenericService >
 
struct  traits< Gizmo >
 
struct  traits< Gripper >
 
struct  traits< MLModelService >
 
struct  traits< Motion >
 
struct  traits< Motor >
 
struct  traits< MovementSensor >
 
struct  traits< Navigation >
 
struct  traits< PoseTracker >
 
struct  traits< PowerSensor >
 
struct  traits< Resource >
 
struct  traits< Sensor >
 
struct  traits< Servo >
 
struct  traits< Summation >
 

Public Member Functions

virtual std::string to_string () const override
 
 API (std::string namespace_, std::string resource_type, std::string resource_subtype)
 
 API (APIType type, std::string resource_subtype)
 
const std::string & resource_subtype () const
 
void set_resource_subtype (const std::string &subtype)
 
bool is_component_type ()
 
bool is_service_type ()
 
- Public Member Functions inherited from viam::sdk::APIType
 APIType (std::string namespace_, std::string resource_type)
 
const std::string & type_namespace () const
 
const std::string & resource_type () const
 
void set_namespace (const std::string &type_namespace)
 
void set_resource_type (const std::string &resource_type)
 

Static Public Member Functions

static API from_string (std::string api)
 
template<typename T >
static API get ()
 

Friends

bool operator== (API const &lhs, API const &rhs)
 
bool operator< (const API &lhs, const API &rhs)
 
std::ostream & operator<< (std::ostream &os, const API &v)
 

Detailed Description

Extends APIType to additionally define a resource's subtype (e.g., camera).

Member Function Documentation

◆ to_string()

virtual std::string viam::sdk::API::to_string ( ) const
overridevirtual

Reimplemented from viam::sdk::APIType.


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