Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.11.1.2
Data Structures | Typedefs | Enumerations | Functions
openapi_timezone.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  open_clocktime_t
 

Typedefs

typedef struct open_clocktime_t open_clocktime
 

Enumerations

enum  OPEN_ST_NON_RECURRING_PARAM_t {
  OPEN_ST_NON_RECURRING_PARAM_START_DAY = 1, OPEN_ST_NON_RECURRING_PARAM_START_MONTH, OPEN_ST_NON_RECURRING_PARAM_START_YEAR, OPEN_ST_NON_RECURRING_PARAM_START_HOUR,
  OPEN_ST_NON_RECURRING_PARAM_START_MINUTE, OPEN_ST_NON_RECURRING_PARAM_END_DAY, OPEN_ST_NON_RECURRING_PARAM_END_MONTH, OPEN_ST_NON_RECURRING_PARAM_END_YEAR,
  OPEN_ST_NON_RECURRING_PARAM_END_HOUR, OPEN_ST_NON_RECURRING_PARAM_END_MINUTE, OPEN_ST_NON_RECURRING_PARAM_OFFSET_MINUTES, OPEN_ST_NON_RECURRING_PARAM_ZONE_ACRONYM
}
 OpEN uses this enumeration to define the summer time non recurring parameters. More...
 
enum  OPEN_ST_RECURRING_PARAM_t {
  OPEN_ST_RECURRING_PARAM_START_DAY = 1, OPEN_ST_RECURRING_PARAM_START_MONTH, OPEN_ST_RECURRING_PARAM_START_WEEK, OPEN_ST_RECURRING_PARAM_START_HOUR,
  OPEN_ST_RECURRING_PARAM_START_MINUTE, OPEN_ST_RECURRING_PARAM_END_DAY, OPEN_ST_RECURRING_PARAM_END_MONTH, OPEN_ST_RECURRING_PARAM_END_WEEK,
  OPEN_ST_RECURRING_PARAM_END_HOUR, OPEN_ST_RECURRING_PARAM_END_MINUTE, OPEN_ST_RECURRING_PARAM_OFFSET_MINUTES, OPEN_ST_RECURRING_PARAM_ZONE_ACRONYM
}
 OpEN uses this enumeration to define the summer time recurring parameters. More...
 
enum  OPEN_SUMMER_TIME_MODE_t {
  OPEN_NO_SUMMER_TIME_MODE = 0, OPEN_SUMMER_TIME_MODE_RECURRING, OPEN_SUMMER_TIME_MODE_RECURRING_EU, OPEN_SUMMER_TIME_MODE_RECURRING_USA,
  OPEN_SUMMER_TIME_MODE_NON_RECURRING
}
 OpEN uses this enumeration to define summer time mode. More...
 

Functions

open_error_t openapiAdjustedTimeGet (openapiClientHandle_t *client_handle, uint32_t *year, uint32_t *month, uint32_t *day, uint32_t *hour, uint32_t *minutes, uint32_t *seconds)
 Adjusts current time for timezone and summer time. More...
 
open_error_t openapiMinutesOffsetConvert (openapiClientHandle_t *client_handle, int32_t minutes, uint32_t *pHour, uint32_t *pMin)
 Convert minute offset into hour and minutes. More...
 
uint32_t openapiRawAdjustedTimeGet (openapiClientHandle_t *client_handle, uint32_t rawTime)
 Converts the given Raw time to UTC and then adds the timezone and summer time offsets if configured. More...
 
open_error_t openapiStModeGet (openapiClientHandle_t *client_handle, OPEN_SUMMER_TIME_MODE_t *mode)
 Get the summer-time mode. More...
 
open_error_t openapiStModeSet (openapiClientHandle_t *client_handle, OPEN_SUMMER_TIME_MODE_t mode)
 Set the summer-time mode. More...
 
open_error_t openapiStNonRecurringGet (openapiClientHandle_t *client_handle, OPEN_ST_NON_RECURRING_PARAM_t parameter, open_buffdesc *bufd)
 Get non-recurring summertime parameters. More...
 
open_error_t openapiStNonRecurringSet (openapiClientHandle_t *client_handle, OPEN_ST_NON_RECURRING_PARAM_t parameter, open_buffdesc *bufd)
 Set non-recurring summertime parameters. More...
 
open_error_t openapiStRecurringGet (openapiClientHandle_t *client_handle, OPEN_ST_RECURRING_PARAM_t parameter, open_buffdesc *bufd)
 Get recurring summertime parameters. More...
 
open_error_t openapiStRecurringSet (openapiClientHandle_t *client_handle, OPEN_ST_RECURRING_PARAM_t parameter, open_buffdesc *bufd)
 Set recurring summertime parameters. More...
 
OPEN_BOOL_t openapiSummerTimeIsInEffect (openapiClientHandle_t *client_handle)
 know whether the summer-time is in effect or not. More...
 
open_error_t openapiSystemTimeZoneAcronymGet (openapiClientHandle_t *client_handle, open_buffdesc *zoneName)
 Gets the timezone acronym string. More...
 
open_error_t openapiTimeConvert (openapiClientHandle_t *client_handle, open_buffdesc *bufd, uint32_t *pHour, uint32_t *pMin)
 Convert hh:mm string to int values. More...
 
open_error_t openapiTimeZoneAcronymGet (openapiClientHandle_t *client_handle, open_buffdesc *acronym)
 Get the time zone acronym parameter. More...
 
open_error_t openapiTimeZoneAcronymSet (openapiClientHandle_t *client_handle, open_buffdesc *acronym)
 Set the time zone acronym parameter. More...
 
open_error_t openapiUTCTimeGet (openapiClientHandle_t *client_handle, open_clocktime *ct)
 Get the current UTC time since the Unix Epoch. More...
 
int32_t openapiUTCTimeNow (openapiClientHandle_t *client_handle)
 Get the current synchronized UTC time since the Unix Epoch. More...
 
open_error_t openapiWeekNumberGet (openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t *number)
 Convert month name to number value. More...