/************************************************************************
 *
 * Copyright (C) 2014-2022 IRCAD France
 * Copyright (C) 2014-2020 IHU Strasbourg
 *
 * This file is part of Sight.
 *
 * Sight is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Sight is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sight. If not, see <https://www.gnu.org/licenses/>.
 *
 ***********************************************************************/

#pragma once

#include <data/GenericTL.hpp>
#include <data/GenericTL.hxx>
#include <data/timeline/GenericObject.hpp>
#include <data/timeline/GenericObject.hxx>

namespace ExTimeLine
{

struct MsgData
{
    /// Defines the maximum size of a message.
    static const std::size_t MAX_MSG_SIZE = 255;

    /// Defines the identifier of the sender.
    unsigned int uidSender;

    /// Stores the message as a C string.
    char szMsg[MAX_MSG_SIZE];
};

/**
 * @brief Defines a timeline that stores string messages.
 */
class MessageTL : public sight::data::GenericTL<MsgData>
{
public:

    SIGHT_DECLARE_CLASS(MessageTL, sight::data::TimeLine, sight::data::factory::New<MessageTL>);

    /**
     * @brief Creates the data.
     * @param _key private construction key.
     */
    MessageTL(sight::data::Object::Key _key) :
        GenericTL<MsgData>(_key)
    {
    }
};

} // namespace ExTimeLine
