mirror of
https://github.com/nasa/fprime.git
synced 2025-12-10 17:47:10 -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>
90 lines
3.6 KiB
C++
90 lines
3.6 KiB
C++
#ifndef FW_TIME_HPP
|
|
#define FW_TIME_HPP
|
|
|
|
#include <Fw/FPrimeBasicTypes.hpp>
|
|
#include <Fw/Time/TimeValueSerializableAc.hpp>
|
|
#include <Fw/Types/Assert.hpp>
|
|
#include <Fw/Types/Serializable.hpp>
|
|
#include <config/TimeBaseEnumAc.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 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
|
|
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:
|
|
//! The type of a comparison result
|
|
typedef enum { LT = -1, EQ = 0, GT = 1, INCOMPARABLE = 2 } Comparison;
|
|
|
|
//! \return time zero
|
|
static Time zero(TimeBase timeBase = TimeBase::TB_NONE);
|
|
|
|
//! Compare two times
|
|
//! \return The result
|
|
static Comparison compare(const Time& time1, //!< Time 1
|
|
const Time& time2 //!< Time 2
|
|
);
|
|
|
|
//! Add two times
|
|
//! \return The result
|
|
static Time add(const Time& a, //!< Time a
|
|
const Time& b //!< Time b
|
|
);
|
|
|
|
//! Subtract subtrahend from minuend
|
|
//! \return The result
|
|
static Time sub(const Time& minuend, //!< Value being subtracted from
|
|
const Time& subtrahend //!< Value being subtracted
|
|
);
|
|
|
|
// 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:
|
|
TimeValue m_val; // !< Time value
|
|
};
|
|
extern const Time ZERO_TIME;
|
|
|
|
} // namespace Fw
|
|
|
|
#endif
|