Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
Functions
Configuration Functions
NAI Board Library - Module Functions » DS Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetExpectedVoltage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_expected_voltage_type_t type, float64_t inExpVolt)
 Sets the expected reference and output line-line for a specified channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetExpectedVoltage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_expected_voltage_type_t type, float64_t *p_outExpVolt)
 Gets the expected reference and output line-line for a specified channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetThresholdVoltage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_threshold_voltage_type_t type, float64_t inThresVolt)
 Sets the expected reference and output line-line threshold voltage for a specified channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetThresholdVoltage (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_threshold_voltage_type_t type, float64_t *p_outThresVolt)
 Gets the expected reference and output line-line threshold voltage for a specified channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetThresholdCurrent (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_expected_current_type_t type, float64_t inThresCurrent)
 Sets the output line-line threshold current(RMS) for a specified channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetThresholdCurrent (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_expected_current_type_t type, float64_t *p_outThresCurrent)
 Gets the output line-line threshold current(RMS) for a specified channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRatioFixedMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_output_ratio_fixed_mode_t inRatioFixMode)
 Sets the D/S channel ratio/fixed mode for a specified D/S channel for the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRatioFixedMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_output_ratio_fixed_mode_t *p_outRatioFixMode)
 Gets the D/S Ratio/Fixed selection of a specified D/S channel for the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetSynRslMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_synchro_resolver_t inSynRslMode)
 Sets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming modules support this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetSynRslMode (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_synchro_resolver_t *p_outSynRslMode)
 Gets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming modules support this function.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, bool_t inActiveChan)
 Sets the active channel state for a specified D/S channel for the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetActiveChannel (int32_t cardIndex, int32_t module, int32_t channel, bool_t *p_outActChanEnable)
 Gets the active channel state for a specified D/S channel for the D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t inSetting)
 Sets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanStatusEnable (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outSetting)
 Gets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRotationCtrl (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_rotation_configuration_type_t type, float64_t inRotationCtrl)
 Sets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on how to set each rotation control setting.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationCtrl (int32_t cardIndex, int32_t module, int32_t channel, naibrd_ds_rotation_configuration_type_t type, float64_t *p_outRotCtrl)
 Gets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on the rotation control settings.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetMultiSpeedRatio (int32_t cardIndex, int32_t module, naibrd_ds_multi_speed_chan_pair_type_t chanPairType, uint32_t inMultSpd)
 Sets the D/S multi-speed ratio for a specified D/S channel pair in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetMultiSpeedRatio (int32_t cardIndex, int32_t module, naibrd_ds_multi_speed_chan_pair_type_t chanPairType, uint32_t *p_outMultSpd)
 Gets the D/S multi-speed ratio for a specified D/S channel pair in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetPhaseOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t inPhase)
 Sets the phase offset of a specified D/S channel in a D/S module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetPhaseOffset (int32_t cardIndex, int32_t module, int32_t channel, float64_t *p_outPhase)
 Gets the phase offset of a specified D/S channel in a D/S module.
 

Detailed Description

Function Documentation

◆ naibrd_DS_GetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetActiveChannel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t * p_outActChanEnable )

Gets the active channel state for a specified D/S channel for the D/S 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 of the channel to access (1 - [max channels for module]).
p_outActChanEnable: (Output) Returns the active channel state(Active=1, Not Active=0) from a specified channel of a D/S 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_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_DS_GetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outSetting )

Gets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.

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_outSetting: (Output) Returns the channel status enable (enable=1, disable=0) of a specified channel of a D/S 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_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_DS_GetExpectedVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetExpectedVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_expected_voltage_type_t type,
float64_t * p_outExpVolt )

Gets the expected reference and output line-line for a specified channel in a D/S 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 of the channel to access (1 - [max channels for module]).
type: (Input) Expected Voltage Type: refer to naibrd_ds_expected_voltage_type_t definitions.
p_outExpVolt: (Output) Returns the expected voltage for a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetMultiSpeedRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetMultiSpeedRatio ( int32_t cardIndex,
int32_t module,
naibrd_ds_multi_speed_chan_pair_type_t chanPairType,
uint32_t * p_outMultSpd )

Gets the D/S multi-speed ratio for a specified D/S channel pair in a D/S 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]).
chanPairType: (Input) Refer to naibrd_ds_multi_speed_chan_pair_type_t for type definition.
p_outMultSpd: (Output) Returns the multi-speed ratio from a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid chanPairType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetPhaseOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetPhaseOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t * p_outPhase )

Gets the phase offset of a specified D/S channel in a D/S 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 of the channel to access (1 - [max channels for module]).
p_outPhase: (Output) Returns the phase offset value from a specified channel in a D/S 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_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_DS_GetRatioFixedMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRatioFixedMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_output_ratio_fixed_mode_t * p_outRatioFixMode )

Gets the D/S Ratio/Fixed selection of a specified D/S channel for the D/S 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 of the channel to access (1 - [max channels for module]).
p_outRatioFixMode: (Output) Returns the ratio(0)/fixed(1) mode setting.
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_DS_GetRotationCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetRotationCtrl ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_rotation_configuration_type_t type,
float64_t * p_outRotCtrl )

