TimeValueSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Fw_TimeValueSerializableAc_HPP
#define Fw_TimeValueSerializableAc_HPP

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

namespace Fw {

  class TimeValue :
    public Fw::Serializable
  {

    public:

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

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

    public:

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

      TimeValue();

      TimeValue(
          TimeBase::T timeBase,
          FwTimeContextStoreType timeContext,
          U32 seconds,
          U32 useconds
      );

      TimeValue(
          const TimeValue& obj 
      );

    public:

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

      TimeValue& operator=(
          const TimeValue& obj 
      );

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

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

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const TimeValue& 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_timeBase() const
      {
        return this->m_timeBase.e;
      }

      FwTimeContextStoreType get_timeContext() const
      {
        return this->m_timeContext;
      }

      U32 get_seconds() const
      {
        return this->m_seconds;
      }

      U32 get_useconds() const
      {
        return this->m_useconds;
      }

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

      void set(
          TimeBase::T timeBase,
          FwTimeContextStoreType timeContext,
          U32 seconds,
          U32 useconds
      );

      void set_timeBase(TimeBase::T timeBase);

      void set_timeContext(FwTimeContextStoreType timeContext);

      void set_seconds(U32 seconds);

      void set_useconds(U32 useconds);

    protected:

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

      TimeBase m_timeBase;
      FwTimeContextStoreType m_timeContext;
      U32 m_seconds;
      U32 m_useconds;

  };

}

#endif