1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
/*
RailControl - Model Railway Control Software
Copyright (c) 2017-2025 by Teddy / Dominik Mahrer - www.railcontrol.org
RailControl is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 3, or (at your option) any
later version.
RailControl is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with RailControl; see the file LICENCE. If not see
<http://www.gnu.org/licenses/>.
*/
#pragma once
#include <cstdint>
#include <ctime>
#include <map>
#include <string>
#include "DataModel/HardwareHandle.h"
#include "Hardware/AccessoryCache.h"
namespace DataModel
{
enum AccessoryType : uint8_t
{
// 2 MSB are functional type (on-on, on push, on-off)
AccessoryTypeOnOn = 0x00,
AccessoryTypeOnPush = 0x40,
AccessoryTypeOnOff = 0x80,
AccessoryTypeConnectionMask = 0xC0,
// 6 LSB are display type (default, straight, turn, ...)
AccessoryTypeDefault = 0x00,
AccessoryTypeStraight = 0x01,
AccessoryTypeTurn = 0x02,
AccessoryTypeDecoupler = 0x03,
AccessoryTypeLight = 0x04,
AccessoryTypeLightInhouse = 0x05,
AccessoryTypeLightStreet = 0x06,
AccessoryTypeMask = 0x3F,
SignalTypeSimpleLeft = 0,
SignalTypeSimpleRight = 1,
SignalTypeChDwarf = 10,
SignalTypeChLMain = 11,
SignalTypeChLDistant = 12,
SignalTypeChLCombined = 13,
SignalTypeChNMain = 14,
SignalTypeChNDistant = 15,
SignalTypeDeCombined = 20,
SignalTypeDeHVMain = 21,
SignalTypeDeHVDistant = 22,
SignalTypeDeBlock = 23,
SwitchTypeLeft = 0,
SwitchTypeRight = 1,
SwitchTypeThreeWay = 2,
SwitchTypeMaerklinLeft = 3,
SwitchTypeMaerklinRight = 4
};
enum AccessoryState : uint8_t
{
DefaultState = 0,
AccessoryStateOff = 0,
AccessoryStateOn = 1,
SignalStateStop = 0,
SignalStateClear,
SignalStateAspect2,
SignalStateAspect3,
SignalStateAspect4,
SignalStateAspect5,
SignalStateAspect6,
SignalStateAspect7,
SignalStateAspect8,
SignalStateAspect9,
SignalStateAspect10,
SignalStateDark = 0x1F,
SignalStateStopExpected = SignalStateStop + 0x20,
SignalStateClearExpected,
SignalStateAspect2Expected,
SignalStateAspect3Expected,
SignalStateAspect4Expected,
SignalStateAspect5Expected,
SignalStateAspect6Expected,
SignalStateAspect7Expected,
SignalStateAspect8Expected,
SignalStateAspect9Expected,
SignalStateAspect10Expected,
SignalStateMax = SignalStateAspect10Expected,
SwitchStateTurnout = 0,
SwitchStateStraight = 1,
SwitchStateThird = 2,
InvalidState = 0xFF
};
typedef signed char AddressOffset;
typedef unsigned short AccessoryPulseDuration;
static const AccessoryPulseDuration DefaultAccessoryPulseDuration = 100;
class AccessoryBase : public HardwareHandle
{
public:
inline AccessoryBase()
: HardwareHandle(),
accessoryType(AccessoryTypeDefault),
accessoryState(AccessoryStateOff),
duration(0),
inverted(false),
lastUsed(0),
counter(0),
matchKey("")
{
}
virtual ~AccessoryBase() {}
inline AccessoryType GetAccessoryType() const
{
return accessoryType;
}
virtual inline void SetAccessoryType(AccessoryType accessoryType)
{
this->accessoryType = accessoryType;
}
inline AccessoryState GetAccessoryState() const
{
return accessoryState;
}
AccessoryState CalculateInvertedAccessoryState(const AccessoryState state) const;
inline AccessoryState GetInvertedAccessoryState() const
{
return CalculateInvertedAccessoryState(accessoryState);
}
inline void SetAccessoryState(const AccessoryState state)
{
this->accessoryState = state;
lastUsed = std::time(nullptr);
++counter;
}
inline AccessoryPulseDuration GetAccessoryPulseDuration() const
{
return duration;
}
inline void SetAccessoryPulseDuration(const AccessoryPulseDuration duration)
{
this->duration = duration;
}
inline bool GetInverted() const
{
return inverted;
}
inline void SetInverted(const bool inverted)
{
this->inverted = inverted;
}
inline time_t GetLastUsed() const
{
return lastUsed;
}
inline void SetMatchKey(const std::string& matchKey)
{
this->matchKey = matchKey;
}
inline void ClearMatchKey()
{
matchKey.clear();
}
inline std::string GetMatchKey() const
{
return matchKey;
}
protected:
virtual std::string Serialize() const;
virtual void Deserialize(const std::map<std::string,std::string>& arguments);
private:
AccessoryType accessoryType;
AccessoryState accessoryState;
AccessoryPulseDuration duration; // duration in ms after which the accessory command will be turned off on rails. 0 = no turn off / turn off must be made manually
bool inverted;
time_t lastUsed;
unsigned int counter;
std::string matchKey;
};
} // namespace DataModel
|
