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

Defines the namespace_, family, and name for a particular resource model. More...

#include <resource_api.hpp>

Public Member Functions

std::string to_string () const
 
 Model (std::string namespace_, std::string family, std::string model_name)
 
 Model (ModelFamily model, std::string model_name)
 

Static Public Member Functions

static Model from_str (std::string model)
 Parses a single model string into a Model, using default values for namespace and family if not provided.
 

Friends

bool operator== (const Model &lhs, const Model &rhs)
 

Detailed Description

Defines the namespace_, family, and name for a particular resource model.

Member Function Documentation

◆ from_str()

static Model viam::sdk::Model::from_str ( std::string model)
static

Parses a single model string into a Model, using default values for namespace and family if not provided.

Exceptions
`Exception`if given an invalid model (i.e., one with non-word characters).

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