Public Member Functions | Private Attributes | List of all members
hebi::Feedback::IoBank Class Referencefinal

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

#include <feedback.hpp>

Public Member Functions

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...
 
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...
 
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...
 
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...
 
 IoBank (const HebiFeedbackRef &internal, HebiFeedbackIoPinBank bank)
 

Private Attributes

HebiFeedbackIoPinBank const bank_
 
const HebiFeedbackRefinternal_
 

Detailed Description

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

Definition at line 372 of file feedback.hpp.

Constructor & Destructor Documentation

◆ IoBank()

hebi::Feedback::IoBank::IoBank ( const HebiFeedbackRef internal,
HebiFeedbackIoPinBank  bank 
)

Definition at line 114 of file feedback.cpp.

Member Function Documentation

◆ getFloat()

float hebi::Feedback::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.

Definition at line 130 of file feedback.cpp.

◆ getInt()

int64_t hebi::Feedback::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.

Definition at line 124 of file feedback.cpp.

◆ hasFloat()

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

Definition at line 120 of file feedback.cpp.

◆ hasInt()

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

Definition at line 116 of file feedback.cpp.

Member Data Documentation

◆ bank_

HebiFeedbackIoPinBank const hebi::Feedback::IoBank::bank_
private

Definition at line 406 of file feedback.hpp.

◆ internal_

const HebiFeedbackRef& hebi::Feedback::IoBank::internal_
private

Definition at line 405 of file feedback.hpp.


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


hebi_cpp_api_ros
Author(s): Chris Bollinger , Matthew Tesch
autogenerated on Mon Feb 28 2022 22:27:34