From 3fe968544add18d4d9b466e7a214476a1eb59f2d Mon Sep 17 00:00:00 2001 From: Kamil Lewan Date: Thu, 26 Oct 2017 19:50:48 +0200 Subject: [PATCH 1/4] TAirCoupler - partial refactor - rename private members - refactor TAirCoupler::GetStatus() - add some English comments - add 'doc/' in .gitingore TODO: - rename arguments when refactor other files (as TModel3d, cParser). --- .gitignore | 2 ++ AirCoupler.cpp | 85 +++++++++++++++++++++++++++++--------------------- AirCoupler.h | 36 ++++++++++----------- 3 files changed, 68 insertions(+), 55 deletions(-) diff --git a/.gitignore b/.gitignore index d995046f..73131621 100644 --- a/.gitignore +++ b/.gitignore @@ -74,4 +74,6 @@ builds/build_* builds/*.zip builds/deps_* +doc/ + CMakeLists.txt.user diff --git a/AirCoupler.cpp b/AirCoupler.cpp index 5c6c0b09..f8e0c02c 100644 --- a/AirCoupler.cpp +++ b/AirCoupler.cpp @@ -19,60 +19,73 @@ TAirCoupler::~TAirCoupler() { } +// zwraca 1, jeśli istnieje model prosty, 2 gdy skośny +/** + * Returns 0 when straight model exists, + * 2 when oblique model exists, and 0 when neither of them exist. + */ int TAirCoupler::GetStatus() -{ // zwraca 1, jeśli istnieje model prosty, 2 gdy skośny - int x = 0; - if (pModelOn) - x = 1; - if (pModelxOn) - x = 2; - return x; +{ + if (ModelOn) return 1; + if (ModelxOn) return 2; + return 0; } +// zerowanie wskaźników +/** + * Reset pointers. + */ void TAirCoupler::Clear() -{ // zerowanie wskaźników - pModelOn = NULL; - pModelOff = NULL; - pModelxOn = NULL; - bOn = false; - bxOn = false; +{ + ModelOn = NULL; + ModelOff = NULL; + ModelxOn = NULL; + On = false; + xOn = false; } - -void TAirCoupler::Init(std::string const &asName, TModel3d *pModel) -{ // wyszukanie submodeli - if (!pModel) +// wyszukanie submodeli +/** + * Looks for submodels. + */ +void TAirCoupler::Init(std::string const &asName, TModel3d *Model) +{ + if (!Model) return; // nie ma w czym szukać - pModelOn = pModel->GetFromName( asName + "_on" ); // połączony na wprost - pModelOff = pModel->GetFromName( asName + "_off" ); // odwieszony - pModelxOn = pModel->GetFromName( asName + "_xon" ); // połączony na skos + // polaczony na wprost + /** Straight connect. */ + ModelOn = Model->GetFromName(asName + "_on"); + // odwieszony + /** Not connected. Hung up. */ + ModelOff = Model->GetFromName(asName + "_off"); + // polaczony na skos + /** Oblique connect. */ + ModelxOn = Model->GetFromName(asName + "_xon"); } -void TAirCoupler::Load(cParser *Parser, TModel3d *pModel) +void TAirCoupler::Load(cParser *Parser, TModel3d *Model) { std::string name = Parser->getToken(); - if( pModel ) { - - Init( name, pModel ); + if(Model) + { + Init(name, Model); } else { - pModelOn = NULL; - pModelxOn = NULL; - pModelOff = NULL; + ModelOn = NULL; + ModelxOn = NULL; + ModelOff = NULL; } } void TAirCoupler::Update() { - // if ((pModelOn!=NULL) && (pModelOn!=NULL)) + // if ((pModelOn!=NULL) && (pModelOn!=NULL)) // legacy bullshitt alert { - if (pModelOn) - pModelOn->iVisible = bOn; - if (pModelOff) - pModelOff->iVisible = !(bOn || bxOn); - if (pModelxOn) - pModelxOn->iVisible = bxOn; + if (ModelOn) + ModelOn->iVisible = On; + if (ModelOff) + ModelOff->iVisible = !(On || xOn); + if (ModelxOn) + ModelxOn->iVisible = xOn; } } - -//--------------------------------------------------------------------------- diff --git a/AirCoupler.h b/AirCoupler.h index 8cdebaea..3b2cb9a2 100644 --- a/AirCoupler.h +++ b/AirCoupler.h @@ -14,40 +14,38 @@ http://mozilla.org/MPL/2.0/. class TAirCoupler { - private: - // TButtonType eType; - TSubModel *pModelOn, *pModelOff, *pModelxOn; - bool bOn; - bool bxOn; +private: + // TButtonType eType; //? + TSubModel *ModelOn, *ModelOff, *ModelxOn; + bool On; + bool xOn; void Update(); - public: +public: TAirCoupler(); ~TAirCoupler(); + void Clear(); + void Init(std::string const &asName, TModel3d *Model); + void Load(cParser *Parser, TModel3d *Model); + // inline bool Active() { if ((ModelOn)||(ModelOff)) return true; return false;}; + int GetStatus(); inline void TurnOn() { - bOn = true; - bxOn = false; + On = true; + xOn = false; Update(); }; inline void TurnOff() { - bOn = false; - bxOn = false; + On = false; + xOn = false; Update(); }; inline void TurnxOn() { - bOn = false; - bxOn = true; + On = false; + xOn = true; Update(); }; - // inline bool Active() { if ((pModelOn)||(pModelOff)) return true; return false;}; - int GetStatus(); - void Init(std::string const &asName, TModel3d *pModel); - void Load(cParser *Parser, TModel3d *pModel); - // bool Render(); }; - -//--------------------------------------------------------------------------- From 7422beffcc856dd4c849dfc75a6564be2c51c496 Mon Sep 17 00:00:00 2001 From: Kamil Lewan Date: Thu, 26 Oct 2017 20:30:38 +0200 Subject: [PATCH 2/4] TAirCoupler - Delete old comments. --- AirCoupler.cpp | 15 ++++++--------- AirCoupler.h | 3 +-- 2 files changed, 7 insertions(+), 11 deletions(-) diff --git a/AirCoupler.cpp b/AirCoupler.cpp index f8e0c02c..57809933 100644 --- a/AirCoupler.cpp +++ b/AirCoupler.cpp @@ -79,13 +79,10 @@ void TAirCoupler::Load(cParser *Parser, TModel3d *Model) void TAirCoupler::Update() { - // if ((pModelOn!=NULL) && (pModelOn!=NULL)) // legacy bullshitt alert - { - if (ModelOn) - ModelOn->iVisible = On; - if (ModelOff) - ModelOff->iVisible = !(On || xOn); - if (ModelxOn) - ModelxOn->iVisible = xOn; - } + if (ModelOn) + ModelOn->iVisible = On; + if (ModelOff) + ModelOff->iVisible = !(On || xOn); + if (ModelxOn) + ModelxOn->iVisible = xOn; } diff --git a/AirCoupler.h b/AirCoupler.h index 3b2cb9a2..93b504a7 100644 --- a/AirCoupler.h +++ b/AirCoupler.h @@ -15,7 +15,7 @@ http://mozilla.org/MPL/2.0/. class TAirCoupler { private: - // TButtonType eType; //? + // TButtonType eType; TSubModel *ModelOn, *ModelOff, *ModelxOn; bool On; bool xOn; @@ -28,7 +28,6 @@ public: void Clear(); void Init(std::string const &asName, TModel3d *Model); void Load(cParser *Parser, TModel3d *Model); - // inline bool Active() { if ((ModelOn)||(ModelOff)) return true; return false;}; int GetStatus(); inline void TurnOn() { From 899381ae32c75b20cf3a1ab226f87fe5263c2d9d Mon Sep 17 00:00:00 2001 From: Kamil Lewan Date: Thu, 26 Oct 2017 20:26:53 +0200 Subject: [PATCH 3/4] Rename TAirCoupler class to AirCoupler. --- AirCoupler.cpp | 14 +++++++------- AirCoupler.h | 6 +++--- DynObj.h | 16 ++++++++-------- 3 files changed, 18 insertions(+), 18 deletions(-) diff --git a/AirCoupler.cpp b/AirCoupler.cpp index 57809933..2c873365 100644 --- a/AirCoupler.cpp +++ b/AirCoupler.cpp @@ -10,12 +10,12 @@ http://mozilla.org/MPL/2.0/. #include "stdafx.h" #include "AirCoupler.h" -TAirCoupler::TAirCoupler() +AirCoupler::AirCoupler() { Clear(); } -TAirCoupler::~TAirCoupler() +AirCoupler::~AirCoupler() { } @@ -24,7 +24,7 @@ TAirCoupler::~TAirCoupler() * Returns 0 when straight model exists, * 2 when oblique model exists, and 0 when neither of them exist. */ -int TAirCoupler::GetStatus() +int AirCoupler::GetStatus() { if (ModelOn) return 1; if (ModelxOn) return 2; @@ -35,7 +35,7 @@ int TAirCoupler::GetStatus() /** * Reset pointers. */ -void TAirCoupler::Clear() +void AirCoupler::Clear() { ModelOn = NULL; ModelOff = NULL; @@ -47,7 +47,7 @@ void TAirCoupler::Clear() /** * Looks for submodels. */ -void TAirCoupler::Init(std::string const &asName, TModel3d *Model) +void AirCoupler::Init(std::string const &asName, TModel3d *Model) { if (!Model) return; // nie ma w czym szukać @@ -62,7 +62,7 @@ void TAirCoupler::Init(std::string const &asName, TModel3d *Model) ModelxOn = Model->GetFromName(asName + "_xon"); } -void TAirCoupler::Load(cParser *Parser, TModel3d *Model) +void AirCoupler::Load(cParser *Parser, TModel3d *Model) { std::string name = Parser->getToken(); if(Model) @@ -77,7 +77,7 @@ void TAirCoupler::Load(cParser *Parser, TModel3d *Model) } } -void TAirCoupler::Update() +void AirCoupler::Update() { if (ModelOn) ModelOn->iVisible = On; diff --git a/AirCoupler.h b/AirCoupler.h index 93b504a7..58e03c7e 100644 --- a/AirCoupler.h +++ b/AirCoupler.h @@ -12,7 +12,7 @@ http://mozilla.org/MPL/2.0/. #include "Model3d.h" #include "parser.h" -class TAirCoupler +class AirCoupler { private: // TButtonType eType; @@ -22,8 +22,8 @@ private: void Update(); public: - TAirCoupler(); - ~TAirCoupler(); + AirCoupler(); + ~AirCoupler(); void Clear(); void Init(std::string const &asName, TModel3d *Model); diff --git a/DynObj.h b/DynObj.h index c8369855..ef706724 100644 --- a/DynObj.h +++ b/DynObj.h @@ -266,15 +266,15 @@ public: // modele składowe pojazdu TButton btCoupler1; // sprzegi TButton btCoupler2; - TAirCoupler + AirCoupler btCPneumatic1; // sprzegi powietrzne //yB - zmienione z Button na AirCoupler - krzyzyki - TAirCoupler btCPneumatic2; - TAirCoupler btCPneumatic1r; // ABu: to zeby nie bylo problemow przy laczeniu wagonow, - TAirCoupler btCPneumatic2r; // jesli beda polaczone sprzegami 1<->1 lub 0<->0 - TAirCoupler btPneumatic1; // ABu: sprzegi powietrzne zolte - TAirCoupler btPneumatic2; - TAirCoupler btPneumatic1r; // ABu: analogicznie jak 4 linijki wyzej - TAirCoupler btPneumatic2r; + AirCoupler btCPneumatic2; + AirCoupler btCPneumatic1r; // ABu: to zeby nie bylo problemow przy laczeniu wagonow, + AirCoupler btCPneumatic2r; // jesli beda polaczone sprzegami 1<->1 lub 0<->0 + AirCoupler btPneumatic1; // ABu: sprzegi powietrzne zolte + AirCoupler btPneumatic2; + AirCoupler btPneumatic1r; // ABu: analogicznie jak 4 linijki wyzej + AirCoupler btPneumatic2r; TButton btCCtrl1; // sprzegi sterowania TButton btCCtrl2; From a4c30a4837ea13df6fa7617713153c96180fb2ae Mon Sep 17 00:00:00 2001 From: Kamil Lewan Date: Fri, 27 Oct 2017 11:05:17 +0200 Subject: [PATCH 4/4] AirCoupler - comments update. --- AirCoupler.cpp | 34 ++++++++++++++++------------------ AirCoupler.h | 11 ++++++----- 2 files changed, 22 insertions(+), 23 deletions(-) diff --git a/AirCoupler.cpp b/AirCoupler.cpp index 2c873365..32f814fd 100644 --- a/AirCoupler.cpp +++ b/AirCoupler.cpp @@ -19,10 +19,10 @@ AirCoupler::~AirCoupler() { } -// zwraca 1, jeśli istnieje model prosty, 2 gdy skośny /** - * Returns 0 when straight model exists, - * 2 when oblique model exists, and 0 when neither of them exist. + * \return 1 when \(straight\) TModel3d \c ModelOn exists + * \return 2 when \(slanted\) TModel3d \c ModelxOn exists + * \return 0 when neither of them exist */ int AirCoupler::GetStatus() { @@ -31,9 +31,8 @@ int AirCoupler::GetStatus() return 0; } -// zerowanie wskaźników /** - * Reset pointers. + * Reset pointers and variables. */ void AirCoupler::Clear() { @@ -43,25 +42,23 @@ void AirCoupler::Clear() On = false; xOn = false; } -// wyszukanie submodeli + /** - * Looks for submodels. + * Looks for submodels in the model and updates pointers. */ void AirCoupler::Init(std::string const &asName, TModel3d *Model) { if (!Model) - return; // nie ma w czym szukać - // polaczony na wprost - /** Straight connect. */ - ModelOn = Model->GetFromName(asName + "_on"); - // odwieszony - /** Not connected. Hung up. */ - ModelOff = Model->GetFromName(asName + "_off"); - // polaczony na skos - /** Oblique connect. */ - ModelxOn = Model->GetFromName(asName + "_xon"); + return; + ModelOn = Model->GetFromName(asName + "_on"); // Straight connect. + ModelOff = Model->GetFromName(asName + "_off"); // Not connected. Hung up. + ModelxOn = Model->GetFromName(asName + "_xon"); // Slanted connect. } - +/** + * Gets name of submodel \(from cParser \b *Parser\), + * looks for it in the TModel3d \b *Model and update pointers. + * If submodel is not found, reset pointers. +*/ void AirCoupler::Load(cParser *Parser, TModel3d *Model) { std::string name = Parser->getToken(); @@ -77,6 +74,7 @@ void AirCoupler::Load(cParser *Parser, TModel3d *Model) } } +// Update submodels visibility. void AirCoupler::Update() { if (ModelOn) diff --git a/AirCoupler.h b/AirCoupler.h index 58e03c7e..fbb2bd1c 100644 --- a/AirCoupler.h +++ b/AirCoupler.h @@ -15,7 +15,6 @@ http://mozilla.org/MPL/2.0/. class AirCoupler { private: - // TButtonType eType; TSubModel *ModelOn, *ModelOff, *ModelxOn; bool On; bool xOn; @@ -24,24 +23,26 @@ private: public: AirCoupler(); ~AirCoupler(); - + ///Reset members. void Clear(); + ///Looks for submodels. void Init(std::string const &asName, TModel3d *Model); + ///Loads info about coupler. void Load(cParser *Parser, TModel3d *Model); int GetStatus(); - inline void TurnOn() + inline void TurnOn() ///Turns on straight coupler. { On = true; xOn = false; Update(); }; - inline void TurnOff() + inline void TurnOff() ///Turns on disconnected coupler. { On = false; xOn = false; Update(); }; - inline void TurnxOn() + inline void TurnxOn() ///Turns on slanted coupler. { On = false; xOn = true;