BTimeStamp.h

Go to the documentation of this file.

/*******************************************************************************
 *  BTimeStamp.h    TimeStamp classes
 *  T.Barnaby,  BEAM Ltd,   2008-06-26
 *  Copyright (c) 2022 All Right Reserved, Beam Ltd, https://www.beam.ltd.uk
 *  For license see LICENSE.txt at the root of the beamlib source tree.
 *******************************************************************************
 */
#ifndef BTimeStamp_H
#define BTimeStamp_H    1
 
#include <stdint.h>
#include <BError.h>
 
class BTimeStampMs;
 
class BTimeStamp {
public:
            BTimeStamp();
            BTimeStamp(int year, int month = 1, int day = 1, int hour = 0, int minute = 0, int second = 0, int microsecond = 0);
            BTimeStamp(const BString str);
            ~BTimeStamp();
    
    void        clear();                
    void        setFirst();             
    void        setLast();              
 
    void        set(time_t time, int microSeconds); 
    void        set(int year = 0, int month = 1, int day = 1, int hour = 0, int minute = 0, int second = 0, int microsecond = 0);
    void        set(const BTimeStampMs& timeStamp);     
    void        setYDay(int year = 0, int yday = 0, int hour = 0, int minute = 0, int second = 0, int microsecond = 0);
    void        setTime(int hour = 0, int minute = 0, int second = 0, int microsecond = 0);
    void        setNow();               
 
    int     year() const;
    int     yday() const;
    int     month() const;
    int     day() const;
    int     hour() const;
    int     minute() const;
    int     second() const;
    int     microSecond() const;
    
    void        getDate(int& year, int& mon, int& day) const;
 
    BString     getString(BString separator = "T") const;   
    BError      setString(const BString dateTime);      
    BString     getStringNoMs(BString separator = "T") const;   
    BString     getStringFormatted(BString format) const;   
    
    void        addMilliSeconds(int milliSeconds);  
    void        addMicroSeconds(int64_t microSeconds);  
    void        addSeconds(int seconds);        
    uint32_t    getYearSeconds() const;         
    uint64_t    getYearMicroSeconds() const;            
 
    int     isSet() const{ return oyear != 0; }
    int     compare(const BTimeStamp& timeStamp) const; 
 
            operator BString() const { return getString(); }
    BTimeStamp& operator=(const BTimeStampMs& timeStamp){ set(timeStamp); return *this; }
 
    int     operator==(const BTimeStamp& timeStamp) const { return (compare(timeStamp) == 0); }
    int     operator!=(const BTimeStamp& timeStamp) const { return (compare(timeStamp) != 0); }
    int     operator>(const BTimeStamp& timeStamp) const { return (compare(timeStamp) > 0); }
    int     operator>=(const BTimeStamp& timeStamp) const { return (compare(timeStamp) >= 0); }
    int     operator<(const BTimeStamp& timeStamp) const { return (compare(timeStamp) < 0); }
    int     operator<=(const BTimeStamp& timeStamp) const { return (compare(timeStamp) <= 0); }
 
    static int  isLeap(int year);
    static BInt64   difference(BTimeStamp t2, BTimeStamp t1);
 
public:
    BUInt16     oyear;      
    BUInt16     oyday;      
    BUInt8      ohour;      
    BUInt8      ominute;    
    BUInt8      osecond;    
    BUInt8      ospare;     
    BUInt32     omicroSecond;   
};
 
// String conversion functions
void toBString(BTimeStamp& v, BString& s);
void fromBString(BString& s, BTimeStamp& v);
 
#endif