Software Library API naibrd 1.62
See all documentation at naii.docs.com
Configuration Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetConfigurationValue (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_configuration_type_t opMode, float64_t opValue)
 Sets various configuration values on a DLV module for a specified channel. use nai_dl_configuration_type_t to select the specified configuration type to be written to the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetConfigurationValue (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_configuration_type_t opMode, float64_t *opValue)
 Gets various configuration values on a DLV module for a specified channel. use nai_dl_configuration_type_t to select the specified configuration type to be read from the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Retrieves the enabled/disabled state the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetWireMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_wire_mode_type_t mode)
 Sets the wire mode (4-wire or 2-wire) for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetWireMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_wire_mode_type_t *outmode)
 Retrieves the wire mode (4-wire or 2-wire) for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetOutputMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_vll_mode_type_t mode)
 Sets the output mode (ratio mode or fixed mode) for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetOutputMode (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_vll_mode_type_t *outmode)
 Retrieves the output mode (ratio mode or fixed mode) for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetFloatingPointAttributes (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_floating_point_attributes_type_t attrType, float64_t attrValue)
 Sets the floating-point attribute value of the specified attribute type for the specified DLV channel. Valid attribute types are Position A Offset, Position B Offset, Position A Scale, and Position B Scale.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetFloatingPointAttributes (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_floating_point_attributes_type_t attrType, float64_t *outAttrValue)
 Retrieves the floating-point attribute value of the specified attribute type for the specified DLV channel. Valid attribute types are Position A Offset, Position B Offset, Position A Scale, and Position B Scale.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetPowerSupplyState (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_on_off_t setting)
 Sets the Power Supply State for the specified DLV channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetPowerSupplyState (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_on_off_t *outSetting)
 Gets the Power Supply State for the specified DLV channel.
 

Detailed Description


Function Documentation

◆ naibrd_DL_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outenable )

Retrieves the enabled/disabled state 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]).
outenable: (Output) 0 if the channel is disabled or 1 if the channel is enabled.
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_DL_GetConfigurationValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetConfigurationValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_configuration_type_t opMode,
float64_t * opValue )

Gets various configuration values on a DLV module for a specified channel. use nai_dl_configuration_type_t to select the specified configuration type to be read from the DLV 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]).
opMode: (Input) Configuration type: refer to nnai_dl_configuration_type_t definitions.
opValue: (Output) float64_t*: Value received from the module.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetFloatingPointAttributes()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetFloatingPointAttributes ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_floating_point_attributes_type_t attrType,
float64_t * outAttrValue )

Retrieves the floating-point attribute value of the specified attribute type for the specified DLV channel. Valid attribute types are Position A Offset, Position B Offset, Position A Scale, and Position B Scale.

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]).
attrType: (Input) Floating-Point Attribute Type: refer to nai_dl_floating_point_attributes_type_t definition.
outAttrValue: (Output) Floating-Point Attribute Value read from 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 attrType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetOutputMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetOutputMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_vll_mode_type_t * outmode )

Retrieves the output mode (ratio mode or fixed mode) 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]).
outmode: (Output) 0 for ratio mode or 1 for fixed mode.
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_DL_GetPowerSupplyState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetPowerSupplyState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_on_off_t * outSetting )

Gets the Power Supply State for the specified DLV 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]).
outSetting: (Output) DL_OFF or DL_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_DL_GetWireMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetWireMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_wire_mode_type_t * outmode )

Retrieves the wire mode (4-wire or 2-wire) 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]).
outmode: (Output) 1 for 4-wire mode or 2 for 2-wire mode.
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_DL_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables/disables 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]).
enable: (Input) 0 to disable or 1 to enable channel.
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 enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetConfigurationValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetConfigurationValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_configuration_type_t opMode,
float64_t opValue )

Sets various configuration values on a DLV module for a specified channel. use nai_dl_configuration_type_t to select the specified configuration type to be written to the DLV 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]).
opMode: (Input) Configuration type: refer to nai_dl_configuration_type_t definitions.
opValue: (Input) float64_t: Value used to set various configuration types for a specified channel of DLV module.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_RANGE when invalid range parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetFloatingPointAttributes()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetFloatingPointAttributes ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_floating_point_attributes_type_t attrType,
float64_t attrValue )

Sets the floating-point attribute value of the specified attribute type for the specified DLV channel. Valid attribute types are Position A Offset, Position B Offset, Position A Scale, and Position B Scale.

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]).
attrType: (Input) Floating-Point Attribute Type: refer to nai_dl_floating_point_attributes_type_t definition.
attrValue: (Input) Floating-Point Attribute Value to set.
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 attrType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetOutputMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetOutputMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_vll_mode_type_t mode )

Sets the output mode (ratio mode or fixed mode) 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]).
mode: (Input) 0 for ratio mode or 1 for fixed mode.
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 mode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetPowerSupplyState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetPowerSupplyState ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_on_off_t setting )

Sets the Power Supply State for the specified DLV 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]).
setting: (Input) DL_OFF or DL_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_INVALID_RANGE when invalid setting parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetWireMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetWireMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_wire_mode_type_t mode )

Sets the wire mode (4-wire or 2-wire) 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]).
mode: (Input) 1 for 4-wire mode or 2 for 2-wire mode.
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 mode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.