irio::TerminalsAuxDigital Class Reference
Class managing all terminals related to the auxiliary digital functionality of the RIO device. More...
#include <terminalsAuxDigital.h>
Inheritance diagram for irio::TerminalsAuxDigital:
Public Member Functions | |
| TerminalsAuxDigital (ParserManager *parserManager, const NiFpga_Session &session, const Platform &platform) | |
| Manages finding the related auxiliary digital terminals in the parsed bitfile and reading their values from the FPGA if required. More... | |
| bool | getAuxDI (const std::uint32_t n) const |
| Returns the value of an auxDI terminal. More... | |
| bool | getAuxDO (const std::uint32_t n) const |
| Returns the value of an auxDO terminal. More... | |
| size_t | getNumAuxDI () const |
| Returns number of auxDI terminals found. More... | |
| size_t | getNumAuxDO () const |
| Returns number of auxDO terminals found. More... | |
| void | setAuxDO (const std::uint32_t n, const bool value) const |
| Writes to a specific auxDO terminal a value. More... | |
 Public Member Functions inherited from irio::TerminalsBase | |
| TerminalsBase (std::shared_ptr< TerminalsBaseImpl > impl) | |
| Base class used for terminals. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from irio::TerminalsBase | |
| std::shared_ptr< TerminalsBaseImpl > | m_impl |
| Smart pointer with the terminal implementation. | |
Detailed Description
Class managing all terminals related to the auxiliary digital functionality of the RIO device.
Definition at line 12 of file terminalsAuxDigital.h.
Constructor & Destructor Documentation
◆ TerminalsAuxDigital()
| irio::TerminalsAuxDigital::TerminalsAuxDigital | ( | ParserManager * | parserManager, |
| const NiFpga_Session & | session, | ||
| const Platform & | platform | ||
| ) |
Manages finding the related auxiliary digital terminals in the parsed bitfile and reading their values from the FPGA if required.
- Parameters
-
parserManager Pointer to class managing parsing the bitfile and finding its resources session NiFpga_Session to be used in NiFpga related functions. platform Platform that is using the terminals. Used to know the maximum number of terminals that can be found.
Member Function Documentation
◆ getAuxDI()
| bool irio::TerminalsAuxDigital::getAuxDI | ( | const std::uint32_t | n | ) | const |
Returns the value of an auxDI terminal.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxDI terminal to read
- Returns
- Value read from the auxDI terminal
◆ getAuxDO()
| bool irio::TerminalsAuxDigital::getAuxDO | ( | const std::uint32_t | n | ) | const |
Returns the value of an auxDO terminal.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxDO terminal to read
- Returns
- Value read from the auxDO terminal
◆ getNumAuxDI()
| size_t irio::TerminalsAuxDigital::getNumAuxDI | ( | ) | const |
Returns number of auxDI terminals found.
- Returns
- Number of auxDI terminals found
◆ getNumAuxDO()
| size_t irio::TerminalsAuxDigital::getNumAuxDO | ( | ) | const |
Returns number of auxDO terminals found.
- Returns
- Number of auxDO terminals found
◆ setAuxDO()
| void irio::TerminalsAuxDigital::setAuxDO | ( | const std::uint32_t | n, |
| const bool | value | ||
| ) | const |
Writes to a specific auxDO terminal a value.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxDO terminal to write value Value to write to the terminal
The documentation for this class was generated from the following file:
