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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOCount (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcount)
 Retrieves the number of items in the LVDT Buffer Fifo for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ReadFIFORaw32 (int32_t cardIndex, int32_t module, int32_t channel, uint32_t count, uint32_t outdata[], uint32_t *p_outread)
 Retrieves multiple values from the LVDT Fifo Buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOValue (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outvalue)
 Retrieves one value from the LVDT Fifo Buffer for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOAlmostEmptyThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold)
 Sets the number of data words the FIFO will have left before setting the AlmostEmpty bit in the FIFO status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOAlmostEmptyThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outthreshold)
 Retrieves the count set in the AlmostEmpty register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOAlmostFullThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold)
 Sets the number of data words the FIFO will receive before setting the AlmostFull bit in the FIFO status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOAlmostFullThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outthreshold)
 Retrieves the count set in the AlmostFull register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOLoThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold)
 Sets the number of data words the FIFO will have left before setting the LoThreshold bit in the FIFO status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOLoThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outthreshold)
 Retrieves the count set in the LoThreshold register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOHiThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t threshold)
 Sets the number of data words the FIFO will receive before setting the HiThreshold bit in the FIFO status register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOHiThreshold (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outthreshold)
 Retrieves the count set in the HiThreshold register.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFODelay (int32_t cardIndex, int32_t module, int32_t channel, uint32_t delay)
 Sets the time delay before samples are taken after the trigger occurs. The LSB of this value is 10.24us. The maximum delay is about 335 ms.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFODelay (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outdelay)
 Retrieves the time delay before samples are taken after the trigger occurs. This LSB of this value is 10.24us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t size)
 Sets the number of samples we take after the trigger occurs.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOSize (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outsize)
 Retrieves the number of samples we take after the trigger occurs.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOSampleRateValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t samplerate)
 Sets the time in usec between samples taken (4.096 us to 268431.36 us) in intervals of 4.096 usec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOSampleRateValue (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outsamplerate)
 Retrieves the time in usec between samples taken (4.096 us to 268431.36 us) in intervals of 4.096 usec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOSampleRate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t samplerate)
 Sets the time between samples taken. The LSB is 4.096us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOSampleRate (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outsamplerate)
 Retrieves the time between samples taken. The LSB is 4.096us.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFODataType (int32_t cardIndex, int32_t module, int32_t channel, uint32_t datatype)
 Sets the type of data to acquire in the buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFODataType (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outdatatype)
 Retrieves the type of data to acquire in the buffer.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearFIFO (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the LVDT FIFO buffers for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOTrigMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t trigmode)
 Sets the trigger mode to start data buffering.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOTrigMode (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outtrigmode)
 Retrieves the trigger mode to start data buffering.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SoftwareTrigger (int32_t cardIndex, int32_t module)
 Sends a software trigger to all channels.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_status_type_t statusType, nai_status_bit_t *p_outstatus)
 Retrieves the event mapped status of a channel for a specific event mapped status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_event_mapped_status_type_t statusType)
 Clears the LVDT Event Mapped Latched Status for the specified channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFORealtimeStatus (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outfifostatus)
 Retrieves the LVDT Buffer Fifo Status for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOLatchedStatus (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outfifostatus)
 Retrieves the LVDT Buffer Fifo Status for the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearFIFOLatchedStatus (int32_t cardIndex, int32_t module, int32_t channel, uint32_t fifostatus)
 Clears the LVDT Buffer Fifo Status for the specified channel.
 

Detailed Description

Function Documentation

◆ naibrd_LVDT_ClearEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearEventMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_status_type_t statusType )

Clears the LVDT Event Mapped Latched Status for the specified channel and 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]).
statusType: (Input) naibrd_lvdt_event_mapped_status_type_t type to clear.
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_ClearFIFO()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearFIFO ( int32_t cardIndex,
int32_t module,
int32_t channel )

Clears the LVDT FIFO buffers 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]).
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_ClearFIFOLatchedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearFIFOLatchedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t fifostatus )

Clears the LVDT Buffer Fifo Status 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]).
fifostatus: (Input) FIFO Status to clear (bitmapped).
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetEventMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_event_mapped_status_type_t statusType,
nai_status_bit_t * p_outstatus )

Retrieves the event mapped status of a channel for a specific event mapped 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]).
statusType: (Input) Status Type: refer to naibrd_lvdt_event_mapped_status_type_t definition.
p_outstatus: (Output) Event Mapped Status (NAI_STATUS_BIT_LO/NAI_STATUS_BIT_HI)
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_GetFIFOAlmostEmptyThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOAlmostEmptyThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outthreshold )

Retrieves the count set in the AlmostEmpty register.

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_outthreshold: (Output) Threshold value
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOAlmostFullThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOAlmostFullThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outthreshold )

Retrieves the count set in the AlmostFull register.

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_outthreshold: (Output) Threshold value.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOCount()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOCount ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outcount )

Retrieves the number of items in the LVDT Buffer Fifo 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_outcount: (Output) FIFO count
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFODataType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFODataType ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outdatatype )

Retrieves the type of data to acquire in the buffer.

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_outdatatype: (Output) Data Type to acquire in buffer per table below. 
*   D0  = Position Data (32 Bit).
*   D1  = Velocity Data (32 Bit).
*   D2  = Time Stamp. An integer counter that counts from 0 to 4,294,967,295 and wraps around when it overflows.
*   D3  = Reserved
*   D4  = Reserved
*   D5  = Reserved
*   D6  = Reserved
*   D7  = Reserved
*
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFODelay()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFODelay ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outdelay )

