Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_GetFIFOEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ttl_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
	Retrieves the channel's FIFO Buffer Status.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_GetFIFOEventMappedStatusRaw (int32_t cardIndex, int32_t module, int32_t channel, nai_status_access_type_t accessType, naibrd_ttl_event_mapped_category_type_t categoryType, uint32_t *p_outstatusRaw)
	Retrieves the channel's FIFO Buffer Status value.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_ClearFIFO (int32_t cardIndex, int32_t module, int32_t channel)
	Clears the FIFO Data for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_GetFIFOCount (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount)
	Retrieves the number of elements in FIFO for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_ReadFIFO (int32_t cardIndex, int32_t module, int32_t channel, int32_t count, int32_t timeout, uint32_t outdata[], int32_t p_outcount, int32_t p_outcountRemaining)
	Retrieves the data elements from the channel's FIFO buffer.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_SetTimebaseInterval (int32_t cardIndex, int32_t module, int32_t channel, float64_t interval)
	Sets the timebase for frequency measurements for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_GetTimebaseInterval (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outinterval)
	Retrieves the timebase for frequency measurements for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_ClearCountData (int32_t cardIndex, int32_t module, int32_t channel)
	Clears the measurement count data for the specified channel.

NAIBRDFUNC nai_status_t NAIAPI	naibrd_TTL_GetCountData (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outcount)
	Retrieves the measurement count data for the specified channel.

Detailed Description

Function Documentation

◆ naibrd_TTL_ClearCountData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearCountData	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

Clears the measurement count data for the specified channel.

   Measurement count data applies to the following nai_ttl_enhanced_mode_t modes:
         NAI_TTL_MODE_COUNT_RISING_EDGES          - Rising Edges Total Count
         NAI_TTL_MODE_COUNT_FALLING_EDGES         - Falling Edges Total Count
         NAI_TTL_MODE_COUNT_ALL_EDGES             - All Edges Total Count

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module])

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_ClearFIFO()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ClearFIFO	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel )

Clears the FIFO Data for the specified channel.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module])

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetCountData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetCountData	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		int32_t *	p_outcount )

Retrieves the measurement count data for the specified channel.

   Measurement count data applies to the following nai_ttl_enhanced_mode_t modes:
         NAI_TTL_MODE_COUNT_RISING_EDGES          - Rising Edges Total Count
         NAI_TTL_MODE_COUNT_FALLING_EDGES         - Falling Edges Total Count
         NAI_TTL_MODE_COUNT_ALL_EDGES             - All Edges Total Count

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outcount	: (Output) Measurement count value.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetFIFOCount	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		int32_t *	p_outcount )

Retrieves the number of elements in FIFO for the specified channel.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outcount	: (Output) number of elements in channel FIFO .

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetFIFOEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetFIFOEventMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_ttl_event_mapped_status_type_t	statusType,
		nai_status_bit_t *	p_outstatusBit )

Retrieves the channel's FIFO Buffer Status.

   FIFO Buffer status applies to the following nai_ttl_enhanced_mode_t modes where the FIFO is used to store
   the measurements:
         NAI_TTL_MODE_MEASURE_HIGH_TIME           - High Time Measurement
         NAI_TTL_MODE_MEASURE_LOW_TIME            - Low Time Measurement
         NAI_TTL_MODE_TIMESTAMP_RISING_EDGES      - Rising Edges Timestamps
         NAI_TTL_MODE_TIMESTAMP_FALLING_EDGES     - Falling Edges Timestamps
         NAI_TTL_MODE_TIMESTAMP_ALL_EDGES         - All Edges Timestamps
         NAI_TTL_MODE_MEASURE_FREQUENCY           - Frequency Measurement

  FIFO Status Type Definition:
  ------------------------------
   NAIBRD_TTL_EVENT_STATUS_FIFO_BTWN_ALMOST_EMPTY_FULL_REALTIME
   NAIBRD_TTL_EVENT_STATUS_FIFO_FULL_REALTIME,
   NAIBRD_TTL_EVENT_STATUS_FIFO_ALMOST_FULL_REALTIME,
   NAIBRD_TTL_EVENT_STATUS_FIFO_ALMOST_EMPTY_REALTIME,
   NAIBRD_TTL_EVENT_STATUS_FIFO_EMPTY_REALTIME,

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
statusType	: (Input) Status Type: refer to naibrd_ttl_event_mapped_status_type_t definition.
p_outstatusBit	: (Output) FIFO Buffer Status.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetFIFOEventMappedStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetFIFOEventMappedStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_status_access_type_t	accessType,
		naibrd_ttl_event_mapped_category_type_t	categoryType,
		uint32_t *	p_outstatusRaw )

