Time.hpp

Go to the documentation of this file.

#ifndef FW_TIME_HPP
#define FW_TIME_HPP

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Types/Assert.hpp>
#include <Fw/Types/Serializable.hpp>

namespace Fw {
    class Time: public Serializable {

        friend class TimeTester;

        public:

            enum {
                SERIALIZED_SIZE = sizeof(FwTimeBaseStoreType)
                    + sizeof(FwTimeContextStoreType)
                    + sizeof(U32) + sizeof(U32)
            };

            Time(); // !< Default constructor
            Time(const Time& other); // !< Copy constructor
            Time(U32 seconds, U32 useconds); // !< Constructor with member values as arguments
            Time(TimeBase timeBase, U32 seconds, U32 useconds); // !< Constructor with member values as arguments
            Time(TimeBase timeBase, FwTimeContextStoreType context, U32 seconds, U32 useconds); // !< Constructor with member values as arguments
            virtual ~Time(); // !< Destructor
            void set(U32 seconds, U32 useconds); // !< Sets value of time stored
            void set(TimeBase timeBase, U32 seconds, U32 useconds); // !< Sets value of time stored
            void set(TimeBase timeBase, FwTimeContextStoreType context, U32 seconds, U32 useconds); // !< Sets value of time stored
            void setTimeBase(TimeBase timeBase);
            void setTimeContext(FwTimeContextStoreType context);
            U32 getSeconds() const; // !< Gets seconds part of time
            U32 getUSeconds() const; // !< Gets microseconds part of time
            TimeBase getTimeBase() const; // !< Time base of time. This is project specific and is meant for indicating different sources of time
            FwTimeContextStoreType getContext() const; // !< get the context value
            SerializeStatus serialize(SerializeBufferBase& buffer) const; // !< Serialize method
            SerializeStatus deserialize(SerializeBufferBase& buffer); // !< Deserialize method
            bool operator==(const Time& other) const;
            bool operator!=(const Time& other) const;
            bool operator>(const Time& other) const;
            bool operator<(const Time& other) const;
            bool operator>=(const Time& other) const;
            bool operator<=(const Time& other) const;
            Time& operator=(const Time& other);

            // Static methods:
            typedef enum {
              LT = -1,
              EQ = 0,
              GT = 1,
              INCOMPARABLE = 2
            } Comparison;

            static Time zero(TimeBase timeBase=TB_NONE);

            static Comparison compare(
                const Time &time1, 
                const Time &time2 
            );

            static Time add(
                const Time& a, 
                const Time& b 
            );

            static Time sub(
                const Time& minuend, 
                const Time& subtrahend 
            );

            // add seconds and microseconds to existing time
            void add(U32 seconds, U32 mseconds);

#ifdef BUILD_UT // Stream operators to support Googletest
            friend std::ostream& operator<<(std::ostream& os,  const Time& val);
#endif
        private:
            U32 m_seconds; // !< seconds portion
            U32 m_useconds; // !< microseconds portion
            TimeBase m_timeBase; // !< basis of time (defined by system)
            FwTimeContextStoreType m_timeContext; // !< user settable value. Could be reboot count, node, etc
    };
    extern const Time ZERO_TIME;

}

#endif