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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetPosition (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outposition)
 Retrieves the position from the specified channel. The position value is scaled between -100 to +100.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWirePosition (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *p_outposition)
 Retrieves the position in 2 wire A or B side of the specified channel. The position value is scaled between -100 to +100.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVelocity (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outvelocity)
 Retrieves the velocity from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWireVelocity (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_2_wire_t type, float64_t *p_outvelocity)
 Retrieves the velocity in 2 wire A or B side of the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFrequency (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outfrequency)
 Retrieves the reference source frequency in Hertz from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outsigVolt)
 Retrieves the signal voltage (VLL) in volts from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRefVoltage (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outrefVolt)
 Retrieves the reference voltage in volts from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outstatusBit)
 Retrieves the LVDT Status specified by the status type of a specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_chan_mapped_status_type_t statusType)
 Clear the LVDT Status specified by the status type of a specified channel. note If any realtime status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetLatch (int32_t cardIndex, int32_t module, int32_t channel, uint32_t latch)
 Sets the Latch Control register to Latch the Position Data for the specified channel. The Latch Control register allows for simultaneously measurement. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetLatch (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outlatch)
 Retrieves the state of the Latch Control bit of the Latch Control Register for the specified channel. The Latch Control register allows simultaneous input measurements. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalMagnitude (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_signal_type_t type, float64_t *p_outsignal)
 Retrieves the signal Root-Mean-Square(RMS) value of the selected LVDT signal. The available selected LVDT signals are Va, Vb, and Va + Vb. This function works with LVDT modules that support hardware floating point operation only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetSignalInversion (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_signal_inversion_type_t sigType, naibrd_lvdt_signal_inversion_resp_value_type_t sigInvRespType)
 Sets the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalInversion (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_signal_inversion_type_t sigType, naibrd_lvdt_signal_inversion_resp_value_type_t *p_outsigInvRespType)
 Retrieves the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_status_type_t type, uint32_t *p_outstatus)
 Retrieves the LVDT Status from the specified channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_lvdt_status_type_t type)
 Clears the latched status for the specified LVDT channel and status type. To clear the selected status type of a specified channel, wtite a 1 to the channel bit mapped status register.
 

Detailed Description

Function Documentation

◆ naibrd_LVDT_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_chan_mapped_status_type_t statusType )

Clear the LVDT Status specified by the status type of a specified channel. note If any realtime status type is provided, the function will return NAI_ERROR_INVALID_VALUE since realtime status bits are not cleared by the user.

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_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_LVDT_ClearStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_ClearStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_status_type_t type )

Clears the latched status for the specified LVDT channel and status type. To clear the selected status type of a specified channel, wtite a 1 to the channel bit mapped 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]).
type: (Input) Status Type: refer to naibrd_lvdt_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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_chan_mapped_status_type_t statusType,
nai_status_bit_t * p_outstatusBit )

Retrieves the LVDT Status specified by the status type of a 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]).
statusType: (Input) Status Type: refer to naibrd_lvdt_chan_mapped_status_type_t definition.
p_outstatusBit: (Output) NAI_STATUS_BIT_LO (0) and NAI_STATUS_BIT_HI (1).
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_GetFrequency()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetFrequency ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outfrequency )

Retrieves the reference source frequency in Hertz from 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_outfrequency: (Output) Frequency reading in Hertz.
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_GetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetLatch ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outlatch )

Retrieves the state of the Latch Control bit of the Latch Control Register for the specified channel. The Latch Control register allows simultaneous input measurements. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.

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_outlatch: (Output) 0 indicates channel is unlatched. 1 indicates latched.
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_GetPosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetPosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outposition )

Retrieves the position from the specified channel. The position value is scaled between -100 to +100. 

* At -100, the position is at the maximum negative Full Scale.
* At 0, the position is at the center.
* At +100, the position is at the maximum positive Full 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]).
p_outposition: (Output) Position reading scaled between -100 and +100.
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_GetRefVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetRefVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outrefVolt )

