irio::TerminalsCommon Class Reference

Class managing terminals common to all profiles. More...

#include <terminalsCommon.h>

Inheritance diagram for irio::TerminalsCommon:

Public Member Functions
	TerminalsCommon (ParserManager *parserManager, const NiFpga_Session &session)
	Manages finding the related common terminals. More...
std::string	getFPGAVIversion () const
	Returns the parsed TERMINAL_FPGAVIVERSION read from the FPGA. More...
std::uint32_t	getFref () const
	Returns the reference clock of the FPGA for sampling rate. More...
bool	getInitDone () const
	Reads the TERMINAL_INITDONE terminal from the FPGA and return its value. More...
std::uint8_t	getDevQualityStatus () const
	Reads the TERMINAL_DEVQUALITYSTATUS terminal. More...
std::int16_t	getDevTemp () const
	Reads the TERMINAL_DEVTEMP terminal. More...
bool	getDAQStartStop () const
	Reads the TERMINAL_DAQSTARTSTOP terminal. More...
bool	getDebugMode () const
	Reads the TERMINAL_DEBUGMODE terminal. More...
void	setDAQStart () const
	Starts the data acquisition. More...
void	setDAQStop () const
	Stops the data acquisition. More...
void	setDAQStartStop (const bool &start) const
	Allows starting or stopping the data acquisition. More...
void	setDebugMode (const bool &debug) const
	Enables or disables the debug mode. More...
double	getMinSamplingRate () const
	Returns the minimum valid value for the FPGA sampling rate. More...
double	getMaxSamplingRate () const
	Returns the maximum valid value for the FPGA sampling rate. 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 terminals common to all profiles.

Definition at line 14 of file terminalsCommon.h.

Constructor & Destructor Documentation

TerminalsCommon()

irio::TerminalsCommon::TerminalsCommon	(	ParserManager *	parserManager,
		const NiFpga_Session &	session
	)

Manages finding the related common terminals.

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Parameters

parserManager	Pointer to class managing parsing the bitfile and finding its resources
session	NiFpga_Session to be used in NiFpga related functions

Member Function Documentation

getDAQStartStop()

bool irio::TerminalsCommon::getDAQStartStop

(

)

const

Reads the TERMINAL_DAQSTARTSTOP terminal.

Its value indicates whether the data acquisition is running or not

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Returns

True if data acquisition is running, false otherwise

getDebugMode()

bool irio::TerminalsCommon::getDebugMode

(

)

const

Reads the TERMINAL_DEBUGMODE terminal.

Its value indicates whether the acquired data is simulated or not

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Returns

True if data acquired is simulated, false otherwise

getDevQualityStatus()

std::uint8_t irio::TerminalsCommon::getDevQualityStatus

(

)

const

Reads the TERMINAL_DEVQUALITYSTATUS terminal.

Its value indicates the status of the acquisition.

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Returns

Status of the acquisition

getDevTemp()

std::int16_t irio::TerminalsCommon::getDevTemp

(

)

const

Reads the TERMINAL_DEVTEMP terminal.

Its value indicates the temperature of the FPGA

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Returns

Temperature of the FPGA

getFPGAVIversion()

std::string irio::TerminalsCommon::getFPGAVIversion

(

)

const

Returns the parsed TERMINAL_FPGAVIVERSION read from the FPGA.

Returns

String with the FPGAVIversion as (M.m). First element is the major version, second the minor version

getFref()

std::uint32_t irio::TerminalsCommon::getFref

(

)

const

Returns the reference clock of the FPGA for sampling rate.

Its value is specified by the terminal TERMINAL_INITDONE

Returns

Reference clock of the FPGA for sampling rate

getInitDone()

bool irio::TerminalsCommon::getInitDone

(

)

const

Reads the TERMINAL_INITDONE terminal from the FPGA and return its value.

This indicates if the FPGA has been initialized.

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Returns

InitDone value. True if FPAG initialized, false otherwise

getMaxSamplingRate()

double irio::TerminalsCommon::getMaxSamplingRate

(

)

const

Returns the maximum valid value for the FPGA sampling rate.

Returns

Maximum valid sampling rate

getMinSamplingRate()

double irio::TerminalsCommon::getMinSamplingRate

(

)

const

Returns the minimum valid value for the FPGA sampling rate.

Returns

Minimum valid sampling rate

setDAQStart()

void irio::TerminalsCommon::setDAQStart

(

)

const

Starts the data acquisition.

Writes true to TERMINAL_DAQSTARTSTOP

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

setDAQStartStop()

void irio::TerminalsCommon::setDAQStartStop

(

const bool &

start

)

const

Allows starting or stopping the data acquisition.

Writes to TERMINAL_DAQSTARTSTOP

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Parameters

start

True to start, false to stop

setDAQStop()

void irio::TerminalsCommon::setDAQStop

(

)

const

Stops the data acquisition.

Writes false to TERMINAL_DAQSTARTSTOP

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

setDebugMode()

void irio::TerminalsCommon::setDebugMode

(

const bool &

debug

)

const

Enables or disables the debug mode.

Writes to TERMINAL_DEBUGMODE

Exceptions

irio::errors::NiFpgaError

Error occurred in an FPGA operation

Parameters

debug

---

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

• terminalsCommon.h