HEBI C++ API  3.5.1
hebi::Info::IoBank Class Referencefinal

A message field for interfacing with a bank of I/O pins. More...

#include <info.hpp>

Public Member Functions

bool hasLabel (size_t pinNumber) const
 True if (and only if) the particular numbered pin in this bank has a string label set in this message. More...
 
std::string getLabel (size_t pinNumber) const
 If this numbered pin in this bank has a string label value, returns that value; otherwise returns an empty string. More...
 

Detailed Description

A message field for interfacing with a bank of I/O pins.

Member Function Documentation

◆ hasLabel()

bool hebi::Info::IoBank::hasLabel ( size_t  pinNumber) const

True if (and only if) the particular numbered pin in this bank has a string label set in this message.

Parameters
pinNumberWhich pin to set; valid values for pinNumber depend on the bank.

◆ getLabel()

std::string hebi::Info::IoBank::getLabel ( size_t  pinNumber) const

If this numbered pin in this bank has a string label value, returns that value; otherwise returns an empty string.

Parameters
pinNumberWhich pin to get; valid values for pinNumber depend on the bank.

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