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

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

#include <command.hpp>

Public Member Functions

void clear (size_t pinNumber)
 Removes any currently set value for this pin. 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...
 
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 (HebiCommandRef &internal, HebiCommandIoPinBank bank)
 
void setFloat (size_t pinNumber, float value)
 Sets the particular pin to a floating point value (representing a PWM output). More...
 
void setInt (size_t pinNumber, int64_t value)
 Sets the particular pin to a integer value (representing a digital output). More...
 

Private Attributes

HebiCommandIoPinBank const bank_
 
HebiCommandRefinternal_
 

Detailed Description

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

Definition at line 346 of file command.hpp.

Constructor & Destructor Documentation

hebi::Command::IoBank::IoBank ( HebiCommandRef internal,
HebiCommandIoPinBank  bank 
)

Definition at line 148 of file command.cpp.

Member Function Documentation

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.

Definition at line 178 of file command.cpp.

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.

Definition at line 164 of file command.cpp.

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.

Definition at line 158 of file command.cpp.

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.

Definition at line 154 of file command.cpp.

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.

Definition at line 150 of file command.cpp.

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.

Definition at line 174 of file command.cpp.

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.

Definition at line 170 of file command.cpp.

Member Data Documentation

HebiCommandIoPinBank const hebi::Command::IoBank::bank_
private

Definition at line 397 of file command.hpp.

HebiCommandRef& hebi::Command::IoBank::internal_
private

Definition at line 396 of file command.hpp.


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


hebi_cpp_api_ros
Author(s): Chris Bollinger , Matthew Tesch
autogenerated on Thu May 28 2020 03:14:45