le_clock.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#ifndef LEGATO_CLK_INCLUDE_GUARD
#define LEGATO_CLK_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct
{
    time_t sec;     
    long   usec;    
} le_clk_Time_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define LE_CLK_STRING_FORMAT_DATE_TIME "%c"
#define LE_CLK_STRING_FORMAT_DATE     "%x"
#define LE_CLK_STRING_FORMAT_TIME     "%X"
// @}


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_clk_GetRelativeTime(void);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_clk_GetAbsoluteTime(void);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_clk_Add
(
    le_clk_Time_t timeA,
    le_clk_Time_t timeB
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_clk_GreaterThan
(
    le_clk_Time_t timeA,
    le_clk_Time_t timeB
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_clk_Equal
(
    le_clk_Time_t timeA,
    le_clk_Time_t timeB
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_clk_Sub
(
    le_clk_Time_t timeA,
    le_clk_Time_t timeB
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_clk_Time_t le_clk_Multiply
(
    le_clk_Time_t timeA,
    int scaleFactor
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_clk_GetUTCDateTimeString
(
    const char* formatSpecStrPtr,  
    char*   destStrPtr,            
    size_t  destSize,              
    size_t* numBytesPtr            

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_clk_GetLocalDateTimeString
(
    const char* formatSpecStrPtr,  
    char*   destStrPtr,            
    size_t  destSize,              
    size_t* numBytesPtr            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_clk_ConvertToUTCString
(
    le_clk_Time_t time,            
    const char* formatSpecStrPtr,  
    char*   destStrPtr,            
    size_t  destSize,              
    size_t* numBytesPtr            

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_clk_ConvertToLocalTimeString
(
    le_clk_Time_t time,            
    const char* formatSpecStrPtr,  
    char*   destStrPtr,            
    size_t  destSize,              
    size_t* numBytesPtr            

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_clk_SetAbsoluteTime
(
    le_clk_Time_t absoluteTime  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API le_result_t le_clk_ConvertToTime
(
    const char*    formatSpecStrPtr,    
    const char*    srcStrPtr,           
    le_clk_Time_t* timePtr              
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
LE_FULL_API le_result_t le_clk_SetUTCDateTimeString
(
    const char* formatSpecStrPtr,   
    const char* srcStrPtr           
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_clk_SetTimezoneFile
(
    const int32_t timezoneOffsetSeconds, 
    const uint8_t dstOffsetHours         
);

#endif // LEGATO_CLK_INCLUDE_GUARD