X-Plane Remote Access Plugin and Client Library
MessageRequest.h
1 // Copyright (c) 2013 by István Váradi
2 
3 // This file is part of XPLRA, a remote-access plugin for X-Plane
4 
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are met:
7 
8 // 1. Redistributions of source code must retain the above copyright notice, this
9 // list of conditions and the following disclaimer.
10 // 2. Redistributions in binary form must reproduce the above copyright notice,
11 // this list of conditions and the following disclaimer in the documentation
12 // and/or other materials provided with the distribution.
13 
14 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18 // ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19 // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21 // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 
25 // The views and conclusions contained in the software and documentation are those
26 // of the authors and should not be interpreted as representing official policies,
27 // either expressed or implied, of the FreeBSD Project.
28 
29 #ifndef XPLRA_MESSAGEREQUEST_H
30 #define XPLRA_MESSAGEREQUEST_H
31 //------------------------------------------------------------------------------
32 
33 #include "Request.h"
34 
35 #include <string>
36 
37 //------------------------------------------------------------------------------
38 
39 namespace xplra {
40 
41 //------------------------------------------------------------------------------
42 
43 class MessageWindow;
44 
45 //------------------------------------------------------------------------------
46 
50 class MessageRequest : public Request
51 {
52 private:
57 
61  std::string message;
62 
66  float duration;
67 
68 public:
73  const std::string& message, float duration);
74 
75 protected:
79  virtual void execute();
80 };
81 
82 //------------------------------------------------------------------------------
83 // Inline definitions
84 //------------------------------------------------------------------------------
85 
87  const std::string& message,
88  float duration) :
89  messageWindow(messageWindow),
90  message(message),
91  duration(duration)
92 {
93 }
94 
95 //------------------------------------------------------------------------------
96 
97 } /* namespace xplra */
98 
99 //------------------------------------------------------------------------------
100 #endif // XPLRA_MESSAGEREQUEST_H
101 
102 // Local Variables:
103 // mode: C++
104 // c-basic-offset: 4
105 // indent-tabs-mode: nil
106 // End:
MessageRequest(MessageWindow &messageWindow, const std::string &message, float duration)
virtual void execute()
MessageWindow & messageWindow
Python client module for the X-Plane Remote Access plugin.
Definition: DataRefTask.h:41