Software Library API naibrd 2.24.0
See all documentation at naii.docs.com
IRIG Basic Configuration Functions: Free Running Time

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetFreeRunningTimeAndDate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_master_timer_info_t IRIGTimerInfoStruct)
 Load time and date to master timer only if free-running (nominally for test when IRIG is not available). After the time and date for the free running time, this function also loads it content to the master time. The reference source should be set to (Free-Running or No reference).
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetFreeRunningTimeAndDate (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_master_timer_info_t *p_outIRIGTimerInfoStruct)
 Get free-running time and date from master timer (nominally for test).
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetFreeRunningTimeAndDate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetFreeRunningTimeAndDate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_master_timer_info_t * p_outIRIGTimerInfoStruct )

Get free-running time and date from master timer (nominally for test).

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_outIRIGTimerInfoStruct: (Output) Pointer to a naibrd_irig_master_timer_info_t struct that contains the following member variables:
       year                         Two-digit year
       day                          Day of year
       hour                         Hour (0-23)
       minute                       Minute
       second                       Second
       microSecond                  Microsecond
       secondsSinceMidnight         Seconds elapsed since 00:00:00
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_SetFreeRunningTimeAndDate()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetFreeRunningTimeAndDate ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_master_timer_info_t IRIGTimerInfoStruct )

Load time and date to master timer only if free-running (nominally for test when IRIG is not available). After the time and date for the free running time, this function also loads it content to the master time. The reference source should be set to (Free-Running or No reference).

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]).
IRIGTimerInfoStruct: (Input) A naibrd_irig_master_timer_info_t struct that contains the following member variables:
       year                         Two-digit year
       day                          Day of year
       hour                         Hour (0-23)
       minute                       Minute
       second                       Second
       microSecond                  Microsecond
       secondsSinceMidnight         Seconds elapsed since 00:00:00
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.