Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
Module Properties Functions
Discrete Switch Module Functions

Functions

NAIBRDFUNC int32_t NAIAPI naibrd_DSW_GetChannelCount (uint32_t modid)
 Returns the number of channels for the specified Discrete Switch Module ID.
 
NAIBRDFUNC int32_t NAIAPI naibrd_DSW_GetGroupCount (uint32_t modid)
 Returns the number of channel groups for the specified Discrete Switch Module ID.
 
NAIBRDFUNC int32_t NAIAPI naibrd_DSW_GetGroupSize (uint32_t modid)
 Returns the number of channels in each group for the specified Discrete Switch Module ID.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetVoltageLSB (int32_t cardIndex, int32_t module, float64_t *outvoltageLSB)
 Retrieves the Voltage LSB unit value for the all the DSW channels on the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetCurrentLSB (int32_t cardIndex, int32_t module, float64_t *outcurrentLSB)
 Retrieves the Current LSB unit value for the all the DSW channels on the module.
 
NAIBRDFUNC float64_t NAIAPI naibrd_DSW_GetTimebaseLSB (uint32_t modid)
 Returns the LSB for the timer interval for Measurement, PWM and Pattern Generator clocks for the specified DSW Module ID.
 
NAIBRDFUNC uint32_t NAIAPI naibrd_DSW_GetValidPatternGenStart (uint32_t modid)
 Returns the LSB for the timer interval for Measurement, PWM and Pattern Generator clocks for the specified DSW Module ID.
 
NAIBRDFUNC uint32_t NAIAPI naibrd_DSW_GetValidPatternGenEnd (uint32_t modid)
 Returns the LSB for the timer interval for Measurement, PWM and Pattern Generator clocks for the specified DSW Module ID.
 

Detailed Description


Function Documentation

◆ naibrd_DSW_GetChannelCount()

NAIBRDFUNC int32_t NAIAPI naibrd_DSW_GetChannelCount ( uint32_t modid)

Returns the number of channels for the specified Discrete Switch Module ID.

Parameters
modid: (Input) Discrete Switch Module ID
Returns
  • Number of channels for the Module ID.

◆ naibrd_DSW_GetCurrentLSB()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetCurrentLSB ( int32_t cardIndex,
int32_t module,
float64_t * outcurrentLSB )

Retrieves the Current LSB unit value for the all the DSW channels on the 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]).
outcurrentLSB: (Output) Current LSB.
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_DSW_GetGroupCount()

NAIBRDFUNC int32_t NAIAPI naibrd_DSW_GetGroupCount ( uint32_t modid)

Returns the number of channel groups for the specified Discrete Switch Module ID.

Parameters
modid: (Input) Discrete Switch Module ID
Returns
  • Number of channel groups for the Module ID.

◆ naibrd_DSW_GetGroupSize()

NAIBRDFUNC int32_t NAIAPI naibrd_DSW_GetGroupSize ( uint32_t modid)

Returns the number of channels in each group for the specified Discrete Switch Module ID.

Parameters
modid: (Input) Discrete Switch Module ID
Returns
  • Number of channels in each group for the Module ID.

◆ naibrd_DSW_GetTimebaseLSB()

NAIBRDFUNC float64_t NAIAPI naibrd_DSW_GetTimebaseLSB ( uint32_t modid)

Returns the LSB for the timer interval for Measurement, PWM and Pattern Generator clocks for the specified DSW Module ID.

Parameters
modid: (Input) DSW Module ID
Returns
  • LSB for the module clock interval.

◆ naibrd_DSW_GetValidPatternGenEnd()

NAIBRDFUNC uint32_t NAIAPI naibrd_DSW_GetValidPatternGenEnd ( uint32_t modid)

Returns the LSB for the timer interval for Measurement, PWM and Pattern Generator clocks for the specified DSW Module ID.

Parameters
modid: (Input) DSW Module ID
Returns
  • LSB for the module clock interval.

◆ naibrd_DSW_GetValidPatternGenStart()

NAIBRDFUNC uint32_t NAIAPI naibrd_DSW_GetValidPatternGenStart ( uint32_t modid)

Returns the LSB for the timer interval for Measurement, PWM and Pattern Generator clocks for the specified DSW Module ID.

Parameters
modid: (Input) DSW Module ID
Returns
  • LSB for the module clock interval.

◆ naibrd_DSW_GetVoltageLSB()

NAIBRDFUNC nai_status_t NAIAPI naibrd_DSW_GetVoltageLSB ( int32_t cardIndex,
int32_t module,
float64_t * outvoltageLSB )

Retrieves the Voltage LSB unit value for the all the DSW channels on the 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]).
outvoltageLSB: (Output) Voltage LSB.
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.