BTime.h

Go to the documentation of this file.

/*******************************************************************************
 *  BTime.h BTime functions
 *  T.Barnaby,  Beam Ltd,   2012-11-12
 *  Copyright (c) 2012 All Right Reserved, Beam Ltd, http://www.beam.ltd.uk
 *******************************************************************************
 *
 * Implements a simple date/time class. Stores the date/time as a number of seconds
 *  since 1970-01-02T00:00:00. Has a range until 2106-02-07.
 *
 * Uses some sepcial values.
 *  0 - DateTime not set.
 */
#ifndef BTime_h
#define BTime_h

#include <BTypes.h>
#include <BError.h>
#include <BString.h>

class BTime {
public:
            BTime(BUInt32 t = 0);
    
    void        set(BUInt32 seconds);                                   
    void        set(BUInt year, BUInt month, BUInt day, BUInt hour = 0, BUInt minute = 0, BUInt second = 0);    
    void        setYearDay(BUInt year, BUInt yearDay, BUInt hour = 0, BUInt minute = 0, BUInt second = 0);  
    
    void        getDate(BUInt& year, BUInt& month, BUInt& day) const;       
    void        getTime(BUInt& hour, BUInt& minute, BUInt& second) const;   
    BUInt32     getSeconds() const;                     

    int     isSet() const{ return otime != 0; }         
    int     isLeapYear();                       
    void        addSeconds(int seconds);                

    BString     getString(BString format = "isoT") const;       
    BError      setString(const BString dateTime);                  
    
            // Operator functions
    int     operator==(const BTime& time) const { return (otime == time.otime); }
    int     operator!=(const BTime& time) const { return (otime != time.otime); }
    int     operator>(const BTime& time) const { return (otime > time.otime); }
    int     operator>=(const BTime& time) const { return (otime >= time.otime); }
    int     operator<(const BTime& time) const { return (otime < time.otime); }
    int     operator<=(const BTime& time) const { return (otime <= time.otime); }
    BTime       operator+(int seconds) const { return BTime(getSeconds() + seconds); }
    BTime&      operator+=(int seconds){ addSeconds(seconds); return *this; }

private:
    BUInt32     otime;      
};

#endif