TimeInterval.hpp

Go to the documentation of this file.

#ifndef FW_TIME_INTERVAL_HPP
#define FW_TIME_INTERVAL_HPP

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

namespace Fw {

    class TimeInterval: public Serializable {
        public:

            enum {
                SERIALIZED_SIZE = sizeof(U32) * 2
            };

            TimeInterval() = default; // !< Default constructor
            ~TimeInterval() = default; // !< Default destructor
            TimeInterval(const TimeInterval& other); // !< Copy constructor
            TimeInterval(U32 seconds, U32 useconds); // !< Constructor with member values as arguments
            void set(U32 seconds, U32 useconds); // !< Sets value of time stored
            U32 getSeconds() const; // !< Gets seconds part of time
            U32 getUSeconds() const; // !< Gets microseconds part of time
            SerializeStatus serialize(SerializeBufferBase& buffer) const; // !< Serialize method
            SerializeStatus deserialize(SerializeBufferBase& buffer); // !< Deserialize method
            void add(U32 seconds, U32 mseconds); // !< Add seconds and microseconds to existing time interval
            bool operator==(const TimeInterval& other) const;
            bool operator!=(const TimeInterval& other) const;
            bool operator>(const TimeInterval& other) const;
            bool operator<(const TimeInterval& other) const;
            bool operator>=(const TimeInterval& other) const;
            bool operator<=(const TimeInterval& other) const;
            TimeInterval& operator=(const TimeInterval& other);

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

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

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

            static TimeInterval sub(
                const TimeInterval& t1, 
                const TimeInterval& t2 
            );



#ifdef BUILD_UT // Stream operators to support Googletest
            friend std::ostream& operator<<(std::ostream& os,  const TimeInterval& val);
#endif
        PRIVATE:
            U32 m_seconds; // !< seconds portion of TimeInterval
            U32 m_useconds; // !< microseconds portion of TimeInterval
    };

}

#endif