CARMA C++
carma::canbus::DeviceNames Class Reference

Completely static class to retrieve string names of CAN devices based on API Id. More...

#include <carma/canbus/DeviceNames.h>

Static Public Member Functions

static std::string getName (carma::canbus::apiType api)
 Get the Device name for an input API Id. More...
 
static bool isRegistered (carma::canbus::apiType api)
 Check to see if a device has been registered with a specific api. More...
 

Detailed Description

Completely static class to retrieve string names of CAN devices based on API Id.

This class cannot be instantiated.

Definition at line 27 of file DeviceNames.h.

Member Function Documentation

static std::string carma::canbus::DeviceNames::getName ( carma::canbus::apiType  api)
static

Get the Device name for an input API Id.

If a device name doesn't exist for an input API id, the string "Unknown" is output. Use DeviceNames::isRegistered to check first.

Parameters
apiAPI Id of device.
static bool carma::canbus::DeviceNames::isRegistered ( carma::canbus::apiType  api)
static

Check to see if a device has been registered with a specific api.


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