TMHeaderSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_TMHeaderSerializableAc_HPP
#define Svc_Ccsds_TMHeaderSerializableAc_HPP

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

namespace Svc {

  namespace Ccsds {

    class TMHeader :
      public Fw::Serializable
    {

      public:

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

        enum {
          SERIALIZED_SIZE =
            sizeof(U16) +
            sizeof(U8) +
            sizeof(U8) +
            sizeof(U16)
        };

      public:

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

        TMHeader();

        TMHeader(
            U16 globalVcId,
            U8 masterFrameCount,
            U8 virtualFrameCount,
            U16 dataFieldStatus
        );

        TMHeader(
            const TMHeader& obj 
        );

      public:

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

        TMHeader& operator=(
            const TMHeader& obj 
        );

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

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

#ifdef BUILD_UT

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

        U16 get_globalVcId() const
        {
          return this->m_globalVcId;
        }

        U8 get_masterFrameCount() const
        {
          return this->m_masterFrameCount;
        }

        U8 get_virtualFrameCount() const
        {
          return this->m_virtualFrameCount;
        }

        U16 get_dataFieldStatus() const
        {
          return this->m_dataFieldStatus;
        }

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

        void set(
            U16 globalVcId,
            U8 masterFrameCount,
            U8 virtualFrameCount,
            U16 dataFieldStatus
        );

        void set_globalVcId(U16 globalVcId);

        void set_masterFrameCount(U8 masterFrameCount);

        void set_virtualFrameCount(U8 virtualFrameCount);

        void set_dataFieldStatus(U16 dataFieldStatus);

      protected:

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

        U16 m_globalVcId;
        U8 m_masterFrameCount;
        U8 m_virtualFrameCount;
        U16 m_dataFieldStatus;

    };

  }

}

#endif