TCHeaderSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Ccsds_TCHeaderSerializableAc_HPP
#define Svc_Ccsds_TCHeaderSerializableAc_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 TCHeader :
      public Fw::Serializable
    {

      public:

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

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

      public:

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

        TCHeader();

        TCHeader(
            U16 flagsAndScId,
            U16 vcIdAndLength,
            U8 frameSequenceNum
        );

        TCHeader(
            const TCHeader& obj 
        );

      public:

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

        TCHeader& operator=(
            const TCHeader& obj 
        );

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

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

#ifdef BUILD_UT

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

        U16 get_vcIdAndLength() const
        {
          return this->m_vcIdAndLength;
        }

        U8 get_frameSequenceNum() const
        {
          return this->m_frameSequenceNum;
        }

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

        void set(
            U16 flagsAndScId,
            U16 vcIdAndLength,
            U8 frameSequenceNum
        );

        void set_flagsAndScId(U16 flagsAndScId);

        void set_vcIdAndLength(U16 vcIdAndLength);

        void set_frameSequenceNum(U8 frameSequenceNum);

      protected:

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

        U16 m_flagsAndScId;
        U16 m_vcIdAndLength;
        U8 m_frameSequenceNum;

    };

  }

}

#endif