Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Configuration Functions
NAI Board Library - Module Functions » DLV Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetConfigurationValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_configuration_type_t opMode, float64_t opValue)
 Sets various configuration values on a DLV module for a specified channel. Use naibrd_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, naibrd_dl_configuration_type_t opMode, float64_t *p_outopValue)
 Retrieves various configuration values on a DLV module for a specified channel. Use naibrd_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 status reporting for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outenable)
 Retrieves the enabled/disabled state of status reporting for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetWireMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_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, naibrd_dl_wire_mode_type_t *p_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, naibrd_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, naibrd_dl_vll_mode_type_t *p_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, naibrd_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, naibrd_dl_floating_point_attributes_type_t attrType, float64_t *p_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, naibrd_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, naibrd_dl_on_off_t *p_outsetting)
 Retrieves 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 * p_outenable )

Retrieves the enabled/disabled state of status reporting 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_outenable: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting 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,
naibrd_dl_configuration_type_t opMode,
float64_t * p_outopValue )

Retrieves various configuration values on a DLV module for a specified channel. Use naibrd_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 naibrd_dl_configuration_type_t definition.
p_outopValue: (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 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 opMode 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,
naibrd_dl_floating_point_attributes_type_t attrType,
float64_t * p_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 naibrd_dl_floating_point_attributes_type_t definition.
p_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,
naibrd_dl_vll_mode_type_t * p_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]).
p_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_UNKNOWN_VALUE when invalid output mode is read from the module.
  • 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,
naibrd_dl_on_off_t * p_outsetting )

Retrieves 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]).
p_outsetting: (Output) NAIBRD_DL_OFF or NAIBRD_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_UNKNOWN_VALUE when invalid power supply state is read from the module.
  • 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,
naibrd_dl_wire_mode_type_t * p_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]).
p_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_UNKNOWN_VALUE when invalid wire mode is read from the module.
  • 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 status reporting 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]).
enable: (Input) 0 to disable or 1 to enable channel status reporting.
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,
naibrd_dl_configuration_type_t opMode,
float64_t opValue )

Sets various configuration values on a DLV module for a specified channel. Use naibrd_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 naibrd_dl_configuration_type_t definition.
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 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 opMode parameter is specified.
  • NAI_ERROR_INVALID_RANGE when invalid opValue 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,
naibrd_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 naibrd_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,
naibrd_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,
naibrd_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) NAIBRD_DL_OFF or NAIBRD_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_VALUE 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,
naibrd_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.