Retrieves the time delay before samples are taken after the trigger occurs. This LSB of this value is 10.24us.

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_outdelay: (Output) Delay count.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOHiThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOHiThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outthreshold )

Retrieves the count set in the HiThreshold register.

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_outthreshold: (Output) Threshold value.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOLatchedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOLatchedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outfifostatus )

Retrieves the LVDT Buffer Fifo Status 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_outfifostatus: (Output) FIFO Status
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOLoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOLoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outthreshold )

Retrieves the count set in the LoThreshold register.

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_outthreshold: (Output) Threshold value
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFORealtimeStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFORealtimeStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outfifostatus )

Retrieves the LVDT Buffer Fifo Status 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_outfifostatus: (Output) FIFO Status
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOSampleRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outsamplerate )

Retrieves the time between samples taken. The LSB is 4.096us.

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_outsamplerate: (Output) Sample Rate.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOSampleRateValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOSampleRateValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outsamplerate )

Retrieves the time in usec between samples taken (4.096 us to 268431.36 us) in intervals of 4.096 usec.

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_outsamplerate: (Output) Sample Rate value.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOSize()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOSize ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outsize )

Retrieves the number of samples we take after the trigger occurs.

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_outsize: (Output) Number of Samples.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOTrigMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOTrigMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outtrigmode )

Retrieves the trigger mode to start data buffering.

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_outtrigmode: (Output) Trigger Mode as specified in table below. 
*   0x00 = Ext Trig1
*   0x01 = Ext Trig2
*   0x02 = Software Trigger
*   0x10 = Trigger Slope
*   0x20 = Trigger Enable
*   0x40 = Trigger Always
*   0x80 = Clear Trigger Always
*
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetFIFOValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFIFOValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outvalue )

Retrieves one value from the LVDT Fifo Buffer 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_outvalue: (Output) FIFO value
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_ReadFIFORaw32()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ReadFIFORaw32 ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t count,
uint32_t outdata[],
uint32_t * p_outread )

Retrieves multiple values from the LVDT Fifo Buffer 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]).
count: (Input) Number of items to be read out of the fifo.
outdata: (Output) Items read from the fifo.
p_outread: (Output) Number of items read out of the fifo.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOAlmostEmptyThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOAlmostEmptyThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t threshold )

Sets the number of data words the FIFO will have left before setting the AlmostEmpty bit in the FIFO status register.

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]).
threshold: (Input) Number of words.
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 threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOAlmostFullThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOAlmostFullThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t threshold )

Sets the number of data words the FIFO will receive before setting the AlmostFull bit in the FIFO status register.

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]).
threshold: (Input) Number of words.
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 threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFODataType()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFODataType ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t datatype )

Sets the type of data to acquire in the buffer.

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]).
datatype: (Input) Data Type to acquire in buffer as specified in table below. 
*   D0  = Position Data (32 Bit).
*   D1  = Velocity Data (32 Bit).
*   D2  = Time Stamp. An integer counter that counts from 0 to 4,294,967,295 and wraps around when it overflows.
*   D3  = Reserved
*   D4  = Reserved
*   D5  = Reserved
*   D6  = Reserved
*   D7  = Reserved
*
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 datatype parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFODelay()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFODelay ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t delay )

Sets the time delay before samples are taken after the trigger occurs. The LSB of this value is 10.24us. The maximum delay is about 335 ms.

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]).
delay: (Input) Delay Count.
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 delay parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOHiThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOHiThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t threshold )

Sets the number of data words the FIFO will receive before setting the HiThreshold bit in the FIFO status register.

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]).
threshold: (Input) Number of words.
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 threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOLoThreshold()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOLoThreshold ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t threshold )

Sets the number of data words the FIFO will have left before setting the LoThreshold bit in the FIFO status register.

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]).
threshold: (Input) Number of words.
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 threshold parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOSampleRate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOSampleRate ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t samplerate )

Sets the time between samples taken. The LSB is 4.096us.

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]).
samplerate: (Input) Sample Rate.
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 samplerate parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOSampleRateValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOSampleRateValue ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t samplerate )

Sets the time in usec between samples taken (4.096 us to 268431.36 us) in intervals of 4.096 usec.

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]).
samplerate: (Input) Time in usec.
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 samplerate parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOSize()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOSize ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t size )

Sets the number of samples we take after the trigger occurs.

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]).
size: (Input) Number of Samples.
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 size parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetFIFOTrigMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetFIFOTrigMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t trigmode )

Sets the trigger mode to start data buffering.

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]).
trigmode: (Input) Trigger Mode to acquire in buffer as specified in table below. 
*   0x00 = Ext Trig1
*   0x01 = Ext Trig2
*   0x02 = Software Trigger
*   0x10 = Trigger Slope
*   0x20 = Trigger Enable
*   0x40 = Trigger Always
*   0x80 = Clear Trigger Always
*
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 trigmode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SoftwareTrigger()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SoftwareTrigger ( int32_t cardIndex,
int32_t module )

Sends a software trigger to all channels.

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]).
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_SUPPORTED when function is not supported.