Skip to content

Architecture

Moritz Lauster edited this page Feb 23, 2016 · 5 revisions

Filewise Implementation

Models, Functions and Blocks must be implemented file-wise, i.e. one model, function or block per file.

Partial Classes

Partial classes and base classes that are not of interest to the user should be stored in a subdirectory called BaseClasses. Each other class except for constants must have an icon

Examples

Examples and validation models should be in directories such as Valves.Examples and Valves.Validations. A script for the regression tests must be added as described below.

Fluid Flow Systems

In the case of fluid flow systems, implement components by extending the partial classes in Annex60.Fluid.Interfaces.

Instantiating a Class

Use the full package names when instantiating a class.

Comments

Comments should be added to each class (e.g. package, model, function). The first character should be upper case. For one-line comments of parameters, variables and classes, no period should be used at the end of the comment.

Clone this wiki locally