openapi_timezone.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_timezone.h
*
* @purpose   This code implements the Open Api for the timesZone API
*
* @component OPEN
*
* @create    01/03/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_TIMEZONE_H_INCLUDED
#define OPENAPI_TIMEZONE_H_INCLUDED

#include "openapi_common.h" 

typedef enum
{
  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_SUMMER_TIME_MODE_t;

typedef enum
{
  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_ST_RECURRING_PARAM_t;

typedef enum
{
  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_ST_NON_RECURRING_PARAM_t;

typedef struct open_clocktime_t
{
  time_t seconds;
  time_t nanoseconds;
} open_clocktime;

/*************************************************************************/
open_error_t openapiTimeConvert(openapiClientHandle_t *client_handle, open_buffdesc *bufd, uint32_t *pHour, uint32_t *pMin);

/*************************************************************************/
open_error_t openapiMinutesOffsetConvert(openapiClientHandle_t *client_handle, int32_t minutes, uint32_t *pHour, uint32_t *pMin);

/*************************************************************************/
open_error_t openapiWeekNumberGet(openapiClientHandle_t *client_handle, open_buffdesc *name, uint32_t *number);

/*************************************************************************/
open_error_t openapiTimeZoneAcronymSet(openapiClientHandle_t *client_handle, open_buffdesc *acronym);

/*************************************************************************/
open_error_t openapiTimeZoneAcronymGet(openapiClientHandle_t *client_handle, open_buffdesc *acronym);

/*************************************************************************/
open_error_t openapiStNonRecurringGet(openapiClientHandle_t *client_handle, OPEN_ST_NON_RECURRING_PARAM_t parameter, open_buffdesc *bufd);

/*************************************************************************/
open_error_t openapiStRecurringGet(openapiClientHandle_t *client_handle, OPEN_ST_RECURRING_PARAM_t parameter, open_buffdesc *bufd);

/*************************************************************************/
open_error_t openapiStRecurringSet(openapiClientHandle_t *client_handle, OPEN_ST_RECURRING_PARAM_t parameter, open_buffdesc *bufd);

/*************************************************************************/
open_error_t openapiStNonRecurringSet(openapiClientHandle_t *client_handle, OPEN_ST_NON_RECURRING_PARAM_t parameter, open_buffdesc *bufd);

/*************************************************************************/
open_error_t openapiStModeGet(openapiClientHandle_t *client_handle, OPEN_SUMMER_TIME_MODE_t *mode);

/*************************************************************************/
open_error_t openapiStModeSet(openapiClientHandle_t *client_handle, OPEN_SUMMER_TIME_MODE_t mode);

/*************************************************************************/
open_error_t openapiSystemTimeZoneAcronymGet(openapiClientHandle_t *client_handle, open_buffdesc *zoneName);

/*************************************************************************/
int32_t openapiUTCTimeNow(openapiClientHandle_t *client_handle );

/*************************************************************************/
open_error_t openapiUTCTimeGet(openapiClientHandle_t *client_handle, open_clocktime * ct);

/*************************************************************************/
OPEN_BOOL_t openapiSummerTimeIsInEffect(openapiClientHandle_t *client_handle);

/*************************************************************************/
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);

/*************************************************************************/
uint32_t openapiRawAdjustedTimeGet(openapiClientHandle_t *client_handle, uint32_t rawTime);


#endif /* OPENAPI__H_INCLUDED */