File: HardwareHandler.h

package info (click to toggle)
railcontrol 24%2Bdfsg1-9
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,680 kB
  • sloc: cpp: 40,834; javascript: 2,509; makefile: 144; php: 97; sh: 60
file content (197 lines) | stat: -rw-r--r-- 6,879 bytes parent folder | download | duplicates (2)
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
/*
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 <string>

#include "ControlInterface.h"
#include "DataModel/LocoFunctions.h"
#include "DataTypes.h"
#include "Hardware/HardwareInterface.h"
#include "Hardware/HardwareParams.h"
#include "Hardware/LocoCache.h"
#include "Manager.h"

namespace Hardware
{
	class HardwareHandler: public ControlInterface
	{
		public:
			HardwareHandler() = delete;
			HardwareHandler(const HardwareHandler&) = delete;
			HardwareHandler& operator=(const HardwareHandler&) = delete;

			inline HardwareHandler(const HardwareParams* params)
			:	ControlInterface(ControlTypeHardware),
				instance(nullptr),
				params(nullptr)
			{
				Init(params);
			}

			inline ~HardwareHandler()
			{
				Close();
			}

			virtual void Start() override
			{
				if (instance == nullptr)
				{
					return;
				}
				instance->Start();
			}

			inline void ReInit(const HardwareParams* params) override
			{
				Close();
				Init(params);
				Start();
			}

			inline ControlID GetControlID() const
			{
				return params->GetControlID();
			}

			const std::string& GetName() const override;

			const std::string& GetShortName() const override;

			void AccessoryProtocols(std::vector<Protocol>& protocols) const override;
			bool AccessoryProtocolSupported(Protocol protocol) const override;
			void AccessoryState(const ControlType controlType, const DataModel::Accessory* accessory) override;

			void Booster(const ControlType controlType, BoosterState status) override;
			Hardware::Capabilities GetCapabilities() const override;

			void LocoBaseOrientation(const ControlType controlType,
				const DataModel::LocoBase* loco,
				const Orientation orientation) override;

			void LocoBaseFunction(const ControlType controlType,
				const DataModel::LocoBase* loco,
				const DataModel::LocoFunctionNr function,
				const DataModel::LocoFunctionState on) override;

			void LocoProtocols(std::vector<Protocol>& protocols) const override;

			bool LocoProtocolSupported(Protocol protocol) const override;

			void LocoBaseSpeed(const ControlType controlType,
				const DataModel::LocoBase* loco,
				const Speed speed) override;

			void LocoBaseSpeedOrientationFunctions(const DataModel::LocoBase* loco,
				const Speed speed,
				const Orientation orientation,
				std::vector<DataModel::LocoFunctionEntry>& functions) override;

			void LocoSettings(const LocoID locoId,
				const std::string& name,
				const std::string& matchKey) override;

			void LocoDelete(const LocoID locoId,
				const std::string& name,
				const std::string& matchKey) override;

			void AccessorySettings(const AccessoryID accessoryId,
				const std::string& name,
				const std::string& matchKey) override;

			void AccessoryDelete(const AccessoryID accessoryId,
				const std::string& name,
				const std::string& matchKey) override;

			void SwitchSettings(const SwitchID switchId,
				const std::string& name,
				const std::string& matchKey) override;

			void SwitchDelete(const SwitchID switchId,
				const std::string& name,
				const std::string& matchKey) override;

			void SwitchState(const ControlType controlType, const DataModel::Switch* mySwitch) override;

			void SignalSettings(const SignalID signalId,
				const std::string& name,
				const std::string& matchKey) override;

			void SignalDelete(const SignalID signalId,
				const std::string& name,
				const std::string& matchKey) override;

			void SignalState(const ControlType controlType, const DataModel::Signal* signal) override;

			void ProgramRead(const ProgramMode mode, const Address address, const CvNumber cv) override;
			void ProgramWrite(const ProgramMode mode, const Address address, const CvNumber cv, const CvValue value) override;

			void FeedbackDelete(const FeedbackID feedbackID, const std::string& name) override;

			// FIXME: matchKey is missing
			void FeedbackSettings(const FeedbackID feedbackID, const std::string& name) override;

			void AddUnmatchedLocos(std::map<std::string,DataModel::LocoConfig>& list) const override;
			std::map<std::string,DataModel::LocoConfig> GetUnmatchedLocos(const std::string& matchKey) const override;
			DataModel::LocoConfig GetLocoByMatchKey(const std::string& match) const override;

			void AddUnmatchedMultipleUnits(std::map<std::string,DataModel::LocoConfig>& list) const override;
			std::map<std::string,DataModel::LocoConfig> GetUnmatchedMultipleUnits(const std::string& matchKey) const override;
			DataModel::LocoConfig GetMultipleUnitByMatchKey(const std::string& match) const override;

			void AddUnmatchedAccessories(std::map<std::string,DataModel::AccessoryConfig>& list) const override;
			std::map<std::string,DataModel::AccessoryConfig> GetUnmatchedAccessories(const std::string& matchKey) const override;
			DataModel::AccessoryConfig GetAccessoryByMatchKey(const std::string& match) const override;

			void AddUnmatchedFeedbacks(std::map<std::string,DataModel::FeedbackConfig>& list) const override;
			std::map<std::string,DataModel::FeedbackConfig> GetUnmatchedFeedbacks(const std::string& matchKey) const override;
			DataModel::FeedbackConfig GetFeedbackByMatchKey(const std::string& match) const override;

			static void ArgumentTypesOfHardwareTypeAndHint(const HardwareType hardwareType, std::map<unsigned char,ArgumentType>& arguments, std::string& hint);

		private:
			Hardware::HardwareInterface* instance;
			const HardwareParams* params;

			static const std::string Unknown;

			void Init(const HardwareParams* params);
			void Close();
			bool ProgramCheckValues(const ProgramMode mode, const CvNumber cv, const CvValue value = 1);

			void AccessoryBaseState(const Protocol protocol,
				const Address address,
				const DataModel::AccessoryState state,
				const DataModel::AccessoryPulseDuration duration);

			static inline void AccessoryBaseStateStatic(HardwareInterface* instance,
				const Protocol protocol,
				const Address address,
				const DataModel::AccessoryState state,
				const DataModel::AccessoryPulseDuration duration)
			{
				Utils::Utils::SleepForMilliseconds(duration);
				instance->Accessory(protocol, address, state, false, 0);
			}
	};
} // namespace Hardware