Cleaning up module.h

[christianurich]

Since the module.h is the one of the most used headers and the face of dynamind it should be clean. At the moment it's a bit messy. Mix of private and public and protected. Also can the ModuleObserver be moved into a separate file.

I'm also not a really big fan of classes in classes (struct) since it disrupts the reading of the header and makes the project quite hard to navigate. (at least with the qtcreator). Unless there is a really good reason do have that a class sits within a class it should be avoided. (@abroxos opinion?)

[zacharias2k]

I'm currently cleaning up and making docu for the front-API, that espacially includes dmmodule.h - it's currently in progress (see my commit history...) But also dmsimulation.h etc.

New source file for ModuleObserver - yes of course, on the way.

I'm with you, class in class really can be disgusting to read. I only accept those things if no methods are provided (therefore a 'plain' variable container), which was the intention. I will have a look and optimize those things, outsourcing if necessary.

[christianurich]

cool

By the way. This are not real issues I just put them in here as kind of a todo list. I'll add a new label to make that more clear.

[abroxos]

I would suggest:

• ModuleObserver in a new header file
• Structure of Module header: typedef, structs, classes, in classes first all public vars, public methodes and then private vars and methodes

2013/8/13 Christian Urich notifications@github.com

Since the module.h is the one of the most used headers and the face of dynamind it should be clean. At the moment it's a bit messy. Mix of private and public and protected. Also can the ModuleObserver be moved into a separate file.

I'm also not a really big fan of classes in classes (struct) since it disrupts the reading of the header and makes the project quite hard to navigate. (at least with the qtcreator). Unless there is a really good reason do have that a class sits within a class it should be avoided. ( @abroxos https://github.com/abroxos opinion?)

— Reply to this email directly or view it on GitHubhttps://github.com/iut-ibk/DynaMind-ToolBox/issues/196 .

MSc Michael Mair IUT Umwelttechnik - Institut für Infrastruktur Universität Innsbruck A-6020 Innsbruck; Technikerstrasse 13

Tel: +43 (0) 512 507 6929 M: michael.mair@uibk.ac.at W: http://umwelttechnik.uibk.ac.at W: http://michaelmair.eu

[zacharias2k]

:+1:

[zacharias2k]

Coding style: https://github.com/iut-ibk/DynaMind-ToolBox/issues/197

[zacharias2k]

finished with https://github.com/iut-ibk/DynaMind/commit/f607e1902b6ff6fb5de31ed9a2e4c37a1752c985