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 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148
|
/*
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 <map>
#include <mutex>
#include <sstream>
#include <string>
#include <iomanip>
#include <vector>
#include "Config.h"
#include "ControlInterface.h"
#include "DataModel/AccessoryConfig.h"
#include "DataModel/DataModel.h"
#include "DataModel/FeedbackConfig.h"
#include "DataModel/LocoConfig.h"
#include "DataModel/ObjectIdentifier.h"
#include "Hardware/HardwareParams.h"
#include "Hardware/LocoCache.h"
#include "Logger/Logger.h"
#include "Storage/StorageHandler.h"
class Manager
{
public:
Manager() = delete;
Manager(const Manager&) = delete;
Manager& operator=(const Manager&) = delete;
Manager(Config& config);
~Manager();
// booster
inline BoosterState Booster() const
{
return boosterState;
}
void Booster(const ControlType controlType, const BoosterState status);
// hardware (virt, CS2, ...)
bool ControlSave(ControlID controlID,
const HardwareType& hardwareType,
const std::string& name,
const std::string& arg1,
const std::string& arg2,
const std::string& arg3,
const std::string& arg4,
const std::string& arg5,
std::string& result);
bool ControlDelete(ControlID controlID);
Hardware::HardwareParams* GetHardware(const ControlID controlID);
unsigned int ControlsOfHardwareType(const HardwareType hardwareType);
// control (console, web, ...)
const std::string GetControlName(const ControlID controlID);
const std::map<std::string,Hardware::HardwareParams*> ControlListByName() const;
const std::map<ControlID,std::string> ControlListNames(const Hardware::Capabilities capability) const;
inline const std::map<std::string,Protocol> LocoProtocolsOfControl(const ControlID controlID) const
{
return ProtocolsOfControl(AddressTypeLoco, controlID);
}
inline const std::map<std::string,Protocol> AccessoryProtocolsOfControl(const ControlID controlID) const
{
return ProtocolsOfControl(AddressTypeAccessory, controlID);
}
// loco
std::string GetLocoList() const;
DataModel::Loco* GetLoco(const LocoID locoID) const;
DataModel::LocoConfig GetLocoOfConfigByMatchKey(const ControlID controlId, const std::string& matchKey) const;
DataModel::Loco* GetLocoByMatchKey(const ControlID controlId, const std::string& matchKey) const;
void LocoRemoveMatchKey(const LocoID locoId);
void LocoReplaceMatchKey(const LocoID locoId, const std::string& newMatchKey);
const std::map<std::string,DataModel::LocoConfig> GetUnmatchedLocosOfControl(const ControlID controlId,
const std::string& matchKey) const;
const std::map<std::string,LocoID> LocoBaseListFree() const;
const std::map<std::string,DataModel::LocoConfig> LocoConfigByName() const;
const std::map<std::string,LocoID> LocoIdsByName() const;
inline void LocoSave(const DataModel::Loco* loco) const
{
if (!storage)
{
return;
}
Storage::TransactionGuard guard(storage);
storage->Save(*loco);
}
bool LocoSave(LocoID locoID,
const std::string& name,
const ControlID controlID,
const std::string& matchKey,
const Protocol protocol,
const Address address,
const Address serverAddress,
const Length length,
const bool pushpull,
const Speed maxSpeed,
const Speed travelSpeed,
const Speed reducedSpeed,
const Speed creepingSpeed,
const Propulsion propulsion,
const TrainType type,
const std::vector<DataModel::LocoFunctionEntry>& locoFunctions,
std::string& result);
bool LocoDelete(const LocoID locoID,
std::string& result);
inline bool LocoDelete(const LocoID locoId)
{
std::string result;
return LocoDelete(locoId, result);
}
bool LocoProtocolAddress(const LocoID locoID, ControlID& controlID, Protocol& protocol, Address& address) const;
inline void LocoSpeed(const ControlType controlType,
const ControlID controlID,
const Protocol protocol,
const Address address,
const Speed speed)
{
// nullptr check of loco is done within submethod
LocoBaseSpeed(controlType, GetLoco(controlID, protocol, address), speed);
}
inline bool LocoBaseSpeed(const ControlType controlType,
const DataModel::ObjectIdentifier& locoBaseIdentifier,
const Speed speed)
{
// nullptr check of loco is done within submethod
return LocoBaseSpeed(controlType, GetLocoBase(locoBaseIdentifier), speed);
}
bool LocoBaseSpeed(const ControlType controlType,
DataModel::LocoBase* loco,
const Speed speed);
Speed LocoSpeed(const LocoID locoID) const;
inline void LocoOrientation(const ControlType controlType,
const ControlID controlID,
const Protocol protocol,
const Address address,
const Orientation orientation)
{
// nullptr check of loco is done within submethod
LocoBaseOrientation(controlType, GetLoco(controlID, protocol, address), orientation);
}
inline void LocoBaseOrientation(const ControlType controlType,
const DataModel::ObjectIdentifier& locoBaseIdentifier,
const Orientation orientation)
{
// nullptr check of loco is done within submethod
LocoBaseOrientation(controlType, GetLocoBase(locoBaseIdentifier), orientation);
}
void LocoBaseOrientation(const ControlType controlType,
DataModel::LocoBase* loco,
Orientation orientation);
void LocoFunctionState(const ControlType controlType,
const ControlID controlID,
const Protocol protocol,
const Address address,
const DataModel::LocoFunctionNr function,
const DataModel::LocoFunctionState on)
{
// nullptr check of loco is done within submethod
LocoBaseFunctionState(controlType, GetLoco(controlID, protocol, address), function, on);
}
void LocoBaseFunctionState(const ControlType controlType,
const DataModel::ObjectIdentifier& locoBaseIdentifier,
const DataModel::LocoFunctionNr function,
const DataModel::LocoFunctionState on);
void LocoBaseFunctionState(const ControlType controlType,
DataModel::LocoBase* loco,
const DataModel::LocoFunctionNr function,
const DataModel::LocoFunctionState on);
// multiple unit
DataModel::MultipleUnit* GetMultipleUnit(const MultipleUnitID multipleUnitId) const;
DataModel::LocoConfig GetMultipleUnitOfConfigByMatchKey(const ControlID controlId,
const std::string& matchKey) const;
const std::map<std::string,DataModel::LocoConfig> MultipleUnitConfigByName() const;
inline void MultipleUnitSave(const DataModel::MultipleUnit* multipleUnit) const
{
if (!storage)
{
return;
}
Storage::TransactionGuard guard(storage);
storage->Save(*multipleUnit);
}
bool MultipleUnitSave(MultipleUnitID multipleUnitID,
const std::string& name,
const ControlID controlID,
const std::string& matchKey,
const Address address,
const Address serverAddress,
const Length length,
const bool pushpull,
const Speed maxSpeed,
const Speed travelSpeed,
const Speed reducedSpeed,
const Speed creepingSpeed,
const TrainType type,
const std::vector<DataModel::LocoFunctionEntry>& locoFunctions,
const std::vector<DataModel::Relation*>& slaves,
std::string& result);
bool MultipleUnitDelete(const MultipleUnitID multipleUnitID,
std::string& result);
inline bool MultipleUnitDelete(const MultipleUnitID multipleUnitId)
{
std::string result;
return MultipleUnitDelete(multipleUnitId, result);
}
bool MultipleUnitRelease(const MultipleUnitID multipleUnitID);
// locobase
inline DataModel::LocoBase* GetLocoBase(const DataModel::ObjectIdentifier& locoBaseIdentifier) const
{
return locoBaseIdentifier.GetObjectType() == ObjectTypeLoco
? static_cast<DataModel::LocoBase*>(GetLoco(locoBaseIdentifier.GetObjectID()))
: static_cast<DataModel::LocoBase*>(GetMultipleUnit(locoBaseIdentifier.GetObjectID()));
}
const std::map<std::string,LocoID> LocoBaseIdsByName() const;
const std::string& GetLocoBaseName(const DataModel::ObjectIdentifier& locoBaseIdentifier) const;
// accessory base
inline DataModel::AccessoryBase* GetAccessoryBase(const DataModel::ObjectIdentifier& accessoryBaseIdentifier) const
{
switch (accessoryBaseIdentifier.GetObjectType())
{
case ObjectTypeAccessory:
return static_cast<DataModel::AccessoryBase*>(GetAccessory(accessoryBaseIdentifier.GetObjectID()));
case ObjectTypeSwitch:
return static_cast<DataModel::AccessoryBase*>(GetSwitch(accessoryBaseIdentifier.GetObjectID()));
case ObjectTypeSignal:
return static_cast<DataModel::AccessoryBase*>(GetSignal(accessoryBaseIdentifier.GetObjectID()));
default:
return nullptr;
}
}
void AccessoryBaseState(const ControlType controlType,
const ControlID controlID,
const Protocol protocol,
const Address address,
const DataModel::AccessoryState state);
void AccessoryBaseState(const ControlType controlType,
const DataModel::ObjectIdentifier& identifier,
const DataModel::AccessoryState state);
// accessory
bool AccessoryState(const ControlType controlType, const AccessoryID accessoryID, const DataModel::AccessoryState state, const bool force = false);
void AccessoryState(const ControlType controlType, const AccessoryID accessoryID, const DataModel::AccessoryState state, const bool inverted, const bool on);
DataModel::Accessory* GetAccessory(const AccessoryID accessoryID) const;
const std::map<std::string,DataModel::AccessoryConfig> GetUnmatchedAccessoriesOfControl(const ControlID controlId,
const std::string& matchKey) const;
const std::string& GetAccessoryName(const AccessoryID accessoryID) const;
inline const std::map<AccessoryID,DataModel::Accessory*>& AccessoryList() const
{
return accessories;
}
const std::map<std::string,DataModel::AccessoryConfig> AccessoryConfigByName() const;
bool AccessorySave(AccessoryID accessoryID,
const std::string& name,
const DataModel::LayoutItem::LayoutPosition x,
const DataModel::LayoutItem::LayoutPosition y,
const DataModel::LayoutItem::LayoutPosition z,
const DataModel::LayoutItem::LayoutRotation rotation,
const ControlID controlID,
const std::string& matchKey,
const Protocol protocol,
const Address address,
const AddressPort port,
const Address serverAddress,
const DataModel::AccessoryType type,
const DataModel::AccessoryPulseDuration duration,
const bool inverted,
std::string& result);
bool AccessoryDelete(const AccessoryID accessoryID,
std::string& result);
bool AccessoryRelease(const AccessoryID accessoryID);
DataModel::AccessoryConfig GetAccessoryOfConfigByMatchKey(const ControlID controlId, const std::string& matchKey) const;
DataModel::Accessory* GetAccessoryByMatchKey(const ControlID controlId, const std::string& matchKey) const;
void AccessoryRemoveMatchKey(const AccessoryID accessoryId);
// feedback
void FeedbackState(const ControlID controlID, const FeedbackPin pin, const DataModel::Feedback::FeedbackState state);
void FeedbackState(const FeedbackID feedbackID, const DataModel::Feedback::FeedbackState state);
void FeedbackPublishState(const DataModel::Feedback* feedback);
DataModel::Feedback* GetFeedback(const FeedbackID feedbackID) const;
DataModel::Feedback* GetFeedbackUnlocked(const FeedbackID feedbackID) const;
const std::string& GetFeedbackName(const FeedbackID feedbackID) const;
inline const std::map<FeedbackID,DataModel::Feedback*>& FeedbackList() const
{
return feedbacks;
}
const std::map<std::string,DataModel::Feedback*> FeedbackListByName() const;
const std::map<RouteID,std::string> RoutesOfTrack(const TrackID trackID) const;
const std::map<std::string,FeedbackID> FeedbacksOfTrack(const TrackID trackID) const;
const std::map<std::string,DataModel::FeedbackConfig> FeedbackConfigByName() const;
bool FeedbackSave(FeedbackID feedbackID,
const std::string& name,
const DataModel::LayoutItem::Visible visible,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
const DataModel::LayoutItem::LayoutRotation rotation,
const ControlID controlID,
const std::string& matchKey,
const FeedbackPin pin,
const bool inverted,
const DataModel::FeedbackType feedbackType,
const RouteID routeId,
std::string& result);
bool FeedbackDelete(const FeedbackID feedbackID,
std::string& result);
inline bool FeedbackExists(const FeedbackID feedbackID) const
{
return feedbacks.count(feedbackID) == 1;
}
DataModel::FeedbackConfig GetFeedbackOfConfigByMatchKey(const ControlID controlId, const std::string& matchKey) const;
DataModel::Feedback* GetFeedbackByMatchKey(const ControlID controlId, const std::string& matchKey) const;
void FeedbackRemoveMatchKey(const FeedbackID feedbackId);
void FeedbackReplaceMatchKey(const FeedbackID feedbackId, const std::string& newMatchKey);
const std::map<std::string,DataModel::FeedbackConfig> GetUnmatchedFeedbacksOfControl(const ControlID controlId,
const std::string& matchKey) const;
// track
DataModel::Track* GetTrack(const TrackID trackID) const;
const std::string& GetTrackName(const TrackID trackID) const;
inline const std::map<TrackID,DataModel::Track*>& TrackList() const
{
return tracks;
}
const std::map<std::string,DataModel::Track*> TrackListByName() const;
const std::map<std::string,DataModel::Track*> TrackListMasterByName() const;
const std::map<std::string,TrackID> TrackListIdByName(const TrackID excludeTrackID = TrackNone) const;
inline void TrackSave(const DataModel::Track* track) const
{
if (!storage)
{
return;
}
Storage::TransactionGuard guard(storage);
storage->Save(*track);
}
bool TrackSave(const TrackID trackID,
const std::string& name,
const bool showName,
const std::string& displayName,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
const DataModel::LayoutItem::LayoutItemSize width,
const DataModel::LayoutItem::LayoutRotation rotation,
const DataModel::TrackType trackType,
const TrackID main,
const std::vector<DataModel::Relation*>& newFeedbacks,
const std::vector<DataModel::Relation*>& newSignals,
const DataModel::SelectRouteApproach selectRouteApproach,
const bool allowLocoTurn,
const bool releaseWhenFree,
std::string& result);
bool TrackDelete(const TrackID trackID,
std::string& result);
// switch
bool SwitchState(const ControlType controlType, const SwitchID switchID, const DataModel::AccessoryState state, const bool force = false);
DataModel::Switch* GetSwitch(const SwitchID switchID) const;
const std::string& GetSwitchName(const SwitchID switchID) const;
inline const std::map<SwitchID,DataModel::Switch*>& SwitchList() const
{
return switches;
}
const std::map<std::string,DataModel::AccessoryConfig> SwitchConfigByName() const;
bool SwitchSave(SwitchID switchID,
const std::string& name,
const DataModel::LayoutItem::LayoutPosition x,
const DataModel::LayoutItem::LayoutPosition y,
const DataModel::LayoutItem::LayoutPosition z,
const DataModel::LayoutItem::LayoutRotation rotation,
const ControlID controlID,
const std::string& matchKey,
const Protocol protocol,
const Address address,
const Address serverAddress,
const DataModel::AccessoryType type,
const DataModel::AccessoryPulseDuration duration,
const bool inverted,
std::string& result);
bool SwitchDelete(const SwitchID switchID,
std::string& result);
bool SwitchRelease(const SwitchID switchID);
DataModel::Switch* GetSwitchByMatchKey(const ControlID controlId, const std::string& matchKey) const;
void SwitchRemoveMatchKey(const SwitchID switchId);
// route
bool RouteExecute(Logger::Logger* logger, const DataModel::ObjectIdentifier& locoBaseIdentifier, const RouteID routeID);
void RouteExecuteAsync(Logger::Logger* logger, const RouteID routeID);
std::string GetRouteList() const;
DataModel::Route* GetRoute(const RouteID routeID) const;
const std::string& GetRouteName(const RouteID routeID) const;
inline const std::map<RouteID,DataModel::Route*>& RouteList() const
{
return routes;
}
const std::map<std::string,DataModel::Route*> RouteListByName() const;
inline void RouteSave(const DataModel::Route* route) const
{
if (!storage)
{
return;
}
Storage::TransactionGuard guard(storage);
storage->Save(*route);
}
bool RouteSave(RouteID routeID,
const std::string& name,
const Delay delay,
const DataModel::Route::PushpullType pushpull,
const Propulsion propulsion,
const TrainType trainType,
const Length minTrainLength,
const Length maxTrainLength,
const std::vector<DataModel::Relation*>& relationsAtLock,
const std::vector<DataModel::Relation*>& relationsAtUnlock,
const DataModel::LayoutItem::Visible visible,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
const Automode automode,
const TrackID fromTrack,
const Orientation fromOrientation,
const TrackID toTrack,
const Orientation toOrientation,
const DataModel::Route::Speed speed,
const FeedbackID feedbackIdReduced,
const Delay reducedDelay,
const FeedbackID feedbackIdCreep,
const Delay creepDelay,
const FeedbackID feedbackIdStop,
const Delay stopDelay,
const FeedbackID feedbackIdOver,
const Pause waitAfterRelease,
const RouteID followUpRoute,
std::string& result);
bool RouteDelete(const RouteID routeID,
std::string& result);
DataModel::Route* GetFirstRouteFromOrToTrack(const TrackID trackID) const;
inline bool HasRouteFromOrToTrack(const TrackID trackID) const
{
return (GetFirstRouteFromOrToTrack(trackID) != nullptr);
}
// layer
DataModel::Layer* GetLayer(const LayerID layerID) const;
const std::map<std::string,LayerID> LayerListByName() const;
const std::map<std::string,LayerID> LayerListByNameWithFeedback() const;
bool LayerSave(const LayerID layerID, const std::string&name, std::string& result);
bool LayerDelete(const LayerID layerID,
std::string& result);
// signal
bool SignalState(const ControlType controlType, const SignalID signalID, const DataModel::AccessoryState state, const bool force = false);
bool SignalState(const ControlType controlType, DataModel::Signal* signal, const DataModel::AccessoryState state, const bool force = false);
DataModel::Signal* GetSignal(const SignalID signalID) const;
const std::string& GetSignalName(const SignalID signalID) const;
inline const std::map<SignalID,DataModel::Signal*>& SignalList() const
{
return signals;
}
const std::map<std::string,DataModel::Signal*> SignalListByName() const;
const std::map<std::string,DataModel::AccessoryConfig> SignalConfigByName() const;
bool SignalSave(SignalID signalID,
const std::string& name,
const DataModel::LayoutItem::LayoutPosition x,
const DataModel::LayoutItem::LayoutPosition y,
const DataModel::LayoutItem::LayoutPosition z,
const DataModel::LayoutItem::LayoutItemSize height,
const DataModel::LayoutItem::LayoutRotation rotation,
const ControlID controlID,
const std::string& matchKey,
const Protocol protocol,
const Address address,
const Address serverAddress,
const DataModel::AccessoryType type,
const std::map<DataModel::AccessoryState,DataModel::AddressOffset>& offsets,
const DataModel::AccessoryPulseDuration duration,
const bool inverted,
std::string& result);
bool SignalDelete(const SignalID signalID,
std::string& result);
void SignalPublishState(const ControlType controlType, const DataModel::Signal* signal);
DataModel::Signal* GetSignalByMatchKey(const ControlID controlId, const std::string& matchKey) const;
void SignalRemoveMatchKey(const SignalID signalId);
bool SignalRelease(const SignalID signalID);
// cluster
DataModel::Cluster* GetCluster(const ClusterID clusterID) const;
const std::map<std::string,DataModel::Cluster*> ClusterListByName() const;
bool ClusterSave(ClusterID clusterID,
const std::string& name,
const std::vector<DataModel::Relation*>& newTracks,
std::string& result);
bool ClusterDelete(const ClusterID clusterID);
// text
DataModel::Text* GetText(const TextID textID) const;
inline const std::map<TextID,DataModel::Text*>& TextList() const
{
return texts;
}
const std::map<std::string,DataModel::Text*> TextListByName() const;
bool TextSave(TextID textID,
const std::string& name,
const DataModel::LayoutItem::LayoutPosition x,
const DataModel::LayoutItem::LayoutPosition y,
const DataModel::LayoutItem::LayoutPosition z,
const DataModel::LayoutItem::LayoutItemSize width,
const DataModel::LayoutItem::LayoutRotation rotation,
std::string& result);
bool TextDelete(const TextID textID,
std::string& result);
// counter
DataModel::Counter* GetCounter(const CounterID counterID) const;
bool Count(const CounterID counterID, const DataModel::CounterType type);
inline const std::map<TextID,DataModel::Counter*>& CounterList() const
{
return counters;
}
const std::map<std::string,DataModel::Counter*> CounterListByName() const;
bool CounterSave(CounterID counterID,
const std::string& name,
const int max,
const int min,
const DataModel::LayoutItem::LayoutPosition x,
const DataModel::LayoutItem::LayoutPosition y,
const DataModel::LayoutItem::LayoutPosition z,
const DataModel::LayoutItem::LayoutRotation rotation,
std::string& result);
bool CounterDelete(const CounterID counterID,
std::string& result);
// automode
bool LocoBaseIntoTrack(Logger::Logger* logger, const DataModel::ObjectIdentifier& locoBaseIdentifier, const TrackID trackID);
bool LocoRelease(const LocoID locoID);
bool TrackRelease(const TrackID trackID);
bool LocoBaseReleaseOnTrack(const TrackID trackID);
bool TrackStartLocoBase(const TrackID trackID);
bool TrackStopLocoBase(const TrackID trackID);
void TrackBlock(const TrackID trackID, const bool blocked);
void TrackSetLocoOrientation(const TrackID trackID, const Orientation orientation);
void TrackPublishState(const DataModel::Track* track);
bool RouteRelease(const RouteID routeID);
bool LocoDestinationReached(const DataModel::LocoBase* loco,
const DataModel::Route* route,
const DataModel::Track* track);
bool LocoBaseStart(const DataModel::ObjectIdentifier& locoBaseIdentifier);
bool LocoBaseStartAll();
bool LocoBaseStop(const DataModel::ObjectIdentifier& locoBaseIdentifier);
bool LocoBaseStopAll();
void LocoBaseStopAllImmediately(const ControlType controlType);
bool LocoBaseAddTimeTable(const DataModel::ObjectIdentifier& locoBaseIdentifier,
const RouteID routeID,
const bool automode);
std::string GetCs2Lokomotive() const;
static std::string GetCs2Magnetartikel(const DataModel::AccessoryBase* base);
std::string GetCs2Magnetartikel() const;
std::string GetCs2GBS() const;
std::string GetCs2GBS(const signed char gbs) const;
inline DataModel::ObjectIdentifier GetLocoBaseIdentifierOfTrack(const TrackID trackId)
{
const DataModel::Track* track = GetTrack(trackId);
return (track ? track->GetLocoBase() : DataModel::ObjectIdentifier());
}
// settings
inline StartupInitLocos GetStartupInitLocos() const
{
return startupInitLocos;
}
inline DataModel::AccessoryPulseDuration GetDefaultAccessoryDuration() const
{
return defaultAccessoryDuration;
}
inline bool GetAutoAddFeedback() const
{
return autoAddFeedback;
}
inline bool GetStopOnFeedbackInFreeTrack() const
{
return stopOnFeedbackInFreeTrack;
}
inline bool GetExecuteAccessory() const
{
return executeAccessory;
}
inline DataModel::SelectRouteApproach GetSelectRouteApproach() const
{
return selectRouteApproach;
}
inline DataModel::Loco::NrOfTracksToReserve GetNrOfTracksToReserve() const
{
return nrOfTracksToReserve;
}
bool SettingsSave(const Languages::Language language,
const StartupInitLocos startupInitLocos,
const DataModel::AccessoryPulseDuration duration,
const bool autoAddFeedback,
const bool stopOnFeedbackInFreeTrack,
const bool executeAccessoryAlways,
const DataModel::SelectRouteApproach selectRouteApproach,
const DataModel::Loco::NrOfTracksToReserve nrOfTracksToReserve,
const Logger::Logger::Level logLevel
);
ControlID GetPossibleControlForLoco() const;
ControlID GetPossibleControlForAccessory() const;
ControlID GetPossibleControlForFeedback() const;
void ProgramRead(const ControlID controlID, const ProgramMode mode, const Address address, const CvNumber cv);
void ProgramWrite(const ControlID controlID, const ProgramMode mode, const Address address, const CvNumber cv, const CvValue value);
void ProgramValue(const CvNumber cv, const CvValue value);
inline static void ProgramDccValueStatic(Manager* manager, const CvNumber cv, const CvValue value)
{
manager->ProgramValue(cv, value);
}
bool CanHandle(const Hardware::Capabilities capability) const;
bool CanHandle(const ControlID controlId, const Hardware::Capabilities capability) const;
Hardware::Capabilities GetCapabilities(const ControlID controlID) const;
bool LayoutItemRotate(const DataModel::ObjectIdentifier& identifier,
std::string& result);
bool LayoutItemNewPosition(const DataModel::ObjectIdentifier& identifier,
const DataModel::LayoutItem::LayoutItemSize posX,
const DataModel::LayoutItem::LayoutItemSize posY,
std::string& result);
inline bool IsServerEnabled() const
{
return serverEnabled;
}
DataModel::ObjectIdentifier GetIdentifierOfServerLocoAddress(const Address serverAddress) const;
DataModel::ObjectIdentifier GetIdentifierOfServerAccessoryAddress(const Address serverAddress) const;
private:
bool ControlIsOfHardwareType(const ControlID controlID, const HardwareType hardwareType);
ControlInterface* GetControl(const ControlID controlID) const;
DataModel::Loco* GetLoco(const ControlID controlID,
const Protocol protocol,
const Address address) const;
DataModel::Accessory* GetAccessory(const ControlID controlID,
const Protocol protocol,
const Address address,
const AddressPort port) const;
DataModel::Switch* GetSwitch(const ControlID controlID, const Protocol protocol, const Address address) const;
DataModel::Feedback* GetFeedback(const ControlID controlID, const FeedbackPin pin) const;
DataModel::Signal* GetSignal(const ControlID controlID, const Protocol protocol, const Address address) const;
void AccessoryState(const ControlType controlType, DataModel::Accessory* accessory, const DataModel::AccessoryState state, const bool force);
void SwitchState(const ControlType controlType, DataModel::Switch* mySwitch, const DataModel::AccessoryState state, const bool force);
static inline void FeedbackState(DataModel::Feedback* feedback, const DataModel::Feedback::FeedbackState state)
{
feedback->SetState(state);
}
bool AccessoryPosition(const AccessoryID accessoryID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool FeedbackPosition(const FeedbackID feedbackID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool RoutePosition(const RouteID routeID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool SignalPosition(const SignalID signalID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool SwitchPosition(const SwitchID switchID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool TextPosition(const TextID textID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool TrackPosition(const TrackID trackID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool CounterPosition(const CounterID counterID,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
std::string& result);
bool AccessoryRotate(const AccessoryID accessoryID,
std::string& result);
bool FeedbackRotate(const FeedbackID feedbackID,
std::string& result);
bool SignalRotate(const SignalID signalID,
std::string& result);
bool SwitchRotate(const SwitchID switchID,
std::string& result);
bool TextRotate(const TextID textID,
std::string& result);
bool TrackRotate(const TrackID trackID,
std::string& result);
bool CounterRotate(const CounterID counterID,
std::string& result);
void AccessorySaveAndPublishSettings(const DataModel::Accessory* const accessory);
void FeedbackSaveAndPublishSettings(const DataModel::Feedback* const feedback);
void RouteSaveAndPublishSettings(const DataModel::Route* const route);
void SignalSaveAndPublishSettings(const DataModel::Signal* const signal);
void SwitchSaveAndPublishSettings(const DataModel::Switch* const mySwitch);
void TextSaveAndPublishSettings(const DataModel::Text* const text);
void TrackSaveAndPublishSettings(const DataModel::Track* const track);
void CounterSaveAndPublishSettings(const DataModel::Counter* const counter);
void CounterPublishState(const DataModel::Counter* const counter);
// layout
bool CheckPositionFree(const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
std::string& result) const;
bool CheckPositionFree(const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
const DataModel::LayoutItem::LayoutItemSize width,
const DataModel::LayoutItem::LayoutItemSize height,
const DataModel::LayoutItem::LayoutRotation rotation,
std::string& result) const;
template<class Type>
bool CheckLayoutPositionFree(const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
std::string& result,
const std::map<ObjectID, Type*>& layoutVector, std::mutex& mutex) const;
bool CheckLayoutItemPosition(const DataModel::LayoutItem* layoutItem,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
std::string& result) const;
bool CheckLayoutItemPosition(const DataModel::LayoutItem* item,
const DataModel::LayoutItem::LayoutPosition posX,
const DataModel::LayoutItem::LayoutPosition posY,
const DataModel::LayoutItem::LayoutPosition posZ,
const DataModel::LayoutItem::LayoutItemSize width,
const DataModel::LayoutItem::LayoutItemSize height,
const DataModel::LayoutItem::LayoutRotation rotation,
std::string& result) const;
bool CheckAddressLoco(const Protocol protocol, const Address address, std::string& result);
bool CheckAddressAccessory(const Protocol protocol, const Address address, std::string& result);
inline bool CheckControlLocoProtocolAddress(const ControlID controlID,
const Protocol protocol,
const Address address,
std::string& result)
{
return CheckControlProtocolAddress(AddressTypeLoco, controlID, protocol, address, result);
}
inline bool CheckControlMultipleUnitProtocolAddress(const ControlID controlID,
const Address address,
std::string& result)
{
return CheckControlProtocolAddress(AddressTypeMultipleUnit, controlID, ProtocolNone, address, result);
}
inline bool CheckControlAccessoryProtocolAddress(const ControlID controlID,
const Protocol protocol,
const Address address,
std::string& result)
{
return CheckControlProtocolAddress(AddressTypeAccessory, controlID, protocol, address, result);
}
bool CheckControlProtocolAddress(const AddressType type, const ControlID controlID, const Protocol protocol, const Address address, std::string& result);
const std::map<std::string,Protocol> ProtocolsOfControl(const AddressType type, const ControlID) const;
bool LocoBaseReleaseInternal(DataModel::LocoBase* locoBase);
bool LayerHasElements(const DataModel::Layer* layer,
std::string& result);
template<class Key, class Value>
void DeleteAllMapEntries(std::map<Key,Value*>& m, std::mutex& x)
{
std::lock_guard<std::mutex> Guard(x);
while (m.size())
{
auto it = m.begin();
Value* content = it->second;
m.erase(it);
if (storage != nullptr)
{
logger->Info(Languages::TextSaving, content->GetName());
storage->Save(*content);
}
delete content;
}
}
void DebounceWorker();
template<class ID, class T>
T* CreateAndAddObject(std::map<ID,T*>& objects, std::mutex& mutex);
Hardware::HardwareParams* CreateAndAddControl();
template<class ID, class T>
bool CheckObjectName(std::map<ID,T*>& objects, const std::string& name)
{
for (auto& object : objects)
{
if (object.second->GetName().compare(name) == 0)
{
return false;
}
}
return true;
}
inline bool CheckIfNumber(const char& c)
{
return c >= '0' && c <= '9';
}
inline bool CheckIfThreeNumbers(const std::string& s)
{
const size_t sSize = s.size();
return sSize >= 3
&& CheckIfNumber(s.at(sSize - 1))
&& CheckIfNumber(s.at(sSize - 2))
&& CheckIfNumber(s.at(sSize - 3));
}
template<class ID, class T>
std::string CheckObjectName(std::map<ID,T*>& objects, std::mutex& mutex, const ID objectID, const std::string& name)
{
std::lock_guard<std::mutex> Guard(mutex);
if (objects.count(objectID) == 1)
{
const T* o = objects.at(objectID);
const std::string& oldName = o->GetName();
if (oldName.compare(name) == 0)
{
return name;
}
}
if (CheckObjectName(objects, name))
{
return name;
}
unsigned int counter = 0;
const std::string baseName = CheckIfThreeNumbers(name) ? name.substr(0, name.size() - 3) : name;
while (true)
{
++counter;
std::stringstream ss;
ss << baseName << std::setw(3) << std::setfill('0') << counter;
std::string newName = ss.str();
if (CheckObjectName(objects, newName))
{
return newName;
}
}
}
bool LocoIntoTrack(Logger::Logger *logger,
DataModel::Loco* loco,
const ObjectType objectType,
DataModel::Track* track);
void InitLocos();
static inline void InitLocosStatic(Manager* manager)
{
manager->InitLocos();
}
void ProgramCheckBooster(const ProgramMode mode);
bool ObjectIsPartOfRoute(const DataModel::ObjectIdentifier& identifier,
const DataModel::Object* object,
std::string& result);
Logger::Logger* logger;
volatile BoosterState boosterState;
// FIXME: check usage of all mutexes
// controls (Webserver & hardwareHandler. So each hardware is also added here).
std::map<ControlID,ControlInterface*> controls;
mutable std::mutex controlMutex;
// hardware (virt, CS2, ...)
std::map<ControlID,Hardware::HardwareParams*> hardwareParams;
mutable std::mutex hardwareMutex;
// loco
std::map<LocoID,DataModel::Loco*> locos;
mutable std::mutex locoMutex;
// multiple unit
std::map<LocoID,DataModel::MultipleUnit*> multipleUnits;
mutable std::mutex multipleUnitMutex;
// accessory
std::map<AccessoryID,DataModel::Accessory*> accessories;
mutable std::mutex accessoryMutex;
// feedback
std::map<FeedbackID,DataModel::Feedback*> feedbacks;
mutable std::mutex feedbackMutex;
// track
std::map<TrackID,DataModel::Track*> tracks;
mutable std::mutex trackMutex;
// switch
std::map<SwitchID,DataModel::Switch*> switches;
mutable std::mutex switchMutex;
// route
std::map<RouteID,DataModel::Route*> routes;
mutable std::mutex routeMutex;
// layer
std::map<LayerID,DataModel::Layer*> layers;
mutable std::mutex layerMutex;
// signal
std::map<SignalID,DataModel::Signal*> signals;
mutable std::mutex signalMutex;
// cluster
std::map<SignalID,DataModel::Cluster*> clusters;
mutable std::mutex clusterMutex;
// text
std::map<TextID,DataModel::Text*> texts;
mutable std::mutex textMutex;
// counter
std::map<CounterID,DataModel::Counter*> counters;
mutable std::mutex counterMutex;
// storage
Storage::StorageHandler* storage;
StartupInitLocos startupInitLocos;
DataModel::AccessoryPulseDuration defaultAccessoryDuration;
bool autoAddFeedback;
bool stopOnFeedbackInFreeTrack;
bool executeAccessory;
DataModel::SelectRouteApproach selectRouteApproach;
DataModel::Loco::NrOfTracksToReserve nrOfTracksToReserve;
volatile bool run;
volatile bool debounceRun;
std::thread debounceThread;
volatile bool initLocosDone;
bool serverEnabled;
const std::string unknownControl;
const std::string unknownLoco;
const std::string unknownMultipleUnit;
const std::string unknownAccessory;
const std::string unknownFeedback;
const std::string unknownTrack;
const std::string unknownSwitch;
const std::string unknownRoute;
const std::string unknownSignal;
};
|