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_SETMULTIDATAREFREQUEST_H
|
---|
30 | #define XPLRA_SETMULTIDATAREFREQUEST_H
|
---|
31 | //------------------------------------------------------------------------------
|
---|
32 |
|
---|
33 | #include "MultiTaskRequest.h"
|
---|
34 | #include "SetDataRefTask.h"
|
---|
35 |
|
---|
36 | //------------------------------------------------------------------------------
|
---|
37 |
|
---|
38 | namespace xplra {
|
---|
39 |
|
---|
40 | //------------------------------------------------------------------------------
|
---|
41 |
|
---|
42 | /**
|
---|
43 | * A request containing several dataref update tasks.
|
---|
44 | */
|
---|
45 | class SetMultiDataRefRequest : public MultiTaskRequestTemplate<SetDataRefTask>
|
---|
46 | {
|
---|
47 | public:
|
---|
48 | /**
|
---|
49 | * Construct the request by reading the task specifications from
|
---|
50 | * the given stream.
|
---|
51 | */
|
---|
52 | SetMultiDataRefRequest(uint8_t& result,
|
---|
53 | hu::varadiistvan::scpl::io::DataStream& stream,
|
---|
54 | bool readValues);
|
---|
55 |
|
---|
56 | /**
|
---|
57 | * Read the values of all tasks.
|
---|
58 | */
|
---|
59 | void readValues(hu::varadiistvan::scpl::io::DataStream& stream);
|
---|
60 |
|
---|
61 | /**
|
---|
62 | * Write the result of an execution.
|
---|
63 | *
|
---|
64 | * If there is at least one invalid dataref, the result will be
|
---|
65 | * RESULT_UNKNOWN_DATAREF followed by a 32-bit unsigned value with
|
---|
66 | * the index of the first unknown dataref.
|
---|
67 | *
|
---|
68 | * Otherwise the result is RESULT_OK.
|
---|
69 | */
|
---|
70 | void writeResult(hu::varadiistvan::scpl::io::DataStream& stream) const;
|
---|
71 | };
|
---|
72 |
|
---|
73 | //------------------------------------------------------------------------------
|
---|
74 |
|
---|
75 | } /* namespace xplra */
|
---|
76 |
|
---|
77 | //------------------------------------------------------------------------------
|
---|
78 | #endif // XPLRA_SETMULTIDATAREFREQUEST_H
|
---|
79 |
|
---|
80 | // Local Variables:
|
---|
81 | // mode: C++
|
---|
82 | // c-basic-offset: 4
|
---|
83 | // indent-tabs-mode: nil
|
---|
84 | // End:
|
---|