Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
FIFO Interrupt Functions
LVDT Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_status_type_t type, bool_t enable)
 Sets the Event Mapped Interrupt Enable for the specified LVDT channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptEnable (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_status_type_t type, bool_t *p_outenable)
 Retrieves the Event Mapped Interrupt Enable for the specified LVDT channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_status_type_t type, nai_lvdt_interrupt_t triggerType)
 Sets the Event Mapped Interrupt Edge/Level property for the specified LVDT channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptTriggerType (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_status_type_t type, nai_lvdt_interrupt_t *p_outtriggerType)
 Retrieves the Event Mapped Interrupt Edge/Level property for the specified LVDT channel and event mapped interrupt status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, uint32_t vector)
 Sets the Event Mapped Interrupt Vector for the specified LVDT channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptVector (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, uint32_t *p_outVector)
 Retrieves the Event Mapped Interrupt Vector for the specified LVDT channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, naibrd_int_steering_t steering)
 Sets the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified LVDT channel and event mapped interrupt status category type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptSteering (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_category_type_t type, naibrd_int_steering_t *p_outSteering)
 Retrieves the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified LVDT channel and event mapped interrupt status category type.
 

Detailed Description


Function Documentation

◆ naibrd_LVDT_GetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_status_type_t type,
bool_t * p_outenable )

Retrieves the Event Mapped Interrupt Enable for the specified LVDT channel and event mapped interrupt status type.

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) Status Type: refer to naibrd_lvdt_event_mapped_status_type_t definition.
p_outenable: (Output) 0 for disabled, 1 for enabled interrupt.
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_LVDT_GetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
naibrd_int_steering_t * p_outSteering )

Retrieves the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified LVDT channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
p_outSteering: (Output) Interrupt Steering: refer to naibrd_int_steering_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_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_LVDT_GetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_status_type_t type,
nai_lvdt_interrupt_t * p_outtriggerType )

Retrieves the Event Mapped Interrupt Edge/Level property for the specified LVDT channel and event mapped interrupt status type.

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) Status Type: refer to naibrd_lvdt_event_mapped_status_type_t definition.
p_outtriggerType: (Output) Interrupt trigger type: refer to nai_lvdt_interrupt_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 type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
uint32_t * p_outVector )

Retrieves the Event Mapped Interrupt Vector for the specified LVDT channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
p_outVector: (Output) Interrupt Vector.
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_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_LVDT_SetEventMappedInterruptEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_status_type_t type,
bool_t enable )

Sets the Event Mapped Interrupt Enable for the specified LVDT channel and event mapped interrupt status type.

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) Status Type: refer to naibrd_lvdt_event_mapped_status_type_t definition.
enable: (Input) 0 to disable, 1 to enable interrupt.
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 or invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetEventMappedInterruptSteering()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptSteering ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
naibrd_int_steering_t steering )

Sets the Event Mapped Interrupt Steering, which indicates the interrupt direction, for the specified LVDT channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
steering: (Input) Interrupt Steering: refer to naibrd_int_steering_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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter or invalid steering parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetEventMappedInterruptTriggerType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptTriggerType ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_status_type_t type,
nai_lvdt_interrupt_t triggerType )

Sets the Event Mapped Interrupt Edge/Level property for the specified LVDT channel and event mapped interrupt status type.

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) Status Type: refer to naibrd_lvdt_event_mapped_status_type_t definition.
triggerType: (Input) Interrupt trigger type: refer to nai_lvdt_interrupt_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 type parameter or invalid triggerType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetEventMappedInterruptVector()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetEventMappedInterruptVector ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_category_type_t type,
uint32_t vector )

Sets the Event Mapped Interrupt Vector for the specified LVDT channel and event mapped interrupt status category type.

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) Event-Mapped Status Category Type: refer to naibrd_lvdt_event_mapped_category_type_t definition.
vector: (Input) Interrupt Vector.
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_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.