MessageBase.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 <trManager/Export.h>

#include <trUtil/StringUtils.h>
#include <trUtil/RefStr.h>
#include <trBase/ObsrvrPtr.h>
#include <trBase/SmrtClass.h>
#include <trBase/UniqueId.h>

#include <string>

namespace trManager
{
    class TR_MANAGER_EXPORT MessageBase : public trBase::SmrtClass
    {
    public:

        using BaseClass = trBase::SmrtClass;                

        const static trUtil::RefStr MESSAGE_TYPE;           

        MessageBase(const trBase::UniqueId* fromActorID, const trBase::UniqueId* aboutActorID = NULL, const bool isDirect = false, const std::string &messageFilter = trUtil::StringUtils::STR_BLANK);

        bool operator==(const MessageBase& msg) const;
        bool operator!=(const MessageBase& msg) const { return !(*this == msg); }

        virtual const std::string& GetMessageType() const = 0;

        virtual const trBase::UniqueId* GetFromActorID() const;

        virtual const trBase::UniqueId* GetAboutActorID() const;

        virtual const bool& GetIsDirect() const;

        virtual const std::string& GetMessageFilter();

    protected:

        ~MessageBase();

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

    private:

        trBase::ObsrvrPtr<const trBase::UniqueId> mFromActorID, mAboutActorID;
        bool mIsDirect;
        const std::string *mMessageFilter;
        trBase::UniqueId mId;
    };
}