Status Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_FG_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_fg_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
	Gets the mapped status for a specified function generator channel and status type.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_FG_GetStatusRaw (int32_t cardIndex, int32_t module, naibrd_fg_chan_mapped_status_type_t type, uint32_t *outrawdata)
	Retrieves the raw status data value in the register associated to the group and status type specified.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_FG_ClearStatusRaw (int32_t cardIndex, int32_t module, naibrd_fg_chan_mapped_status_type_t type, uint32_t rawdata)
	Clears the status data value in the register associated to the group and status type specified.

Detailed Description

Function Documentation

naibrd_FG_ClearStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_ClearStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		naibrd_fg_chan_mapped_status_type_t	type,
		uint32_t	rawdata )

Clears the status data value in the register associated to the group and status type specified.

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]).
type	: (Input) Status Type: refer to naibrd_fg_chan_mapped_status_type_t definition.
rawdata	: (Input) Raw Data Code.

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_VALUE when invalid status register type is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_FG_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_fg_chan_mapped_status_type_t	statusType,
		nai_status_bit_t *	p_outstatusBit )

Gets the mapped status for a specified function generator channel and status type.

Parameters

cardIndex	: (Input) Logical Card Index assigned to the 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 of the channel mapped status to get (see naibrd_fg_chan_mapped_status_type_t).
p_outstatusBit	: (Output) Pointer to a variable that will hold the returned status bit value.

Returns

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

naibrd_FG_GetStatusRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_FG_GetStatusRaw	(	int32_t	cardIndex,
		int32_t	module,
		naibrd_fg_chan_mapped_status_type_t	type,
		uint32_t *	outrawdata )

Retrieves the raw status data value in the register associated to the group and status type specified.

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]).
type	: (Input) Status Type: refer to naibrd_fg_chan_mapped_status_type_t definition.
outrawdata	: (Output) Raw Data Code.

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_VALUE when invalid status register type is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.