mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 00:44:37 -06:00
48e4720419
* Created new SerialBufferBase as a parent of SerializeBufferBase. Renaming interface functions to be less confusing. * Deprecating copyRawOffset. No direct use-cases in F' core. * Make SerialBufferBase a true pure virtual interface. * Changing Serializable to work with SerialBufferBase parent interface. * Changing copyRaw and copyRawOffset to work with SerialBufferBase * Updating documentation for SerialBufferBase usage * Adding some documentation. Adding missing ASSERT in copyRaw. Fixing some bugs that new ASSERT uncovered. * Renaming SerializeBufferBase to LinearBufferBase. Add a using declaration to maintain backwards compatability. Properly mark LinearBufferBase functions as override. * Filling in the rest of the docstrings for the classes in Serializable * Removing redundant virtual keyword on override function * Applying clang formatting * Incorporating PR comments * Fix compile issues * Bump version to alpha * Format * v --------- Co-authored-by: M Starch <LeStarch@googlemail.com>
83 lines
3.8 KiB
C++
83 lines
3.8 KiB
C++
#ifndef FW_TIME_INTERVAL_HPP
|
|
#define FW_TIME_INTERVAL_HPP
|
|
|
|
#include <Fw/FPrimeBasicTypes.hpp>
|
|
#include <Fw/Time/Time.hpp>
|
|
#include <Fw/Time/TimeIntervalValueSerializableAc.hpp>
|
|
#include <Fw/Types/Assert.hpp>
|
|
#include <Fw/Types/Serializable.hpp>
|
|
|
|
//!
|
|
//! @class TimeInterval
|
|
//! @brief A class to represent a time interval holding two U32 seconds and microseconds values.
|
|
//!
|
|
//! The TimeInterval class is designed to hold a time interval and provides various methods
|
|
//! to manipulate and compare time intervals. It supports serialization and deserialization
|
|
//! for easy storage and transmission.
|
|
//!
|
|
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
|
|
TimeInterval(const Time& start, const Time& end); // !< Constructor with start / end times 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 serializeTo(SerialBufferBase& buffer,
|
|
Fw::Endianness mode = Fw::Endianness::BIG) const override; // !< Serialize method
|
|
SerializeStatus deserializeFrom(SerialBufferBase& buffer,
|
|
Fw::Endianness mode = Fw::Endianness::BIG) override; // !< 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);
|
|
|
|
//! The type of a comparison result
|
|
typedef enum { LT = -1, EQ = 0, GT = 1, INCOMPARABLE = 2 } Comparison;
|
|
|
|
//! Compare two time intervals
|
|
//! A time interval is considered greater than another if it spans a longer duration
|
|
//! The comparison is done on the seconds first, then the microseconds if the seconds are equal
|
|
//! \return TimeInterval result
|
|
static Comparison compare(const TimeInterval& time1, //!< TimeInterval 1
|
|
const TimeInterval& time2 //!< TimeInterval 2
|
|
);
|
|
|
|
//! Add two time intervals
|
|
//! Adds the seconds and microseconds fields of two time intervals together
|
|
//! \return TimeInterval result
|
|
static TimeInterval add(const TimeInterval& a, //!< TimeInterval a
|
|
const TimeInterval& b //!< TimeInterval b
|
|
);
|
|
|
|
//! Subtract two time intervals
|
|
//! This computes the absolute value of the difference between two time intervals
|
|
//! For example if t1=(0s, 5us) and t2=(0s, 3us), the result is (0s, 2us).
|
|
//! This operation is commutative, i.e. the result is the same regardless of the order of the arguments.
|
|
//! \return TimeInterval result
|
|
static TimeInterval sub(const TimeInterval& t1, //!< TimeInterval 1
|
|
const TimeInterval& t2 //!< TimeInterval 2
|
|
);
|
|
|
|
#ifdef BUILD_UT // Stream operators to support Googletest
|
|
friend std::ostream& operator<<(std::ostream& os, const TimeInterval& val);
|
|
#endif
|
|
private:
|
|
TimeIntervalValue m_val; // !< TimeInterval value
|
|
};
|
|
|
|
} // namespace Fw
|
|
|
|
#endif
|