Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/Asteroid_HS17/src/modules/notifications/NotificationDispatcher.h @ 11456

Last change on this file since 11456 was 11099, checked in by muemart, 9 years ago

Fix loads of doxygen warnings and other documentation issues

  • Property svn:eol-style set to native
File size: 5.8 KB
Line 
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/**
30    @file NotificationDispatcher.h
31    @brief Definition of the NotificationDispatcher class.
32    @ingroup Notifications
33*/
34
35#ifndef _NotificationDispatcher_H__
36#define _NotificationDispatcher_H__
37
38#include "notifications/NotificationsPrereqs.h"
39
40#include <string>
41
42#include "core/BaseObject.h"
43#include "network/synchronisable/Synchronisable.h"
44
45namespace orxonox
46{
47
48    /**
49    @brief
50        A NotificationDispatcher is an entity that, upon being triggered, dispatches (or sends) a specified @ref orxonox::Notification "Notification".
51
52        There are two parameter to be set:
53        - 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.
54        - The @b broadcast . Specifies whether messages are broadcast (i.e. sent to all clients) or just sent to a specific player.
55
56        Its standard usage is:
57        @code
58        <NotificationDispatcher sender="me">
59            <events>
60                <trigger>
61                    <PlayerTrigger />
62                </trigger>
63            </event>
64        </NotificationDispatcher>
65        @endcode
66        But keep in mind, that NotificationDispatcher is an abstract class.
67        Also 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".
68        If the NotificationDispatcher is not set to broadcast only events caused by @ref orxonox::PlayerTrigger "PlayerTriggers" trigger a message since the information obtained by the @ref orxonox::PlayerTrigger "PlayerTrigger" is used to identify the client to which the message should be sent.
69
70    @author
71        Damian 'Mozork' Frick
72
73    @ingroup Notifications
74    */
75    class _NotificationsExport NotificationDispatcher : public BaseObject, public Synchronisable
76    {
77        public:
78            NotificationDispatcher(Context* context); //!< Default constructor. Initializes the object.
79            virtual ~NotificationDispatcher(); //!< Destructor.
80
81            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode) override; //!< Method for creating a NotificationDispatcher object through XML.
82            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode) override;
83
84            /**
85            @brief Get the sender of the Notification dispatched by this NotificationDispatcher.
86            @return Returns the name of the sender.
87            */
88            const std::string& getSender(void) const
89                { return this->sender_; }
90            /**
91            @brief Set the sender of the Notification dispatched by this NotificationDispatcher.
92            @param sender The name of the sender.
93            */
94            void setSender(const std::string& sender)
95                { this->sender_ = sender; }
96
97            /**
98            @brief Check whether the NotificationDispatcher is set to broadcast.
99            @return Returns true if the NotificationDispatcher is set to broadcast.
100            */
101            bool isBroadcasting(void) const
102                { return this->bBroadcast_; }
103            /**
104            @brief Set the NotificationDispatcher to broadcast.
105            @param v Whether the NotificationDispatcher is set to broadcast or singlecast.
106            */
107            void setBroadcasting(bool v)
108                { this->bBroadcast_ = v; }
109
110            void broadcast(void); //!< Broadcasts a specific Notification.
111            void broadcastHelper(void); //!< Helper function for broadcast.
112            void dispatch(unsigned int clientId); //!< Dispatches a specific Notification to a given client.
113            bool trigger(bool triggered, BaseObject* trigger); //!< Is called when the NotificationDispatcher is triggered.
114
115        protected:
116            std::string sender_; //!< The name of the sender of the Notification dispatched by this NotificationDispatcher.
117            bool bBroadcast_; //!< Whether the NotificationDispatcher is broadcasting.
118
119            void registerVariables(void); //!< Register some variables for synchronisation.
120
121            /**
122            @brief Creates the notification message that should be sent upon the NotificationDispatcher triggering.
123                   This method can be overloaded to customize the NotificationDispatcher.
124            @return Returns the notification message.
125            */
126            virtual const std::string& createNotificationMessage(void)
127                { return BLANKSTRING; }
128
129    };
130
131}
132
133#endif /* _NotificationDispatcher_H__ */
Note: See TracBrowser for help on using the repository browser.