irio::TerminalsIO Class Reference
Class managing all terminals related to the cRIO IO functionality. More...
#include <terminalsIO.h>
Inheritance diagram for irio::TerminalsIO:
Public Member Functions | |
| TerminalsIO (ParserManager *parserManager, const NiFpga_Session &session, const Platform &platform) | |
| Manages finding the related IO terminals. More... | |
| void | setSamplingRateDecimation (const std::uint32_t &n, const std::uint16_t dec) const |
| Configures the sampling rate for a specific cRIO module. More... | |
| std::uint16_t | getSamplingRateDecimation (const std::uint32_t &n) const |
| Returns the decimation of a sampling rate specific to a module. More... | |
| size_t | getNumIOSamplingRate () const |
| Returns number of IO Sampling Rate terminals found. 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 cRIO IO functionality.
Definition at line 13 of file terminalsIO.h.
Constructor & Destructor Documentation
◆ TerminalsIO()
| irio::TerminalsIO::TerminalsIO | ( | ParserManager * | parserManager, |
| const NiFpga_Session & | session, | ||
| const Platform & | platform | ||
| ) |
Manages finding the related IO terminals.
- 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
◆ getNumIOSamplingRate()
| size_t irio::TerminalsIO::getNumIOSamplingRate | ( | ) | const |
Returns number of IO Sampling Rate terminals found.
- Returns
- Number of IO Sampling Rate terminals found
◆ getSamplingRateDecimation()
| std::uint16_t irio::TerminalsIO::getSamplingRateDecimation | ( | const std::uint32_t & | n | ) | const |
Returns the decimation of a sampling rate specific to a module.
The sampling rate configured can be calculated as Fref/decimation
- Exceptions
-
irio::errors::ResourceNotFoundError Resource specified not found irio::errors::NiFpgaError Error occurred in an FPGA operation
- Parameters
-
n Number of cRIO module
- Returns
- Decimation used in the specified module
◆ setSamplingRateDecimation()
| void irio::TerminalsIO::setSamplingRateDecimation | ( | const std::uint32_t & | n, |
| const std::uint16_t | dec | ||
| ) | const |
Configures the sampling rate for a specific cRIO module.
The sampling rate is configured by a decimation factor. The sampling rate configured is calculated as Fref/decimation
- Exceptions
-
irio::errors::ResourceNotFoundError Resource specified not found irio::errors::NiFpgaError Error occurred in an FPGA operation
- Parameters
-
n Number of cRIO module dec Decimation to apply to the Fref
The documentation for this class was generated from the following file:
