DelegateRawTime.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/DelegateRawTime.hpp
// \brief Define the Os::DelegateRawTime class
// ======================================================================
#ifndef OS_DELEGATERAWTIME_HPP_
#define OS_DELEGATERAWTIME_HPP_

#include "Os/RawTimeInterface.hpp"

namespace Os {

class DelegateRawTime final : public RawTimeInterface {
  public:
    DelegateRawTime();  

    explicit DelegateRawTime(RawTimeSource source);

    ~DelegateRawTime() final;  

    DelegateRawTime(const DelegateRawTime& other);

    DelegateRawTime& operator=(const DelegateRawTime& other);

    RawTimeHandle* getHandle() override;

    // ------------------------------------------------------------
    // Implementation-specific RawTime member functions
    // ------------------------------------------------------------

    Status now() override;

    Status getTimeInterval(const Os::RawTime& other, Fw::TimeInterval& interval) const override;

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

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

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

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

    bool operator==(const RawTime& other) const override;

    RawTimeSource getSource() const;

  private:
    // This section is used to store the implementation-defined RawTime handle. To Os::RawTime and fprime, this type is
    // opaque and thus normal allocation cannot be done. Instead, we allow the implementor to store the handle in
    // the byte-array here and set `m_handle_storage` to that address for storage.
    //
    alignas(FW_HANDLE_ALIGNMENT) RawTimeHandleStorage m_handle_storage;  
    RawTimeInterface& m_delegate;                                        
    RawTimeSource m_source = RAWTIME_DEFAULT;                            
};
}  // namespace Os

#endif  // OS_DELEGATERAWTIME_HPP_