ArgSpecSerializableAc.hpp

Go to the documentation of this file.

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

#ifndef Svc_Fpy_ArgSpecSerializableAc_HPP
#define Svc_Fpy_ArgSpecSerializableAc_HPP

#include "Fw/FPrimeBasicTypes.hpp"
#include "Fw/Types/ExternalString.hpp"
#include "Fw/Types/Serializable.hpp"
#include "Fw/Types/String.hpp"
#include "Svc/FpySequencer/StackSizeTypeAliasAc.hpp"
#include "default/config/FwSizeStoreTypeAliasAc.hpp"

namespace Svc {

  namespace Fpy {

    class ArgSpec :
      public Fw::Serializable
    {

      public:

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

        enum {
          SERIALIZED_SIZE =
            Fw::StringBase::STATIC_SERIALIZED_SIZE(255) +
            Fw::StringBase::STATIC_SERIALIZED_SIZE(255) +
            sizeof(Svc::Fpy::StackSizeType)
        };

      public:

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

        ArgSpec();

        ArgSpec(
            const Fw::StringBase& argName,
            const Fw::StringBase& typeName,
            Svc::Fpy::StackSizeType argSize
        );

        ArgSpec(
            const ArgSpec& obj 
        );

      public:

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

        ArgSpec& operator=(
            const ArgSpec& obj 
        );

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

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

#ifdef BUILD_UT

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

        Fw::ExternalString& get_argName()
        {
          return this->m_argName;
        }

        const Fw::ExternalString& get_argName() const
        {
          return this->m_argName;
        }

        Fw::ExternalString& get_typeName()
        {
          return this->m_typeName;
        }

        const Fw::ExternalString& get_typeName() const
        {
          return this->m_typeName;
        }

        Svc::Fpy::StackSizeType get_argSize() const
        {
          return this->m_argSize;
        }

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

        void set(
            const Fw::StringBase& argName,
            const Fw::StringBase& typeName,
            Svc::Fpy::StackSizeType argSize
        );

        void set_argName(const Fw::StringBase& argName);

        void set_typeName(const Fw::StringBase& typeName);

        void set_argSize(Svc::Fpy::StackSizeType argSize);

      protected:

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

        char m___fprime_ac_argName_buffer[Fw::StringBase::BUFFER_SIZE(255)];
        Fw::ExternalString m_argName;
        char m___fprime_ac_typeName_buffer[Fw::StringBase::BUFFER_SIZE(255)];
        Fw::ExternalString m_typeName;
        Svc::Fpy::StackSizeType m_argSize;

    };

  }

}

#endif