UserDataContainer.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library 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.0 of the License, or (at your option)
* any later version.
*
* This library 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 this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/

#pragma once

#include <trBase/Export.h>

#include <trBase/SmrtClass.h>
#include <trBase/SmrtPtr.h>
#include <trBase/Base.h>
#include <trUtil/RefStr.h>

#include <string>
#include <vector>

namespace trBase
{
    class TR_BASE_EXPORT UserDataContainer : public trBase::Base
    {
    public:

        using BaseClass = trBase::Base;                 

        const static trUtil::RefStr CLASS_TYPE;         

        UserDataContainer(const std::string name = CLASS_TYPE);

        virtual const std::string& GetType() const override;

        virtual trBase::SmrtClass* GetUserDataContainer();

        virtual const trBase::SmrtClass* GetUserDataContainer() const;

        virtual void SetUserDataContainer(trBase::SmrtClass* data);

        virtual std::vector<std::string> GetDescriptionList();

        virtual const std::vector<std::string> GetDescriptionList() const;

        virtual int GetDescriptionListCount();

        virtual std::string GetDescription(int index = 0);

        virtual const std::string GetDescription(int index = 0) const;

        virtual void AddDescription(std::string description);

        virtual void SetDescriptions(std::vector<std::string> descriptions);

        virtual std::vector<trBase::SmrtPtr<trBase::Base>> GetObjectList();

        virtual const std::vector<trBase::SmrtPtr<trBase::Base>> GetObjectList() const;

        virtual int GetObjectListCount();

        virtual trBase::SmrtPtr<trBase::Base> GetObject(int index = 0);

        virtual const trBase::SmrtPtr<trBase::Base> GetObject(int index = 0) const;

        virtual void AddObject(trBase::SmrtPtr<trBase::Base> obj);

        virtual void SetObjects(std::vector<trBase::SmrtPtr<trBase::Base>> objList);

    protected:

        trBase::SmrtPtr<trBase::SmrtClass> mUserDataContainer;
        std::vector<std::string> mDescriptionList;
        std::vector<trBase::SmrtPtr<trBase::Base>> mObjectList;

        ~UserDataContainer();
    };
}