Skip to content

Commit

Permalink
* Extend the module overview, #78
Browse files Browse the repository at this point in the history
  • Loading branch information
MBaranskiEBC committed Jun 1, 2020
1 parent 5956a62 commit f1d3830
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion Tutorial/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,23 @@ The reference implementation allows applying two specific DMPC algorithms to the
The System module is used to generate a set of subsystems (agents) that perform the actual control task. It is also useful to define the overall algorithm. In the reference implementation, this algorithm is called BExMoC and simply inherits from the System class.

## Subsystem
The Subsystem module contains the definition of the subsystems (agents). In the BaseSubsystem class, only the main model types are defined.
The Subsystem module contains the definition of the subsystems (agents). In the BaseSubsystem class, only the main attributed are defined.

## Modeling
The Modeling module contains various model classes. It also contains a States class, which is important for distinguishing the different types of state variables.

## Init
The Init module contains all initial data. The entire module can be replaced for a new case study and it is up to the user to define what to provide and how to provide it. In the reference implementation, all values are written directly into the module but in other case studies, it may as well hold functions reading a separate configuration file.

## Experiment
The Experiment module is intended as an entry point. It contains the main() function and triggers the execution of control algorithms. It can also be used to ensure a basic synchronization with the controlled system.

## ControlledSystem
The ControlledSystem module contains classes for interacting with the controlled system. Currently, classes are provided that allow using
- an FMU
- a Beckhoff PLC
- an http API
as controlled system.

## SystemTime
The SystemTime module is intended to provide global clocks for all other modules. It distinguishes the simulated controlled system (FMU) and the real-life controlled system (PLC, API).

0 comments on commit f1d3830

Please sign in to comment.