Retrieves the reference voltage in volts from 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_outrefVolt: (Output) Reference Voltage reading in volts.
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_GetSignalInversion()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalInversion ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_signal_inversion_type_t sigType,
naibrd_lvdt_signal_inversion_resp_value_type_t * p_outsigInvRespType )

Retrieves the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.

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]).
sigType: (Input) Signal setting type refer to naibrd_lvdt_signal_inversion_type_t.
p_outsigInvRespType: (Output) Signal setting response type refer to naibrd_lvdt_signal_inversion_resp_value_type_t.
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 naibrd_lvdt_signal_inversion_type_t parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetSignalMagnitude()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalMagnitude ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_signal_type_t type,
float64_t * p_outsignal )

Retrieves the signal Root-Mean-Square(RMS) value of the selected LVDT signal. The available selected LVDT signals are Va, Vb, and Va + Vb. This function works with LVDT modules that support hardware floating point operation only.

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) Signal type refer to naibrd_lvdt_signal_type_t.
p_outsignal: (Output) signal level
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 naibrd_lvdt_signal_type_t parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_GetSignalVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetSignalVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outsigVolt )

Retrieves the signal voltage (VLL) in volts from 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_outsigVolt: (Output) VLL reading in volts.
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_GetStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_status_type_t type,
uint32_t * p_outstatus )

Retrieves the LVDT Status from 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]).
type: (Input) Status Type: refer to naibrd_lvdt_status_type_t definition
p_outstatus: (Output) 0 for Normal, 1 for Failure.
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_GetTwoWirePosition()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWirePosition ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_2_wire_t type,
float64_t * p_outposition )

Retrieves the position in 2 wire A or B side of the specified channel. The position value is scaled between -100 to +100. 

* At -100, the position is at the maximum negative Full Scale.
* At 0, the position is at the center.
* At +100, the position is at the maximum positive Full 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]).
type: (Input) Position Type: refer to naibrd_lvdt_2_wire_t definition.
p_outposition: (Output) Position reading scaled between -100 and +100.
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_GetTwoWireVelocity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetTwoWireVelocity ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_2_wire_t type,
float64_t * p_outvelocity )

Retrieves the velocity in 2 wire A or B side of the specified channel. 

* TBD
*
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) Velocity Type: refer to naibrd_lvdt_2_wire_t definition.
p_outvelocity: (Output) Velocity reading TBD.
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_GetVelocity()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_GetVelocity ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outvelocity )

Retrieves the velocity from the specified channel. 

* TBD
*
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_outvelocity: (Output) Velocity reading TBD.
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_SetLatch()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetLatch ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t latch )

Sets the Latch Control register to Latch the Position Data for the specified channel. The Latch Control register allows for simultaneously measurement. After latching the channel, the position data is latched until it is released by reading the channel's Position Data register or setting the Latch Control register to 0.

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]).
latch: (Input) 0 to unlatch or release all latched data. Enter 1 to latch the specified 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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_LVDT_SetSignalInversion()

NAIBRDFUNC nai_status_t NAIAPI naibrd_LVDT_SetSignalInversion ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_lvdt_signal_inversion_type_t sigType,
naibrd_lvdt_signal_inversion_resp_value_type_t sigInvRespType )

Sets the invert signal selection. The signal inversion control is bit mapped to a register and is defined below: Definition: D0: Inverted Va = 1, Non-inverted Va = 0. D1: Inverted Vb = 1, Non-inverted Vb = 0. D2: Inverted Ref = 1, Non-inverted Ref = 0. D3: Vb-Va = 1, Va-Vb = 0. This function works with LVDT modules that support hardware floating point operation only.

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]).
sigType: (Input) Signal type refer to naibrd_lvdt_signal_inversion_type_t.
sigInvRespType: (Input) Signal response type refer to naibrd_lvdt_signal_inversion_resp_value_type_t.
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 naibrd_lvdt_signal_inversion_type_t parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.