Software Library API naibrd 1.62
See all documentation at naii.docs.com
Functions
IRIG Basic Configuration Functions: Daylight Savings Time
IRIG Module Functions

Functions

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_dst_status_type_t *p_outstatus)
 Retrieves the DST (Daylight Savings Time) status from the master time.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDSTOffset (int32_t cardIndex, int32_t module, int32_t channel, uint32_t dstOffset)
 Sets the DST (Daylight Savings Time) Offset. This is the DST adjustment to be added to the master time. BCD adjustment in hmm of hours/minutes. Write 0 to disable DST. Use 0x00000100 in the USA.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTOffset (int32_t cardIndex, int32_t module, int32_t channel, uint32_t *p_outdstOffset)
 Gets the DST (Daylight Savings Time) Offset. This is the DST adjustment to be added to the master time. BCD adjustment in hmm of hours/minutes. Write 0 to disable DST. Use 0x00000100 in the USA.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDSTStart (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_dst_timer_info_t irigDSTInfoStruct)
 Sets the DST (Daylight Savings Time) Start Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTStart (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_dst_timer_info_t *p_outirigDSTInfoStruct)
 Gets the DST (Daylight Savings Time) Start Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDSTEnd (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_dst_timer_info_t irigDSTInfoStruct)
 Sets the DST (Daylight Savings Time) End Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTEnd (int32_t cardIndex, int32_t module, int32_t channel, naibrd_irig_dst_timer_info_t *p_outirigDSTInfoStruct)
 Gets the DST (Daylight Savings Time) End Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDclsPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t propOffset)
 Set the Number of ticks to be added to or subtracted from received IRIG DCLS reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDclsPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outPropOffset)
 Get the number of ticks added to or subtracted from received IRIG DCLS reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModeAPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t propOffset)
 Set the Number of ticks to be added to or subtracted from received IRIG AM Mode A reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModeAPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outPropOffset)
 Get the number of ticks added to or subtracted from received IRIG AM Mode A reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModeBPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t propOffset)
 Set the Number of ticks to be added to or subtracted from received IRIG AM Mode B reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModeBPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outPropOffset)
 Get the number of ticks added to or subtracted from received IRIG AM Mode B reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModeGPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t propOffset)
 Set the Number of ticks to be added to or subtracted from received IRIG AM Mode G reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModeGPropOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outPropOffset)
 Get the number of ticks added to or subtracted from received IRIG AM Mode G reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetTimeZoneOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t timeZoneOffset)
 Set the Number of minutes to be added to or subtracted from received IRIG reference time to accommodate time zone differences. Range : +/-1439 To be added to the master time. BCD adjustment in hmm of hours/minutes. Write 0 to disable DST. Use 0x00000100 in the USA.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetTimeZoneOffset (int32_t cardIndex, int32_t module, int32_t channel, int32_t *p_outTimeZoneOffset)
 Get the number of minutes added to or subtracted from received IRIG reference time to accommodate time zone differences. Range : +/-1439.
 

Detailed Description


Function Documentation

◆ naibrd_IRIG_GetDclsPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDclsPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outPropOffset )

Get the number of ticks added to or subtracted from received IRIG DCLS reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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_outPropOffset: (Output) Propagation Offset (valid range: -1199999999 to 1199999999).
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_GetDSTEnd()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTEnd ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_dst_timer_info_t * p_outirigDSTInfoStruct )

Gets the DST (Daylight Savings Time) End Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.

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_outirigDSTInfoStruct: (Output) Structure of DST End Month, Day, Week, Hour, and Minute.
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_GetDSTOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t * p_outdstOffset )

Gets the DST (Daylight Savings Time) Offset. This is the DST adjustment to be added to the master time. BCD adjustment in hmm of hours/minutes. Write 0 to disable DST. Use 0x00000100 in the USA.

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_outdstOffset: (Output) DST Offset in HMM to be added to reference time.
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_GetDSTStart()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTStart ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_dst_timer_info_t * p_outirigDSTInfoStruct )

Gets the DST (Daylight Savings Time) Start Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.

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_outirigDSTInfoStruct: (Output) Structure of DST Start Month, Day, Week, Hour, and Minute.
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_GetDSTStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetDSTStatus ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_dst_status_type_t * p_outstatus )