Retrieves the channel's FIFO Buffer Status value.

   FIFO Buffer status applies to the following nai_ttl_enhanced_mode_t modes where the FIFO is used to store
   the measurements:
         NAI_TTL_MODE_MEASURE_HIGH_TIME           - High Time Measurement
         NAI_TTL_MODE_MEASURE_LOW_TIME            - Low Time Measurement
         NAI_TTL_MODE_TIMESTAMP_RISING_EDGES      - Rising Edges Timestamps
         NAI_TTL_MODE_TIMESTAMP_FALLING_EDGES     - Falling Edges Timestamps
         NAI_TTL_MODE_TIMESTAMP_ALL_EDGES         - All Edges Timestamps
         NAI_TTL_MODE_MEASURE_FREQUENCY           - Frequency Measurement

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
accessType	: (Input) Status Type: refer to nai_status_access_type_t definition. This function only accepts NAI_STATUS_REALTIME
categoryType	: (Input) Status Type: refer to naibrd_ttl_event_mapped_category_type_t definition.
p_outstatusRaw	: (Output) FIFO Buffer Status. This Value can be bit masked using naibrd_ttl_event_mapped_status_mask_t

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_GetTimebaseInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_GetTimebaseInterval	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t *	p_outinterval )

Retrieves the timebase for frequency measurements for the specified channel.

Note

: TTL does not yet support floating point mode

   Timebase for frequency measurement applies to the following nai_ttl_enhanced_mode_t mode:
         NAI_TTL_MODE_MEASURE_FREQUENCY           - Frequency Measurement

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outinterval	: (Output) Timebase interval specified in milliseconds, increments of 0.000008 ms (8ns). (Range 0.000008 to 34359.73836 milliseconds) (0x1 to 0xFFFFFFFF at 0.000008 ms LSB)

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter.
NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_ReadFIFO()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_ReadFIFO	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		int32_t	count,
		int32_t	timeout,
		uint32_t	outdata[],
		int32_t *	p_outcount,
		int32_t *	p_outcountRemaining )

Retrieves the data elements from the channel's FIFO buffer.

FIFO Buffer applies to the following nai_ttl_enhanced_mode_t modes where the FIFO is used to store
the measurements:
NAI_TTL_MODE_MEASURE_HIGH_TIME           - High Time Measurement
NAI_TTL_MODE_MEASURE_LOW_TIME            - Low Time Measurement
NAI_TTL_MODE_TIMESTAMP_RISING_EDGES      - Rising Edges Timestamps
NAI_TTL_MODE_TIMESTAMP_FALLING_EDGES     - Falling Edges Timestamps
NAI_TTL_MODE_TIMESTAMP_ALL_EDGES         - All Edges Timestamps
NAI_TTL_MODE_MEASURE_FREQUENCY           - Frequency Measurement

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
count	: (Input) Number of data elements to retrieve.
timeout	: (Input) The amount of time, in milliseconds, to wait for the FIFO's count to reach count before timing out.
outdata	: (Output) Array of 32-bit raw data.
p_outcount	:(Output) Number of data elements read from the channel's FIFO buffer.
p_outcountRemaining	: (Output) The number of elements remaining in the FIFO.

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_TTL_SetTimebaseInterval()

NAIBRDFUNC nai_status_t NAIAPI naibrd_TTL_SetTimebaseInterval	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		float64_t	interval )

Sets the timebase for frequency measurements for the specified channel.

Note

: TTL does not yet support floating point mode

   Timebase for frequency measurement applies to the following nai_ttl_enhanced_mode_t mode:
         NAI_TTL_MODE_MEASURE_FREQUENCY           - Frequency Measurement

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
interval	: (Input) Timebase interval specified in milliseconds, increments of 0.000008 ms (8ns). (Range 0.000008 to 34359.73836 milliseconds) (0x1 to 0xFFFFFFFF at 0.000008 ms LSB)

Returns

NAI_SUCCESS
NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
NAI_ERROR_NOT_OPEN when handle to board is invalid.
NAI_ERROR_INVALID_CHANNEL when invalid channel parameter.
NAI_ERROR_INVALID_VALUE when invalid format type parameter is specified.
NAI_ERROR_NOT_SUPPORTED when function is not supported.

Functions

Detailed Description

Function Documentation

◆ naibrd_TTL_ClearCountData()

◆ naibrd_TTL_ClearFIFO()

◆ naibrd_TTL_GetCountData()

◆ naibrd_TTL_GetFIFOCount()

◆ naibrd_TTL_GetFIFOEventMappedStatus()

◆ naibrd_TTL_GetFIFOEventMappedStatusRaw()

◆ naibrd_TTL_GetTimebaseInterval()

◆ naibrd_TTL_ReadFIFO()

◆ naibrd_TTL_SetTimebaseInterval()