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

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetMasterTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_master_timer_info_t *p_outIrigInfoStruct)
 Gets the date and time from the master timer. The master time is derived from either IRIG, onboard real-time clock (RTC) reference source or free running timer when IRIG signal is not locked/presented.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetActualIRIGDateAndTime (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_master_timer_info_t *p_outIrigInfoStruct, uint32_t *p_outErroredFrameCount)
 Gets the actual IRIG message date and time from the IRIG input. The readings are valid only if IRIG messages are being received. Also gets the number of IRIG frame errors detected by the module.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_ClearErroredFrameCount (int32_t cardIndex, int32_t module, int32_t channel)
 Clear the errored frame count. The errored frame count will be incremented when the received IRIG signal does not match the expected format. This function clears the secondary output p_outErroredFrameCount of naibrd_IRIG_GetActualIRIGDateAndTime.
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_ClearErroredFrameCount()

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

Clear the errored frame count. The errored frame count will be incremented when the received IRIG signal does not match the expected format. This function clears the secondary output p_outErroredFrameCount of naibrd_IRIG_GetActualIRIGDateAndTime.

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 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_GetActualIRIGDateAndTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetActualIRIGDateAndTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_master_timer_info_t * p_outIrigInfoStruct,
uint32_t * p_outErroredFrameCount )

Gets the actual IRIG message date and time from the IRIG input. The readings are valid only if IRIG messages are being received. Also gets the number of IRIG frame errors detected by 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]).
channel: (Input) Channel Number of the channel to access (1 - [max channels for module]).
p_outIrigInfoStruct: (Output) Pointer to a naibrd_irig_master_timer_info_t struct that will contain 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
p_outErroredFrameCount: (Output) Count of errored receive frames, based on reference pulse positions.
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_GetMasterTime()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetMasterTime ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_master_timer_info_t * p_outIrigInfoStruct )

Gets the date and time from the master timer. The master time is derived from either IRIG, onboard real-time clock (RTC) reference source or free running timer when IRIG signal is not locked/presented.

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_outIrigInfoStruct: (Output) Pointer to a naibrd_irig_master_timer_info_t struct that will contain 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.