HEBI C++ API  3.7.0
hebi::Command::IoBank Class Referencefinal

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

#include <command.hpp>

Public Member Functions

bool hasInt (size_t pinNumber) const
 True if (and only if) the particular numbered pin in this bank has an integer (e.g., digital) value. More...
 
bool hasFloat (size_t pinNumber) const
 True if (and only if) the particular numbered pin in this bank has an floating point (e.g., analog or PWM) value. More...
 
int64_t getInt (size_t pinNumber) const
 If this numbered pin in this bank has an integer (e.g., digital) value, returns that value; otherwise returns a default. More...
 
float getFloat (size_t pinNumber) const
 If this numbered pin in this bank has an floating point (e.g., analog or PWM) value, returns that value; otherwise returns a default. More...
 
void setInt (size_t pinNumber, int64_t value)
 Sets the particular pin to a integer value (representing a digital output). More...
 
void setFloat (size_t pinNumber, float value)
 Sets the particular pin to a floating point value (representing a PWM output). More...
 
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...
 
void setLabel (size_t pinNumber, const std::string &)
 Sets the string label for a particular pin. More...
 
void clear (size_t pinNumber)
 Removes any currently set value for this pin. More...
 

Detailed Description

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

Member Function Documentation

◆ hasInt()

bool hebi::Command::IoBank::hasInt ( size_t  pinNumber) const

True if (and only if) the particular numbered pin in this bank has an integer (e.g., digital) value.

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

◆ hasFloat()

bool hebi::Command::IoBank::hasFloat ( size_t  pinNumber) const

True if (and only if) the particular numbered pin in this bank has an floating point (e.g., analog or PWM) value.

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

◆ getInt()

int64_t hebi::Command::IoBank::getInt ( size_t  pinNumber) const

If this numbered pin in this bank has an integer (e.g., digital) value, returns that value; otherwise returns a default.

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

◆ getFloat()

float hebi::Command::IoBank::getFloat ( size_t  pinNumber) const

If this numbered pin in this bank has an floating point (e.g., analog or PWM) value, returns that value; otherwise returns a default.

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

◆ setInt()

void hebi::Command::IoBank::setInt ( size_t  pinNumber,
int64_t  value 
)

Sets the particular pin to a integer value (representing a digital output).

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

◆ setFloat()

void hebi::Command::IoBank::setFloat ( size_t  pinNumber,
float  value 
)

Sets the particular pin to a floating point value (representing a PWM output).

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

◆ hasLabel()

bool hebi::Command::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::Command::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.

◆ setLabel()

void hebi::Command::IoBank::setLabel ( size_t  pinNumber,
const std::string &  label 
)

Sets the string label for a particular pin.

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

◆ clear()

void hebi::Command::IoBank::clear ( size_t  pinNumber)

Removes any currently set value for this pin.

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

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