irio::TerminalsAuxAnalog Class Reference
Class managing all terminals related to the auxiliary analog functionality of the RIO device. More...
#include <terminalsAuxAnalog.h>
Inheritance diagram for irio::TerminalsAuxAnalog:
Public Member Functions | |
| TerminalsAuxAnalog (ParserManager *parserManager, const NiFpga_Session &session, const Platform &platform) | |
| Manages finding the related auxiliary analog terminals in the parsed bitfile and reading their values from the FPGA if required. More... | |
| std::int32_t | getAuxAI (const std::uint32_t n) const |
| Returns the value of an auxAI terminal. More... | |
| std::int32_t | getAuxAO (const std::uint32_t n) const |
| Returns the value of an auxAO terminal. More... | |
| size_t | getNumAuxAI () const |
| Returns number of auxAI terminals found. More... | |
| size_t | getNumAuxAO () const |
| Returns number of auxAO terminals found. More... | |
| void | setAuxAO (const std::uint32_t n, const std::int32_t value) const |
| Writes to a specific auxAO terminal a value. More... | |
| std::int64_t | getAuxAI64 (const std::uint32_t n) const |
| Returns the value of an auxAI64 terminal. More... | |
| std::int64_t | getAuxAO64 (const std::uint32_t n) const |
| Returns the value of an auxAO64 terminal. More... | |
| size_t | getNumAuxAI64 () const |
| Returns number of auxAI64 terminals found. More... | |
| size_t | getNumAuxAO64 () const |
| Returns number of auxAO64 terminals found. More... | |
| void | setAuxAO64 (const std::uint32_t n, const std::int64_t value) const |
| Writes to a specific auxAO64 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 analog functionality of the RIO device.
Definition at line 13 of file terminalsAuxAnalog.h.
Constructor & Destructor Documentation
◆ TerminalsAuxAnalog()
| irio::TerminalsAuxAnalog::TerminalsAuxAnalog | ( | ParserManager * | parserManager, |
| const NiFpga_Session & | session, | ||
| const Platform & | platform | ||
| ) |
Manages finding the related auxiliary analog 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
◆ getAuxAI()
| std::int32_t irio::TerminalsAuxAnalog::getAuxAI | ( | const std::uint32_t | n | ) | const |
Returns the value of an auxAI terminal.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxAI terminal to read
- Returns
- Value read from the auxAI terminal
◆ getAuxAI64()
| std::int64_t irio::TerminalsAuxAnalog::getAuxAI64 | ( | const std::uint32_t | n | ) | const |
Returns the value of an auxAI64 terminal.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxAI64 terminal to read
- Returns
- Value read from the auxAI64 terminal
◆ getAuxAO()
| std::int32_t irio::TerminalsAuxAnalog::getAuxAO | ( | const std::uint32_t | n | ) | const |
Returns the value of an auxAO terminal.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxAO terminal to read
- Returns
- Value read from the auxAO terminal
◆ getAuxAO64()
| std::int64_t irio::TerminalsAuxAnalog::getAuxAO64 | ( | const std::uint32_t | n | ) | const |
Returns the value of an auxAO64 terminal.
- Exceptions
-
irio::errors::NiFpgaError Error occurred in an FPGA operation irio::errors::ResourceNotFoundError Resource specified not found
- Parameters
-
n Number of the auxAO64 terminal to read
- Returns
- Value read from the auxAO64 terminal
◆ getNumAuxAI()
| size_t irio::TerminalsAuxAnalog::getNumAuxAI | ( | ) | const |
Returns number of auxAI terminals found.
- Returns
- Number of auxAI terminals found
◆ getNumAuxAI64()
| size_t irio::TerminalsAuxAnalog::getNumAuxAI64 | ( | ) | const |
Returns number of auxAI64 terminals found.
- Returns
- Number of auxAI64 terminals found
◆ getNumAuxAO()
| size_t irio::TerminalsAuxAnalog::getNumAuxAO | ( | ) | const |
Returns number of auxAO terminals found.
- Returns
- Number of auxAO terminals found
◆ getNumAuxAO64()
| size_t irio::TerminalsAuxAnalog::getNumAuxAO64 | ( | ) | const |
Returns number of auxAO64 terminals found.
- Returns
- Number of auxAO64 terminals found
◆ setAuxAO()
| void irio::TerminalsAuxAnalog::setAuxAO | ( | const std::uint32_t | n, |
| const std::int32_t | value | ||
| ) | const |
Writes to a specific auxAO 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 auxAO terminal to write value Value to write to the terminal
◆ setAuxAO64()
| void irio::TerminalsAuxAnalog::setAuxAO64 | ( | const std::uint32_t | n, |
| const std::int64_t | value | ||
| ) | const |
Writes to a specific auxAO64 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 auxAO64 terminal to write value Value to write to the terminal
The documentation for this class was generated from the following file:
