Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/notifications/NotificationDispatcher.h @ 7297

Last change on this file since 7297 was 7285, checked in by landauf, 14 years ago

added eol-style native for some files.

note: there are another 6 files in libraries/network, but I won't change them as long as there's an active network branch.

  • Property svn:eol-style set to native
File size: 3.2 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
31    @brief Definition of the NotificationDispatcher class.
32*/
33
34#ifndef _NotificationDispatcher_H__
35#define _NotificationDispatcher_H__
36
37#include "notifications/NotificationsPrereqs.h"
38
39#include <string>
40#include "core/BaseObject.h"
41
42namespace orxonox
43{
44
45    /**
46    @brief
47        A NotificationDispatcher is an entity that, upon being triggered, dispatches (or sends) a specified Notification.
48    @author
49        Damian 'Mozork' Frick
50    */
51    class _NotificationsExport NotificationDispatcher : public BaseObject
52    {
53        public:
54            NotificationDispatcher(BaseObject* creator); //!< Default constructor. Initializes the object.
55            virtual ~NotificationDispatcher(); //!< Destructor.
56
57            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a NotificationDispatcher object through XML.
58            virtual void XMLEventPort(Element& xmlelement, XMLPort::Mode mode);
59
60            /**
61            @brief Get the sender of the Notification dispatched by this NotificationDispatcher.
62            @return Returns the name of the sender.
63            */
64            const std::string& getSender(void)
65                { return this->sender_; }
66
67            void dispatch(void); //!< Dispatches a specific Notification.
68            bool trigger(bool triggered); //!< Is called when the NotificationDispatcher is triggered.
69
70        protected:
71            std::string sender_; //!< The name of the sender of the Notification dispatched by this NotificationDispatcher.
72
73            /**
74            @brief Set the sender of the Notification dispatched by this NotificationDispatcher.
75            @param sender The name of the sender.
76            */
77            void setSender(const std::string& sender)
78                { this->sender_ = sender; }
79
80            /**
81            @brief Creates the notification message that should be sent upon the NotificationDispatcher triggering.
82                   This method can be overloaded to customize the NotificationDispatcher.
83            @return Returns the notification message.
84            */
85            virtual const std::string& createNotificationMessage(void)
86                { return *(new std::string("")); }
87
88    };
89
90}
91
92#endif /* _NotificationDispatcher_H__ */
Note: See TracBrowser for help on using the repository browser.