Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
IRIG Capture Event Functions
IRIG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetCaptureEventTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_capture_event_time_t captureEventTimeStruct)
 Sets the Capture Event Time for the specified IRIG channel based on the values in the structure passed in. Write any value to reset the capture register. The format of each value in the structure is as follows: Hour: 0-255, Minute: 0-59, Second: 0-59, Tenth of Second: 0-9, Hundredth of Second: 0-9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_capture_event_time_t *p_outcaptureEventTimeStruct)
 Retrieves the Capture Event Time for the specified IRIG channel. The format of each value in the structure is as follows: Hour: 0-255, Minute: 0-59, Second: 0-59, Tenth of Second: 0-9, Hundredth of Second: 0-9.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventTimeMSec (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcaptureEventTimeMSec)
 Retrieves the Capture Event Time in milliseconds for the specified IRIG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventTimeFraction (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outcaptureEventTimeFraction)
 Retrieves the Capture Event Time Fraction of mSec for the specified IRIG channel. The LSB of the register is 8.33333 nsec.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetCaptureEventEdge (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_capture_event_edge_type_t captureEventEdge)
 Sets the Capture Event Edge to Rising Edge or Falling Edge for the specified IRIG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventEdge (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_capture_event_edge_type_t *p_outcaptureEventEdge)
 Retrieves the Capture Event Edge (Rising Edge or Falling Edge) for the specified IRIG channel.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventInputState (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_capture_event_input_state_type_t *p_outcaptureEventInputState)
 Retrieves the current Capture Event Input State for the specified IRIG channel.
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetCaptureEventEdge()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventEdge ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_capture_event_edge_type_t * p_outcaptureEventEdge )

Retrieves the Capture Event Edge (Rising Edge or Falling Edge) for the specified IRIG 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_outcaptureEventEdge: (Output) Rising Edge or Falling Edge: refer to naibrd_irig_capture_event_edge_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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetCaptureEventInputState()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventInputState ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_capture_event_input_state_type_t * p_outcaptureEventInputState )

Retrieves the current Capture Event Input State for the specified IRIG 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_outcaptureEventInputState: (Output) Input State: refer to naibrd_irig_capture_event_input_state_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_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetCaptureEventTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_capture_event_time_t * p_outcaptureEventTimeStruct )

Retrieves the Capture Event Time for the specified IRIG channel. The format of each value in the structure is as follows: Hour: 0-255, Minute: 0-59, Second: 0-59, Tenth of Second: 0-9, Hundredth of Second: 0-9.

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_outcaptureEventTimeStruct: (Output) Structure of Capture Event Time Hour, Minute, Second, Tenth, and Hundredth.
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_IRIG_GetCaptureEventTimeFraction()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventTimeFraction ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outcaptureEventTimeFraction )

Retrieves the Capture Event Time Fraction of mSec for the specified IRIG channel. The LSB of the register is 8.33333 nsec.

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_outcaptureEventTimeFraction: (Output) Capture Event Time Fraction in units of 8.33333 nanoseconds.
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_IRIG_GetCaptureEventTimeMSec()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetCaptureEventTimeMSec ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outcaptureEventTimeMSec )

Retrieves the Capture Event Time in milliseconds for the specified IRIG 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_outcaptureEventTimeMSec: (Output) Capture Event Time milliseconds.
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_IRIG_SetCaptureEventEdge()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetCaptureEventEdge ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_capture_event_edge_type_t captureEventEdge )

Sets the Capture Event Edge to Rising Edge or Falling Edge for the specified IRIG 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]).
captureEventEdge: (Input) Rising Edge or Falling Edge: refer to naibrd_irig_capture_event_edge_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 captureEventEdge parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetCaptureEventTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetCaptureEventTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_capture_event_time_t captureEventTimeStruct )

Sets the Capture Event Time for the specified IRIG channel based on the values in the structure passed in. Write any value to reset the capture register. The format of each value in the structure is as follows: Hour: 0-255, Minute: 0-59, Second: 0-59, Tenth of Second: 0-9, Hundredth of Second: 0-9.

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]).
captureEventTimeStruct: (Input) Structure of Capture Event Time Hour, Minute, Second, Tenth, and Hundredth 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_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.