FrameContextSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef ComCfg_FrameContextSerializableAc_HPP
#define ComCfg_FrameContextSerializableAc_HPP

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

namespace ComCfg {

  class FrameContext :
    public Fw::Serializable
  {

    public:

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

      enum {
        SERIALIZED_SIZE =
          sizeof(FwIndexType) +
          ComCfg::Apid::SERIALIZED_SIZE +
          sizeof(U16) +
          sizeof(U8)
      };

    public:

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

      FrameContext();

      FrameContext(
          FwIndexType comQueueIndex,
          ComCfg::Apid::T apid,
          U16 sequenceCount,
          U8 vcId
      );

      FrameContext(
          const FrameContext& obj 
      );

    public:

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

      FrameContext& operator=(
          const FrameContext& obj 
      );

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

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

#ifdef BUILD_UT

      friend std::ostream& operator<<(
          std::ostream& os, 
          const FrameContext& 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
      // ----------------------------------------------------------------------

      FwIndexType get_comQueueIndex() const
      {
        return this->m_comQueueIndex;
      }

      ComCfg::Apid::T get_apid() const
      {
        return this->m_apid.e;
      }

      U16 get_sequenceCount() const
      {
        return this->m_sequenceCount;
      }

      U8 get_vcId() const
      {
        return this->m_vcId;
      }

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

      void set(
          FwIndexType comQueueIndex,
          ComCfg::Apid::T apid,
          U16 sequenceCount,
          U8 vcId
      );

      void set_comQueueIndex(FwIndexType comQueueIndex);

      void set_apid(ComCfg::Apid::T apid);

      void set_sequenceCount(U16 sequenceCount);

      void set_vcId(U8 vcId);

    protected:

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

      FwIndexType m_comQueueIndex;
      ComCfg::Apid m_apid;
      U16 m_sequenceCount;
      U8 m_vcId;

  };

}

#endif