SpacePacketHeaderSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_SpacePacketHeaderSerializableAc_HPP
#define Svc_Ccsds_SpacePacketHeaderSerializableAc_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 SpacePacketHeader :
      public Fw::Serializable
    {

      public:

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

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

      public:

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

        SpacePacketHeader();

        SpacePacketHeader(
            U16 packetIdentification,
            U16 packetSequenceControl,
            U16 packetDataLength
        );

        SpacePacketHeader(
            const SpacePacketHeader& obj 
        );

      public:

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

        SpacePacketHeader& operator=(
            const SpacePacketHeader& obj 
        );

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

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

#ifdef BUILD_UT

        friend std::ostream& operator<<(
            std::ostream& os, 
            const SpacePacketHeader& 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_packetIdentification() const
        {
          return this->m_packetIdentification;
        }

        U16 get_packetSequenceControl() const
        {
          return this->m_packetSequenceControl;
        }

        U16 get_packetDataLength() const
        {
          return this->m_packetDataLength;
        }

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

        void set(
            U16 packetIdentification,
            U16 packetSequenceControl,
            U16 packetDataLength
        );

        void set_packetIdentification(U16 packetIdentification);

        void set_packetSequenceControl(U16 packetSequenceControl);

        void set_packetDataLength(U16 packetDataLength);

      protected:

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

        U16 m_packetIdentification;
        U16 m_packetSequenceControl;
        U16 m_packetDataLength;

    };

  }

}

#endif