// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/*************************************************************************
 * @file String.h
 * This header file contains the declaration of the described types in the IDL file.
 *
 * This file was generated by the tool gen.
 */

#ifndef _String_H_
#define _String_H_

// TODO Poner en el contexto.

#include <stdint.h>
#include <array>
#include <string>
#include <vector>

#if defined(_WIN32)
#if defined(EPROSIMA_USER_DLL_EXPORT)
#define eProsima_user_DllExport __declspec( dllexport )
#else
#define eProsima_user_DllExport
#endif
#else
#define eProsima_user_DllExport
#endif

namespace eprosima
{
    namespace fastcdr
    {
        class Cdr;
    }
}


/*!
 * @brief This class represents the structure String defined by the user in the IDL file.
 * @ingroup STRING
 */
class String
{
public:

    /*!
     * @brief Default constructor.
     */
    eProsima_user_DllExport String();
    
    /*!
     * @brief Default destructor.
     */
    eProsima_user_DllExport ~String();
    
    /*!
     * @brief Copy constructor.
     * @param x Reference to the object String that will be copied.
     */
    eProsima_user_DllExport String(const String &x);
    
    /*!
     * @brief Move constructor.
     * @param x Reference to the object String that will be copied.
     */
    eProsima_user_DllExport String(String &&x);
    
    /*!
     * @brief Copy assignment.
     * @param x Reference to the object String that will be copied.
     */
    eProsima_user_DllExport String& operator=(const String &x);
    
    /*!
     * @brief Move assignment.
     * @param x Reference to the object String that will be copied.
     */
    eProsima_user_DllExport String& operator=(String &&x);

    eProsima_user_DllExport bool operator==(const String &x) const;
    
    /*!
     * @brief This function sets a value in member index
     * @param _index New value for member index
     */
    inline eProsima_user_DllExport void index(uint16_t _index)
    {
        m_index = _index;
    }

    /*!
     * @brief This function returns the value of member index
     * @return Value of member index
     */
    inline eProsima_user_DllExport uint16_t index() const
    {
        return m_index;
    }

    /*!
     * @brief This function returns a reference to member index
     * @return Reference to member index
     */
    inline eProsima_user_DllExport uint16_t& index()
    {
        return m_index;
    }
    /*!
     * @brief This function sets a value in member message
     * @param _message New value for member message
     */
    inline eProsima_user_DllExport void message(std::string _message)
    {
        m_message = _message;
    }

    /*!
     * @brief This function returns the value of member message
     * @return Value of member message
     */
    inline eProsima_user_DllExport std::string message() const
    {
        return m_message;
    }

    /*!
     * @brief This function returns a reference to member message
     * @return Reference to member message
     */
    inline eProsima_user_DllExport std::string& message()
    {
        return m_message;
    }
    
    /*!
     * @brief This function returns the maximum serialized size of an object
     * depending on the buffer alignment.
     * @param current_alignment Buffer alignment.
     * @return Maximum serialized size.
     */
    eProsima_user_DllExport static size_t getMaxCdrSerializedSize(size_t current_alignment = 0);

    eProsima_user_DllExport static size_t getCdrSerializedSize(const String& data, size_t current_alignment = 0);

    /*!
     * @brief This function returns the maximum serialized size of the Key of an object
     * depending on the buffer alignment.
     * @param current_alignment Buffer alignment.
     * @return Maximum serialized size.
     */
    eProsima_user_DllExport static size_t getKeyMaxCdrSerializedSize(size_t current_alignment = 0);

    /*!
     * @brief This function tells you if the Key has beedn defined for this type
     */
    eProsima_user_DllExport static bool isKeyDefined();

    /*!
     * @brief This function serializes an object using CDR serialization.
     * @param cdr CDR serialization object.
     */
    eProsima_user_DllExport void serialize(eprosima::fastcdr::Cdr &cdr) const;

    /*!
     * @brief This function deserializes an object using CDR serialization.
     * @param cdr CDR serialization object.
     */
    eProsima_user_DllExport void deserialize(eprosima::fastcdr::Cdr &cdr);

    /*!
     * @brief This function serializes the key memebers of an object using CDR serialization.
     * @param cdr CDR serialization object.
     */
    eProsima_user_DllExport void serializeKey(eprosima::fastcdr::Cdr &cdr) const;

    
private:
    uint16_t m_index;
    std::string m_message;
};

#endif // _String_H_
