TimeOffsetSerializableAc.hpp

Go to the documentation of this file.

// ======================================================================
// \title  TimeOffsetSerializableAc.hpp
// \author Generated by fpp-to-cpp
// \brief  hpp file for TimeOffset struct
// ======================================================================

#ifndef Svc_TimeOffsetSerializableAc_HPP
#define Svc_TimeOffsetSerializableAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"
#include "default/config/TimeBaseEnumAc.hpp"

namespace Svc {

  class TimeOffset :
    public Fw::Serializable
  {

    public:

      // ----------------------------------------------------------------------
      // Constants
      // ----------------------------------------------------------------------

      enum {
        SERIALIZED_SIZE =
          TimeBase::SERIALIZED_SIZE +
          TimeBase::SERIALIZED_SIZE +
          sizeof(I64)
      };

    public:

      // ----------------------------------------------------------------------
      // Constructors
      // ----------------------------------------------------------------------

      TimeOffset();

      TimeOffset(
          TimeBase::T from,
          TimeBase::T to,
          I64 offset_us
      );

      TimeOffset(
          const TimeOffset& obj 
      );

    public:

      // ----------------------------------------------------------------------
      // Operators
      // ----------------------------------------------------------------------

      TimeOffset& operator=(
          const TimeOffset& obj 
      );

      bool operator==(
          const TimeOffset& obj 
      ) const;

      bool operator!=(
          const TimeOffset& obj 
      ) const;

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const TimeOffset& obj 
      );

#endif

    public:

      // ----------------------------------------------------------------------
      // Member functions
      // ----------------------------------------------------------------------

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

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

      FwSizeType serializedSize() const;

#if FW_SERIALIZABLE_TO_STRING

      void toString(
          Fw::StringBase& sb 
      ) const;

#endif

      // ----------------------------------------------------------------------
      // Getter functions
      // ----------------------------------------------------------------------

      TimeBase::T get_from() const
      {
        return this->m_from.e;
      }

      TimeBase::T get_to() const
      {
        return this->m_to.e;
      }

      I64 get_offset_us() const
      {
        return this->m_offset_us;
      }

      // ----------------------------------------------------------------------
      // Setter functions
      // ----------------------------------------------------------------------

      void set(
          TimeBase::T from,
          TimeBase::T to,
          I64 offset_us
      );

      void set_from(TimeBase::T from);

      void set_to(TimeBase::T to);

      void set_offset_us(I64 offset_us);

    protected:

      // ----------------------------------------------------------------------
      // Member variables
      // ----------------------------------------------------------------------

      TimeBase m_from;
      TimeBase m_to;
      I64 m_offset_us;

  };

}

#endif