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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetPosition (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_subchannel_t subchannel, float64_t position)
 Sets position on a DLV module for a specified subchannel and channel. Use naibrd_dl_subchannel_t to select the specified subchannel to be written to the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetPosition (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_subchannel_t subchannel, float64_t *p_outposition)
 Retrieves position on a DLV module from a specified subchannel and channel. Use naibrd_dl_subchannel_t to select the specified subchannel to be read from the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetMeasuredValue (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_measured_value_type_t opMode, float64_t *p_outopValue)
 Retrieves a measured value for the specified DLV channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_chan_mapped_status_type_t statusType, naibrd_dl_module_status_t *p_outstatus)
 Retrieves the module status for a specific channel and status type from the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_dl_chan_mapped_status_type_t statusType)
 Clears the module latched status for a specific channel and status type for the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, nai_dl_module_status_t *p_outStatus)
 Retrieves the module latched status for a specific channel from the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType)
 Clears the module latched status for a specific channel from the DLV module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatusRealtime (int32_t cardIndex, int32_t module, int32_t channel, nai_dl_status_type_t statusType, nai_dl_module_status_t *p_outStatus)
 Retrieves the module realtime status for a specific channel from the DLV module.
 

Detailed Description


Function Documentation

◆ naibrd_DL_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_chan_mapped_status_type_t statusType )

Clears the module latched status for a specific channel and status type for 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]).
statusType: (Input) Refer to naibrd_dl_chan_mapped_status_type_t definition.
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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_status_type_t statusType )

Clears the module latched status for a specific channel 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]).
statusType: (Input) Refer to naibrd_dl_chan_mapped_status_type_t definition.
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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_chan_mapped_status_type_t statusType,
naibrd_dl_module_status_t * p_outstatus )

Retrieves the module status for a specific channel and status type 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]).
statusType: (Input) Refer to naibrd_dl_chan_mapped_status_type_t definition.
p_outstatus: (Output) naibrd_dl_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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetMeasuredValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetMeasuredValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_measured_value_type_t opMode,
float64_t * p_outopValue )

Retrieves a measured value 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]).
opMode: (Input) Refer to naibrd_dl_measured_value_type_t definition.
p_outopValue: (Output) float64_t*: Returns a measured value from 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_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetPosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_subchannel_t subchannel,
float64_t * p_outposition )

Retrieves position on a DLV module from a specified subchannel and channel. Use naibrd_dl_subchannel_t to select the specified subchannel 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]).
subchannel: (Input) Subchannel: refer to naibrd_dl_subchannel_t definition.
p_outposition: (Output) float64_t: Returns position from 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 subchannel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_status_type_t statusType,
nai_dl_module_status_t * p_outStatus )

Retrieves the module latched status for a specific channel from the DLV module.

These functions are deprecated and replaced by API functions in naibrd_dl.c

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) Refer to naibrd_dl_chan_mapped_status_type_t definition.
p_outStatus: (Output) naibrd_dl_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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_GetStatusRealtime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_GetStatusRealtime ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_dl_status_type_t statusType,
nai_dl_module_status_t * p_outStatus )

Retrieves the module realtime status for a specific channel 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]).
statusType: (Input) Refer to naibrd_dl_chan_mapped_status_type_t definition.
p_outStatus: (Output) naibrd_dl_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 statusType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DL_SetPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DL_SetPosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_dl_subchannel_t subchannel,
float64_t position )

Sets position on a DLV module for a specified subchannel and channel. Use naibrd_dl_subchannel_t to select the specified subchannel 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]).
subchannel: (Input) Subchannel: refer to naibrd_dl_subchannel_t definition.
position: (Input) float64_t: Value used to set position 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 subchannel parameter is specified.
  • NAI_ERROR_INVALID_RANGE when invalid position parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.