<commit_before># Project Ciayn
Controller implementation as you need (Ciayn)

## how to use the module
A few examples are listed in the folder "./src/examples". This examples should help
to use the module.

The class SignalFloat is for log all values into a list at a connection. 
It also use the Unit singleton to add a defined Unit to a Signal.
The class ReadingFloat is the same as ValueFloat but includes the Unit of the value.
How to use the Signal class is shown in the example "useSignal.java".

 

## goals of the project
1. learn java programming
2. use the object oriented programming concept
3. the final project, resulting code has to implement a controller with following features:
    * the control algorithm has to be exchangeable
    * a P, PD, PI, PID controller must be possible to use
    * the controller has to read actual values from the plant and write the output to the plant
    * the controller has to run independent form the environmental

## documentation
A HTML documentation of the Project is deposited in "./documentation/html-docs/".
The online Link is: https://rawgit.com/lki1354/Ciayn/master/documentation/html-docs/index.html

## UML diagrams
In the folder "./documentation/UML diagrams" the UML diagrams form the current design is documented.
    
## report of the project
### design decisions and learn process
#### first part
The first work what I did before starting programming was to think about the controller <commit_msg>add description how to run example<commit_after># Project Ciayn
Controller implementation as you need (Ciayn)

## how to use the module
A few examples are listed in the folder "./src/examples". This examples should help
to use the module.

The class SignalFloat is for log all values into a list at a connection. 
It also use the Unit singleton to add a defined Unit to a Signal.
The class ReadingFloat is the same as ValueFloat but includes the Unit of the value.
How to use the Signal class is shown in the example "useSignal.java".

## run an example
* download CiaynExamplePlot.jar form release v0.5.1 and run 
* java -jar CiaynExamplePlot.jar
* at this example a PI controller and a PT1 plant is used
 * PT1 element: https://de.wikipedia.org/wiki/PT1-Glied#Sprungantwort
 

## goals of the project
1. learn java programming
2. use the object oriented programming concept
3. the final project, resulting code has to implement a controller with following features:
    * the control algorithm has to be exchangeable
    * a P, PD, PI, PID controller must be possible to use
    * the controller has to read actual values from the plant and write the output to the plant
    * the controller has to run independent form the environmental

## documentation
A HTML documentation of the Project is deposited in "./documentation/html-docs/".
The online Link is: https://rawgit.com/lki1354/Ciayn/master/documentation/html-docs/index.html

## UML diagrams
In the folder "./documentation/UML diagrams" the UML diagrams form the current design is documented.
    
## report of the project
### design decisions and learn process
#### first part
The first work what I did before starting programming was to think about the controller 
{'fraction_non_alphanumeric': 0.054214979630209964, 'fraction_numerical': 0.006267627702914447, 'mean_word_length': 4.010989010989011, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2291504', 'n_tokens_mistral': 823, 'n_tokens_neox': 780, 'n_words': 467}