Standard Operation Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetAngle (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_angle_info_type_t type, float64_t inAngle)
	Sets various angle properties on a D/S module for a specified channel. Use nai_ds_angle_info_type_t to select the specified angle properties to be written to the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetAngle (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_angle_info_type_t type, float64_t *outAngle)
	Gets various angle properties on a D/S module from a specified channel. Use nai_ds_angle_info_type_t to select the specified angle properties to be read from the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetChanOutputEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t inOutputEnable)
	Sets the output on/off for a specified channel for D/S module. Currently, this function only supports single channel Gen 3 D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetChanOutputEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outOutputEnable)
	Gets the output on/off for a specified channel for D/S module. Currently, this function only supports single channel D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetPowerEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t inPwrEnable)
	Sets the module power state on/off for a specified channel of the D/S module. Currently, only the three channels modules allow power state control for their individual channels. Single and dual channels modules only allow power to their channels be all on or off.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetPowerEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outPowerEnable)
	Gets the module power state on/off for a specified channel of the D/S module. Currently, only the three channels modules allow power state control for their individual channels. Single and dual channels modules only allow power to their channels be all on or off.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetMeasuredValue (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_measured_Info_type_t type, float64_t *outMeasValue)
	Gets internally measured values from the D/S module for their specified channels. Internally measured vlues; such as, angle, reference, output line-to-line voltages, and reference frequency.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetAllWrapAngles (int32_t cardIndex, int32_t module, int32_t arraySize, float64_t *outAngle[])
	Gets all internally measured angles from the D/S module. Use this function for single speed operations only.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_status_type_t type, nai_ds_module_status_t *outStatus)
	Gets the module status for a specific channel from the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_status_type_t type)
	Clears latched status for a specific D/S channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetRotationStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_rotation_status_t *outStatus)
	Gets the latch rotation status for a specific channel from the D/S module. For Gen5 D/S module, to unlatch a latched channel, write a one to the bit mask value for the specified channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetRealTimeRotationStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ds_rotation_status_t *outStatus)
	Gets the real time rotation status for a specific channel from the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_SetRotationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t inRotEnable)
	Sets the start or stop rotation command for a specified channel in the D/S module.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_DS_GetRotationEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outRotEnable)
	Gets the start or stop rotation command for a specified channel in the D/S module.

Detailed Description

Function Documentation

naibrd_DS_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_ClearStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_status_type_t	type )

Clears latched status for a specific D/S 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]).
type	: (Input) Angle Type: refer to nai_ds_status_type_t definitions.

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_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_GetAllWrapAngles()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetAllWrapAngles	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	arraySize,
		float64_t *	outAngle[] )

Gets all internally measured angles from the D/S module. Use this function for single speed operations only.

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]).
arraySize	: (Input) The number of channel requested.
outAngle	: (Output) Internally measured angles reported from the D/S 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_INVALID_SIZE when arraySize is greater than max channel allowed by the module.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_GetAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetAngle	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_angle_info_type_t	type,
		float64_t *	outAngle )

Gets various angle properties on a D/S module from a specified channel. Use nai_ds_angle_info_type_t to select the specified angle properties to be read from the D/S module.

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]).
type	: (Input) Angle Type: refer to nai_ds_angle_info_type_t definitions.
outAngle	: (Output) float64_t: Returns angle values in degree from a specified channel of D/S 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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_GetChanOutputEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanOutputEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outOutputEnable )

Gets the output on/off for a specified channel for D/S module. Currently, this function only supports single channel D/S module.

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]).
outOutputEnable	: (Output) bool_t: Read 1(TRUE) or 0(FALSE) from the channel output register.

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_DS_GetMeasuredValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetMeasuredValue	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_measured_Info_type_t	type,
		float64_t *	outMeasValue )

Gets internally measured values from the D/S module for their specified channels. Internally measured vlues; such as, angle, reference, output line-to-line voltages, and reference frequency.

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]).
type	: (Input) Angle Type: refer to nai_ds_measured_Info_type_t definitions.
outMeasValue	: (Output) Internally measured values for a specified channel from the D/S 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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_GetPowerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetPowerEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outPowerEnable )

Gets the module power state on/off for a specified channel of the D/S module. Currently, only the three channels modules allow power state control for their individual channels. Single and dual channels modules only allow power to their channels be all on or off.

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]).
outPowerEnable	: (Output) bool_t: 0(FALSE) = Module power off, 1(TRUE) = Module power on.

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_DS_GetRealTimeRotationStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRealTimeRotationStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_rotation_status_t *	outStatus )

Gets the real time rotation status for a specific channel from the D/S module.

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]).
outStatus	: (Output) nai_ds_rotation_status_t: Return D/S channel rotation status (0=rotating, 1=not rotating).

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_DS_GetRotationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t *	outRotEnable )

Gets the start or stop rotation command for a specified channel in the D/S module.

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]).
outRotEnable	: (Output) bool_t: Returns the current rotation start/stop state of a specified channel from the D/S 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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_GetRotationStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_rotation_status_t *	outStatus )

Gets the latch rotation status for a specific channel from the D/S module. For Gen5 D/S module, to unlatch a latched channel, write a one to the bit mask value 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]).
outStatus	: (Output) nai_ds_rotation_status_t: Return D/S channel rotation status (0=rotating, 1=not rotating).

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_DS_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_status_type_t	type,
		nai_ds_module_status_t *	outStatus )

Gets the module status for a specific channel from the D/S module.

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]).
type	: (Input) Angle Type: refer to nai_ds_status_type_t definitions.
outStatus	: (Output) nai_ds_module_status_t: Return module status (0=good, 1=bad).

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_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_SetAngle()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetAngle	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		nai_ds_angle_info_type_t	type,
		float64_t	inAngle )

Sets various angle properties on a D/S module for a specified channel. Use nai_ds_angle_info_type_t to select the specified angle properties to be written to the D/S module.

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]).
type	: (Input) Angle Type: refer to nai_ds_angle_info_type_t definitions.
inAngle	: (Input) float64_t: Value used to set various angle properties for a specified channel of D/S 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_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
• NAI_ERROR_INVALID_RANGE when inAngle parameter is out of range.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_SetChanOutputEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetChanOutputEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	inOutputEnable )

Sets the output on/off for a specified channel for D/S module. Currently, this function only supports single channel Gen 3 D/S module.

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]).
inOutputEnable	: (Input) bool_t: Write 1(TRUE) or 0(FALSE) to the chan output register.

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_INVALID_VALUE when invalid inOutputEnable parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_SetPowerEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetPowerEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	inPwrEnable )

Sets the module power state on/off for a specified channel of the D/S module. Currently, only the three channels modules allow power state control for their individual channels. Single and dual channels modules only allow power to their channels be all on or off.

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]).
inPwrEnable	: (Input) bool_t: Write 1(TRUE) or 0(FALSE) to the D/S module channel power register.

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_INVALID_VALUE when invalid inPwrEnable parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_DS_SetRotationEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRotationEnable	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		bool_t	inRotEnable )

Sets the start or stop rotation command for a specified channel in the D/S module.

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]).
inRotEnable	: (Input) bool_t: Write 1(Strat) or 0(Stop) to the channel rotation register.

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_INVALID_VALUE when inRotEnable is greater than 1.
• 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.