RawTimeInterface.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/RawTimeInterface.hpp
// \brief Os::RawTimeHandle and Os::RawTimeInterface definitions
// ======================================================================
#ifndef OS_RAWTIMEINTERFACE_HPP_
#define OS_RAWTIMEINTERFACE_HPP_

#include <Fw/FPrimeBasicTypes.hpp>
#include <Fw/Time/TimeInterval.hpp>
#include <Fw/Types/Serializable.hpp>
#include <Os/Os.hpp>
#include "config/OsDelegateRawTime.hpp"
#include "config/RawTimeSource.hpp"

namespace Os {

struct RawTimeHandle {};

class RawTimeInterface : public Fw::Serializable {
  public:
    // Serialization size for RawTime objects, configured in config/FpConfig.h
    static const FwSizeType SERIALIZED_SIZE = FW_RAW_TIME_SERIALIZATION_MAX_SIZE;

    enum Status {
        OP_OK,           
        OP_OVERFLOW,     
        INVALID_PARAMS,  
        NOT_SUPPORTED,   
        OTHER_ERROR      
    };

    RawTimeInterface() = default;

    virtual ~RawTimeInterface() = default;

    virtual RawTimeHandle* getHandle() = 0;

    static RawTimeInterface* getDelegate(RawTimeHandleStorage& aligned_new_memory,
                                         const RawTimeInterface* to_copy = nullptr,
                                         RawTimeSource source = RAWTIME_DEFAULT);

    // ------------------------------------------------------------------
    // RawTime operations to be implemented by an OSAL implementation
    // ------------------------------------------------------------------

    virtual Status now() = 0;

    virtual Status getTimeInterval(const Os::RawTime& other, Fw::TimeInterval& interval) const = 0;

    virtual Fw::SerializeStatus serializeTo(Fw::SerialBufferBase& buffer,
                                            Fw::Endianness mode = Fw::Endianness::BIG) const = 0;

    virtual Fw::SerializeStatus deserializeFrom(Fw::SerialBufferBase& buffer,
                                                Fw::Endianness mode = Fw::Endianness::BIG) = 0;

    // ------------------------------------------------------------------
    // Common virtual functions built on top of OS-specific functions
    // ------------------------------------------------------------------

    virtual Status getDiffUsec(const RawTime& other, U32& result) const;

    virtual bool operator==(const RawTime& other) const;
};
}  // namespace Os

#endif  // OS_RAWTIMEINTERFACE_HPP_