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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetData (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_data_type_t type, float64_t data)
 Sets operational properties (voltage, frequencies, ect..) for the reference module. Data is specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetData (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_data_type_t type, float64_t *p_outdata)
 Retrieves operational properties (voltage, frequencies, ect..) for the reference module. Data is reported as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredData (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_measured_type_t type, float64_t *p_outdata)
 Retrieves the measured operational values from the reference module. Measurements are reported as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t value)
 Sets the control of a specific channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outvalue)
 Retrieves the control of a specific channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_chan_mapped_status_type_t statusType)
 Clears the latched or realtime status for the specified REF channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearEventMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_event_mapped_status_type_t statusType)
 Clears the latched status for the specified REF channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_register_type_t type, uint32_t *p_outrawData)
 Retrieves the raw register data of the type and channel specified.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChannelRaw (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ref_register_type_t type, uint32_t rawData)
 Sets the raw register data of the type and channel specified.
 

Detailed Description

Function Documentation

◆ naibrd_REF_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChanMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_chan_mapped_status_type_t statusType )

Clears the latched or realtime status for the specified REF channel and status type.

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_ref_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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_ClearEventMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearEventMappedStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_event_mapped_status_type_t statusType )

Clears the latched status for the specified REF 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) Status Type: refer to naibrd_ref_event_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 status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetChannelEnable()

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

Retrieves the control of a specific 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.
p_outvalue: (Output) 1 = Enable, 0 = Disable.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_register_type_t type,
uint32_t * p_outrawData )

Retrieves the raw register data of the type and channel specified.

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.
type: (Input) Data Type: refer to naibrd_ref_register_type_t definitions.
p_outrawData: (Output) raw data Value read.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetData ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_data_type_t type,
float64_t * p_outdata )

Retrieves operational properties (voltage, frequencies, ect..) for the reference module. Data is reported as follows:

  • Voltage in RMS Volts
  • Frequency in Hz
  • Current in mAmps
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.
type: (Input) Data Type: refer to naibrd_ref_value_type_t definitions.
p_outdata: (Output) Data Value read.
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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetMeasuredData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredData ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_measured_type_t type,
float64_t * p_outdata )

Retrieves the measured operational values from the reference module. Measurements are reported as follows:

  • Voltage in RMS Volts
  • Frequency in Hz
  • Current in mAmps
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.
type: (Input) Data Type: refer to naibrd_ref_measured_type_t definitions.
p_outdata: (Output) Measured 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetChannelEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChannelEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t value )

Sets the control of a specific 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.
value: (Input) 1 = Enable, 0 = Disable.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetChannelRaw()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChannelRaw ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_register_type_t type,
uint32_t rawData )

Sets the raw register data of the type and channel specified.

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.
type: (Input) Data Type: refer to naibrd_ref_value_type_t definitions.
rawData: (Input) raw data 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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetData()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetData ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ref_data_type_t type,
float64_t data )

Sets operational properties (voltage, frequencies, ect..) for the reference module. Data is specified as follows:

  • Voltage in RMS Volts
  • Frequency in Hz
  • Current in mAmps
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.
type: (Input) Data Type: refer to naibrd_ref_value_type_t definitions.
data: (Input) Data 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_VALUE when invalid status type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.