SequenceSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Fpy_SequenceSerializableAc_HPP
#define Svc_Fpy_SequenceSerializableAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"
#include "Svc/FpySequencer/FooterSerializableAc.hpp"
#include "Svc/FpySequencer/HeaderSerializableAc.hpp"
#include "Svc/FpySequencer/StatementSerializableAc.hpp"

namespace Svc {

  namespace Fpy {

    class Sequence :
      public Fw::Serializable
    {

      public:

        // ----------------------------------------------------------------------
        // Types
        // ----------------------------------------------------------------------

        using Type_of_args = U8[16];

        using Type_of_statements = Svc::Fpy::Statement[1024];

      public:

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

        enum {
          SERIALIZED_SIZE =
            Svc::Fpy::Header::SERIALIZED_SIZE +
            sizeof(U8) * 16 +
            Svc::Fpy::Statement::SERIALIZED_SIZE * 1024 +
            Svc::Fpy::Footer::SERIALIZED_SIZE
        };

      public:

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

        Sequence();

        Sequence(
            const Svc::Fpy::Header& header,
            const Type_of_args& args,
            const Type_of_statements& statements,
            const Svc::Fpy::Footer& footer
        );

        Sequence(
            const Sequence& obj 
        );

        Sequence(
            const Svc::Fpy::Header& header,
            U8 args,
            const Svc::Fpy::Statement& statements,
            const Svc::Fpy::Footer& footer
        );

      public:

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

        Sequence& operator=(
            const Sequence& obj 
        );

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

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

#ifdef BUILD_UT

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

        Svc::Fpy::Header& get_header()
        {
          return this->m_header;
        }

        const Svc::Fpy::Header& get_header() const
        {
          return this->m_header;
        }

        Type_of_args& get_args()
        {
          return this->m_args;
        }

        const Type_of_args& get_args() const
        {
          return this->m_args;
        }

        Type_of_statements& get_statements()
        {
          return this->m_statements;
        }

        const Type_of_statements& get_statements() const
        {
          return this->m_statements;
        }

        Svc::Fpy::Footer& get_footer()
        {
          return this->m_footer;
        }

        const Svc::Fpy::Footer& get_footer() const
        {
          return this->m_footer;
        }

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

        void set(
            const Svc::Fpy::Header& header,
            const Type_of_args& args,
            const Type_of_statements& statements,
            const Svc::Fpy::Footer& footer
        );

        void set_header(const Svc::Fpy::Header& header);

        void set_args(const Type_of_args& args);

        void set_statements(const Type_of_statements& statements);

        void set_footer(const Svc::Fpy::Footer& footer);

      protected:

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

        Svc::Fpy::Header m_header;
        U8 m_args[16];
        Svc::Fpy::Statement m_statements[1024];
        Svc::Fpy::Footer m_footer;

    };

  }

}

#endif