Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/notifications/NotificationDispatcher.h @ 8639

Last change on this file since 8639 was 7552, checked in by dafrick, 14 years ago

Resolving some TODOs and doing some additional cleanup. Almost done now…

  • Property svn:eol-style set to native
File size: 4.5 KB
RevLine 
[7193]1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Damian 'Mozork' Frick
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
[7456]30    @file NotificationDispatcher.h
[7193]31    @brief Definition of the NotificationDispatcher class.
[7456]32    @ingroup Notifications
[7193]33*/
34
35#ifndef _NotificationDispatcher_H__
36#define _NotificationDispatcher_H__
37
38#include "notifications/NotificationsPrereqs.h"
39
40#include <string>
[7552]41
[7193]42#include "core/BaseObject.h"
[7474]43#include "network/synchronisable/Synchronisable.h"
[7193]44
45namespace orxonox
46{
47
48    /**
49    @brief
[7484]50        A NotificationDispatcher is an entity that, upon being triggered, dispatches (or sends) a specified @ref orxonox::Notification "Notification".
51
[7488]52        There is one parameter to be set, the @b sender . The sender specifies the part of Orxonox the sent @ref orxonox::Notification "Notification" comes from. The default value is set by the classes implementing NotificationDispatcher.
53
[7484]54        Its standard usage is:
55        @code
[7488]56        <NotificationDispatcher sender="me">
[7484]57            <events>
58                <trigger>
59                    <PlayerTrigger />
60                </trigger>
61            </event>
62        </NotificationDispatcher>
63        @endcode
64        But keep in mind, that NotificationDispatcher is an abstract class and in this example @ref orxonox::PlayerTrigger "PlayerTrigger" stands for any event that is caused by a @ref orxonox::PlayerTrigger "PlayerTrigger", so instead of @ref orxonox::PlayerTrigger "PlayerTrigger", there could be a @ref orxonox::DistanceTrigger "DistanceTrigger", or a @ref orxonox::DistanceMultiTrigger "DistanceMutliTrigger", or even an @ref orxonox::EventListener "EventListener" that waits for an event coming from any kind of @ref orxonox::PlayerTrigger "PlayerTrigger".
[7552]65
[7193]66    @author
67        Damian 'Mozork' Frick
[7552]68
69    @ingroup Notifications
[7193]70    */
[7474]71    class _NotificationsExport NotificationDispatcher : public BaseObject, public Synchronisable
[7193]72    {
73        public:
74            NotificationDispatcher(BaseObject* creator); //!< Default constructor. Initializes the object.
75            virtual ~NotificationDispatcher(); //!< Destructor.
76
[7407]77            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a NotificationDispatcher object through XML.
78            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
[7193]79
80            /**
81            @brief Get the sender of the Notification dispatched by this NotificationDispatcher.
82            @return Returns the name of the sender.
83            */
[7488]84            const std::string& getSender(void) const
[7193]85                { return this->sender_; }
[7488]86                        /**
87            @brief Set the sender of the Notification dispatched by this NotificationDispatcher.
88            @param sender The name of the sender.
89            */
90            void setSender(const std::string& sender)
91                { this->sender_ = sender; }
[7193]92
[7403]93            void dispatch(unsigned int clientId); //!< Dispatches a specific Notification.
94            bool trigger(bool triggered, BaseObject* trigger); //!< Is called when the NotificationDispatcher is triggered.
[7193]95
96        protected:
97            std::string sender_; //!< The name of the sender of the Notification dispatched by this NotificationDispatcher.
98
[7484]99            void registerVariables(void); //!< Register some variables for synchronisation.
[7474]100
[7193]101            /**
102            @brief Creates the notification message that should be sent upon the NotificationDispatcher triggering.
103                   This method can be overloaded to customize the NotificationDispatcher.
104            @return Returns the notification message.
105            */
106            virtual const std::string& createNotificationMessage(void)
107                { return *(new std::string("")); }
108
109    };
110
111}
112
113#endif /* _NotificationDispatcher_H__ */
Note: See TracBrowser for help on using the repository browser.