Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Standard Operation Functions
Reference Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValueEx (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_value_type_t type, float64_t inValue)
 Sets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValueEx (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_value_type_t type, float64_t *outValue)
 Gets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValueEx (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_measured_type_t type, float64_t *outValue)
 Gets the measured operational values from the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChannelEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t inValue)
 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 *outValue)
 Retrieves the control of a specific channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetReset (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_reset_type_t type)
 Resets the channel depending on the type received.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetResetAll (int32_t cardIndex, int32_t module, nai_ref_reset_type_t type)
 Resets all of the channel depending on the type received.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t enable)
 Enables/disables status reporting for the specified Reference channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, bool_t *outenable)
 Retrieves the enabled/disabled state of status reporting for the specified Reference channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type, nai_ref_status_access_type_t accessType, uint32_t *outStatus)
 Retrieves the status for the specified Reference channel with the output specified as follows:
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChannelStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_type_t type)
 Clears the latched status for the specified REF channel and status type.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetBitStatus (int32_t cardIndex, int32_t module, int32_t channel, nai_ref_status_access_type_t type, uint32_t *outstatus)
 Retrieves the latched BIT status for the specified REF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearBitStatus (int32_t cardIndex, int32_t module, int32_t channel)
 Clears the latched BIT status for the specified REF channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValue (int32_t cardIndex, int32_t module, nai_ref_value_type_t type, float64_t inValue)
 Sets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValue (int32_t cardIndex, int32_t module, nai_ref_value_type_t type, float64_t *outValue)
 Gets operational properties (voltage, frequencies, ect..) for the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValue (int32_t cardIndex, int32_t module, nai_ref_measured_type_t type, float64_t *outValue)
 Gets the measured operational values from the reference module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetOutputEnable (int32_t cardIndex, int32_t module, bool_t enable)
 Sets the output on/off on the reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetOutputEnable (int32_t cardIndex, int32_t module, bool_t *outEnable)
 Gets the current output on/off state from the reference module. Not all reference module supports this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetOverCurrentStatus (int32_t cardIndex, int32_t module, bool_t *outOverCurrent)
 Gets the over current status of the reference module. Not all reference module supports this function.
 

Detailed Description


Function Documentation

◆ naibrd_REF_ClearBitStatus()

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

Clears the latched BIT status for the specified REF 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 card 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_ClearChannelStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_ClearChannelStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_status_type_t type )

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]).
type: (Input) Status Type: refer to nai_ref_status_type_t definition.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_GetBitStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetBitStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_status_access_type_t type,
uint32_t * outstatus )

Retrieves the latched BIT status for the specified REF 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 nai_ref_status_access_type_t definition.
outstatus: (Output) The status returned.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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 * 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.
outValue: (Output) Bitmask the dictates what the channel does.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetChannelStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChannelStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_status_type_t type,
nai_ref_status_access_type_t accessType,
uint32_t * outStatus )

Retrieves the status for the specified Reference channel with the output specified as follows: 

OVerCurrent            0x00000001
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) The status access type to read: refer to nai_ref_status_type_t definition.
accessType: (Input) Latched or Realtime status: refer to nai_ref_status_access_type_t definition.
outStatus: (Output) Channel Status.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * outenable )

Retrieves the enabled/disabled state of status reporting for the specified Reference 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]).
outenable: (Output) 0 if channel status reporting is disabled or 1 if channel status reporting is enabled.
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_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetMeasuredValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValue ( int32_t cardIndex,
int32_t module,
nai_ref_measured_type_t type,
float64_t * outValue )

Gets the measured operational values from the reference 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]).
type: (Input) Status Type: refer to nai_ref_measured_type_t definitions.
outValue: (Output) Measured Values: returns the measured values for the specified property type from the device.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetMeasuredValueEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetMeasuredValueEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_measured_type_t type,
float64_t * outValue )

Gets the measured operational values from the reference 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.
type: (Input) Status Type: refer to nai_ref_measured_type_t definitions.
outValue: (Output) Measured Values: returns the measured values for the specified property type from the device.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetOutputEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetOutputEnable ( int32_t cardIndex,
int32_t module,
bool_t * outEnable )

Gets the current output on/off state from the reference module. Not all reference module supports this function.

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]).
outEnable: (Output) bool_t *outEnable: returns the current reference module output on/off state.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetOverCurrentStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetOverCurrentStatus ( int32_t cardIndex,
int32_t module,
bool_t * outOverCurrent )

Gets the over current status of the reference module. Not all reference module supports this function.

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]).
outOverCurrent: (Output) bool_t *outOverCurrent: returns the over current status of the reference module.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_GetValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValue ( int32_t cardIndex,
int32_t module,
nai_ref_value_type_t type,
float64_t * outValue )

Gets operational properties (voltage, frequencies, ect..) for the reference 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]).
type: (Input) Status Type: refer to nai_ref_value_type_t definitions.
outValue: (Output) Operational properties: returns the current operational value for the specified property type stored in the device.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_GetValueEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_GetValueEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_value_type_t type,
float64_t * outValue )

Gets operational properties (voltage, frequencies, ect..) for the reference 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.
type: (Input) Status Type: refer to nai_ref_value_type_t definitions.
outValue: (Output) Operational properties: refer to NAI manual for the device's operational ranges
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_SetChannelEnable()

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

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.
inValue: (Input) Bitmask the dictates what the channel does.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t enable )

Enables/disables status reporting for the specified Reference 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]).
enable: (Input) 0 to disable or 1 to enable status reporting for a 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid enable parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetOutputEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetOutputEnable ( int32_t cardIndex,
int32_t module,
bool_t enable )

Sets the output on/off on the reference module. Not all reference module supports this function.

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]).
enable: (Input) bool_t enable: turns on/off on-board reference output.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetReset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetReset ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_reset_type_t type )

Resets the channel depending on the type received.

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) Refer to nai_ref_reset_type.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetResetAll()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetResetAll ( int32_t cardIndex,
int32_t module,
nai_ref_reset_type_t type )

Resets all of the channel depending on the type received.

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]).
type: (Input) Refer to nai_ref_reset_type.
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card parameter is specified.
  • NAI_ERROR_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_REF_SetValue()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValue ( int32_t cardIndex,
int32_t module,
nai_ref_value_type_t type,
float64_t inValue )

Sets operational properties (voltage, frequencies, ect..) for the reference 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]).
type: (Input) Status Type: refer to nai_ref_value_type_t definitions.
inValue: (Input) Operational properties: refer to NAI manual for the device's operational ranges
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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_SetValueEx()

NAIBRDFUNC nai_status_t NAIAPI naibrd_REF_SetValueEx ( int32_t cardIndex,
int32_t module,
int32_t channel,
nai_ref_value_type_t type,
float64_t inValue )

Sets operational properties (voltage, frequencies, ect..) for the reference 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.
type: (Input) Status Type: refer to nai_ref_value_type_t definitions.
inValue: (Input) Operational properties: refer to NAI manual for the device's operational ranges
Returns
  • NAI_SUCCESS
  • NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
  • NAI_ERROR_INVALID_MODULE when invalid card 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.