NotificationDispatcher.h

Go to the documentation of this file.

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   This program is free software; you can redistribute it and/or
 *   modify it under the terms of the GNU General Public License
 *   as published by the Free Software Foundation; either version 2
 *   of the License, or (at your option) any later version.
 *
 *   This program 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with this program; if not, write to the Free Software
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Damian 'Mozork' Frick
 *   Co-authors:
 *      ...
 *
 */

#ifndef _NotificationDispatcher_H__
#define _NotificationDispatcher_H__

#include "notifications/NotificationsPrereqs.h"

#include <string>

#include "core/BaseObject.h"
#include "network/synchronisable/Synchronisable.h"

namespace orxonox
{

    class _NotificationsExport NotificationDispatcher : public BaseObject, public Synchronisable
    {
        public:
            NotificationDispatcher(Context* context); 
            virtual ~NotificationDispatcher(); 

            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; 
            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode) override;

            const std::string& getSender(void) const
                { return this->sender_; }
            void setSender(const std::string& sender)
                { this->sender_ = sender; }

            bool isBroadcasting(void) const
                { return this->bBroadcast_; }
            void setBroadcasting(bool v)
                { this->bBroadcast_ = v; }

            void broadcast(void); 
            void broadcastHelper(void); 
            void dispatch(unsigned int clientId); 
            bool trigger(bool triggered, BaseObject* trigger); 

        protected:
            std::string sender_; 
            bool bBroadcast_; 

            void registerVariables(void); 

            virtual const std::string& createNotificationMessage(void)
                { return BLANKSTRING; }

    };

}

#endif /* _NotificationDispatcher_H__ */