Gets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on the rotation control settings.

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) Rotation Type: Refer to naibrd_ds_rotation_configuration_type_t definitions.
p_outRotCtrl: (Output) Reads the rotation properties of a specified channel from a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetSynRslMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetSynRslMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_synchro_resolver_t * p_outSynRslMode )

Gets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming modules support 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outSynRslMode: (Output) Returns Synchro(3)/Resolver(0) mode from a specified channel of a D/S 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_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_DS_GetThresholdCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetThresholdCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_expected_current_type_t type,
float64_t * p_outThresCurrent )

Gets the output line-line threshold current(RMS) for a specified channel in a D/S 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 of the channel to access (1 - [max channels for module]).
type: (Input) Current Type: refer to naibrd_ds_expected_current_type_t definitions.
p_outThresCurrent: (Output) Returns the threshold current for a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_GetThresholdVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_GetThresholdVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_threshold_voltage_type_t type,
float64_t * p_outThresVolt )

Gets the expected reference and output line-line threshold voltage for a specified channel in a D/S 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 of the channel to access (1 - [max channels for module]).
type: (Input) Threshold Voltage Type: refer to naibrd_ds_threshold_voltage_type_t definitions.
p_outThresVolt: (Output) Returns the threshold voltage for a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetActiveChannel()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetActiveChannel ( int32_t cardIndex,
int32_t module,
int32_t channel,
bool_t inActiveChan )

Sets the active channel state for a specified D/S channel for the D/S 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 of the channel to access (1 - [max channels for module]).
inActiveChan: (Input) Writes the active channel state(Active=1, Not Active=0) to a specified channel of a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid inActiveChan parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetChanStatusEnable()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetChanStatusEnable ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t inSetting )

Sets the channel status enable/disable for the specified D/S channel for the D/S module. When it is set to disable, ref loss, sig loss, bit fault, and phase loss status will not be updated.

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]).
inSetting: (Input) Writes the channel status enable (enable=1, disable=0) to a specified channel of a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid inSetting parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetExpectedVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetExpectedVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_expected_voltage_type_t type,
float64_t inExpVolt )

Sets the expected reference and output line-line for a specified channel in a D/S 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 of the channel to access (1 - [max channels for module]).
type: (Input) Expected Voltage Type: refer to naibrd_ds_expected_voltage_type_t definitions.
inExpVolt: (Input) Write the expected voltage for a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetMultiSpeedRatio()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetMultiSpeedRatio ( int32_t cardIndex,
int32_t module,
naibrd_ds_multi_speed_chan_pair_type_t chanPairType,
uint32_t inMultSpd )

Sets the D/S multi-speed ratio for a specified D/S channel pair in a D/S 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]).
chanPairType: (Input) Refer to naibrd_ds_multi_speed_chan_pair_type_t for type definition.
inMultSpd: (Input) Write the multi-speed ratio to a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_VALUE when invalid chanPairType parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetPhaseOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetPhaseOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
float64_t inPhase )

Sets the phase offset of a specified D/S channel in a D/S 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 of the channel to access (1 - [max channels for module]).
inPhase: (Input) Writes the phase offset value to a specified channel in a D/S 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_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_DS_SetRatioFixedMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRatioFixedMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_output_ratio_fixed_mode_t inRatioFixMode )

Sets the D/S channel ratio/fixed mode for a specified D/S channel for the D/S 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 of the channel to access (1 - [max channels for module]).
inRatioFixMode: (Input) Write ratio(0)/fixed(1) mode to a specified channel of the D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid inRatioFixMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetRotationCtrl()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetRotationCtrl ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_rotation_configuration_type_t type,
float64_t inRotationCtrl )

Sets the Rotation control for a specified D/S channel of a D/S module. Refer to the Operation Manual for information on how to set each rotation control setting.

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) Rotation Type: Refer to naibrd_ds_rotation_configuration_type_t definitions.
inRotationCtrl: (Input) Writes the rotation properties to a specified channel of a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetSynRslMode()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetSynRslMode ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_synchro_resolver_t inSynRslMode )

Sets the Synchro or Resolver mode for a specified channel for the D/S module. Only mixed mode programming modules support 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
inSynRslMode: (Input) Writes Synchro(3)/Resolver(0) mode to a specified channel of a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid inSynRslMode parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetThresholdCurrent()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetThresholdCurrent ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_expected_current_type_t type,
float64_t inThresCurrent )

Sets the output line-line threshold current(RMS) for a specified channel in a D/S 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 of the channel to access (1 - [max channels for module]).
type: (Input) Current Type: refer to naibrd_ds_expected_current_type_t definitions.
inThresCurrent: (Input) Write the threshold current for a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_DS_SetThresholdVoltage()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DS_SetThresholdVoltage ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_ds_threshold_voltage_type_t type,
float64_t inThresVolt )

Sets the expected reference and output line-line threshold voltage for a specified channel in a D/S 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 of the channel to access (1 - [max channels for module]).
type: (Input) Threshold Voltage Type: refer to naibrd_ds_threshold_voltage_type_t definitions.
inThresVolt: (Input) Write the threshold voltage for a specified channel for a D/S 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_NOT_OPEN when handle to board is invalid.
  • NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_INVALID_VALUE when invalid type parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.