Retrieves the DST (Daylight Savings Time) status from the master time.

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_outstatus: (Output) IRIG DST Status: refer to naibrd_irig_dst_status_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_INVALID_CHANNEL when invalid channel parameter is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_GetModeAPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModeAPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outPropOffset )

Get the number of ticks added to or subtracted from received IRIG AM Mode A reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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_outPropOffset: (Output) Propagation Offset (valid range: -1199999999 to 1199999999).
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_GetModeBPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModeBPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outPropOffset )

Get the number of ticks added to or subtracted from received IRIG AM Mode B reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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_outPropOffset: (Output) Propagation Offset (valid range: -1199999999 to 1199999999).
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_GetModeGPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetModeGPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outPropOffset )

Get the number of ticks added to or subtracted from received IRIG AM Mode G reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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_outPropOffset: (Output) Propagation Offset (valid range: -1199999999 to 1199999999).
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_GetTimeZoneOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_GetTimeZoneOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t * p_outTimeZoneOffset )

Get the number of minutes added to or subtracted from received IRIG reference time to accommodate time zone differences. Range : +/-1439.

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_outTimeZoneOffset: (Output) Time Zone Offset (valid range: -1439 to 1439).
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_SetDclsPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDclsPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t propOffset )

Set the Number of ticks to be added to or subtracted from received IRIG DCLS reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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]).
propOffset: (Input) Propagation Offset (valid range: -1199999999 to 1199999999).
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 propOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetDSTEnd()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDSTEnd ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_dst_timer_info_t irigDSTInfoStruct )

Sets the DST (Daylight Savings Time) End Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.

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]).
irigDSTInfoStruct: (Input) Structure of DST End Month, Day, Week, Hour, and Minute 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.

◆ naibrd_IRIG_SetDSTOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDSTOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
uint32_t dstOffset )

Sets the DST (Daylight Savings Time) Offset. This is the DST adjustment to be added to the master time. BCD adjustment in hmm of hours/minutes. Write 0 to disable DST. Use 0x00000100 in the USA.

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]).
dstOffset: (Input) DST Offset in HMM to be added to reference time.
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_SetDSTStart()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetDSTStart ( int32_t cardIndex,
int32_t module,
int32_t channel,
naibrd_irig_dst_timer_info_t irigDSTInfoStruct )

Sets the DST (Daylight Savings Time) Start Time based on the values in the structure passed in. The format of each value in the structure is as follows: Month: 1-12, Day: 0-6; 0=Sunday, Week: 1-5, Hour: 0-23, Minute: 0-59.

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]).
irigDSTInfoStruct: (Input) Structure of DST Start Month, Day, Week, Hour, and Minute 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.

◆ naibrd_IRIG_SetModeAPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModeAPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t propOffset )

Set the Number of ticks to be added to or subtracted from received IRIG AM Mode A reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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]).
propOffset: (Input) Propagation Offset (valid range: -1199999999 to 1199999999).
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 propOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetModeBPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModeBPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t propOffset )

Set the Number of ticks to be added to or subtracted from received IRIG AM Mode B reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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]).
propOffset: (Input) Propagation Offset (valid range: -1199999999 to 1199999999).
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 propOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetModeGPropOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetModeGPropOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t propOffset )

Set the Number of ticks to be added to or subtracted from received IRIG AM Mode G reference pulse time (positive = set in the future, negative = set in the past). Range : +/-10.0 seconds (-1199999999 to 1199999999)

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]).
propOffset: (Input) Propagation Offset (valid range: -1199999999 to 1199999999).
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 propOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.

◆ naibrd_IRIG_SetTimeZoneOffset()

NAIBRDFUNC nai_status_t NAIAPI naibrd_IRIG_SetTimeZoneOffset ( int32_t cardIndex,
int32_t module,
int32_t channel,
int32_t timeZoneOffset )

Set the Number of minutes to be added to or subtracted from received IRIG reference time to accommodate time zone differences. Range : +/-1439 To be added to the master time. BCD adjustment in hmm of hours/minutes. Write 0 to disable DST. Use 0x00000100 in the USA.

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]).
timeZoneOffset: (Input) Time Zone Offset (valid range: -1439 to 1439).
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 timeZoneOffset value is specified.
  • NAI_ERROR_NOT_SUPPORTED when function is not supported.