Changes for page Simulation (KiSim)

Last modified by Richard Kreissig on 2023/09/14 11:07
<
From version < 6.1 >
edited by aas2
on 2017/10/23 14:07
To version < 9.1 >
edited by aas2
on 2017/10/24 15:52
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -405,8 +405,34 @@
405 405  
406 406  This data handler is only used for easier debugging and setting up simulations for different test runs. It sets the variables in the data pool to constant values, typically once for the simulation in the initialization part of a kisim file.
407 407  
408 -\\
408 +(% class="relative-table wrapped" %)
409 +|=(((
410 +Attribute
411 +)))|=(((
412 +Domain
413 +)))|=(((
414 +Example
415 +)))|=(((
416 +Description
417 +)))
418 +|(((
419 +variables
420 +)))|(((
421 +Map, The key is the variable name, the value is the value for this variable
422 +)))|(((
423 +configure setter S {
424 + variables {
425 + I: true
426 + O: 5
427 + MyModel.MyVar: -1
428 + }
429 +}
430 +)))|(((
431 +Sets the variables in to the given values.
409 409  
433 +This way different setters can be defined for different simulation runs or manual testing.
434 +)))
435 +
410 410  \\
411 411  
412 412  \\
... ... @@ -512,6 +512,167 @@
512 512  }
513 513  {{/code}}
514 514  
541 +Sets the variables for manual testing:
542 +
543 +{{code}}
544 +configure sim A {
545 + executable: kieler-gen/sim/bin/Sim_Test.exe
546 +}
547 +
548 +configure setter S {
549 + variables {
550 + x: 100
551 + y: 100
552 + }
553 +}
554 +
555 +initialization {
556 + write setter S
557 +}
558 +
559 +execution {
560 + write sim A
561 +}
562 +{{/code}}
563 +
515 515  \\
516 516  
566 +== Implementation Details ==
567 +
568 +The following are details about the implementation of the simulation and the JSON format that is used to communicate the variables in the models.
569 +
570 +As said above the simulation is seen as black box which takes inputs on stdin, computes a reaction, and sends outputs stdout. Thus an executable simulation is a normal program that communicates in a specific JSON format and can also be used from command line.
517 517  \\
572 +
573 +=== The JSON Format ===
574 +
575 +The JSON format is designed to communicate the state of a simulation. In KIELER such a state is saved as a single data pool. This means the JSON format for the communication with running simulations is also the JSON format for data pools.
576 +
577 +It mainly consists of a list of models and a map of models. The models consist mainly of a map of their variables. The most important field of a variable is their value.
578 +
579 +{{code}}
580 +{ "MODEL_NAME0" : {
581 + "VAR0":{"value": "VAR0_VALUE"}, "VAR1":{"value":"VAR1_VALUE"}, ...
582 + }
583 + "MODEL_NAME1" : {
584 + "VAR0":{"value": "VAR0_VALUE"}, "VAR1":{"value":"VAR1_VALUE"}, ...
585 + }
586 + ...
587 + "actionIndex" : "ACTION_INDEX_AFTER_WHICH_THE_DATA_POOL_WAS_CREATED"
588 +}
589 +{{/code}}
590 +
591 +Besides these core informations, an additional field "actionIndex" can be set for the data pool. In the simulation the actions of data handlers are executed to create a macro tick. Therefore the action index takes the task of a program counter. It determines the next action to be executed. Thus in the JSON format the field "actionIndex" can be set to store when the data pool was created in the simulation.
592 +
593 +There are also additional fields for variables than their value. However these only need to be communicated once after the initialization of the model and are explained in the table below.
594 +
595 +(% class="wrapped" %)
596 +|=(((
597 +Field Name
598 +)))|=(((
599 +Example Values
600 +)))|=(((
601 +Description
602 +)))
603 +|(((
604 +type
605 +)))|(((
606 +int
607 +
608 +bool
609 +
610 +pure
611 +
612 +float
613 +
614 +double
615 +
616 +string
617 +)))|(((
618 +The type of the variable in the source model.
619 +
620 +Because this information is lost in general in the compilation (for instance a bool is compiled to a char in C code), the simulation can communicate the intended variable type in the source model.
621 +)))
622 +|(((
623 +interface
624 +)))|(((
625 +0
626 +
627 +1
628 +
629 +2
630 +
631 +3
632 +
633 +4
634 +
635 +5
636 +
637 +6
638 +)))|(((
639 +Bitmask, that determines how the variable is used in the source model's interface (e.g. input, output, internal, other).
640 +A bitmask has been choosen because a mixture of a variables interface types is possible (e.g. input, output, input output)
641 +
642 +(% class="wrapped" %)
643 +|=(((
644 +Interface Type
645 +)))|=(((
646 +Binary Bitmask
647 +)))|=(((
648 +Decimal Number
649 +)))
650 +|(((
651 +Other
652 +)))|(((
653 +0000
654 +)))|(((
655 +0
656 +)))
657 +|(% colspan="1" %)(% colspan="1" %)
658 +(((
659 +Internal
660 +)))|(% colspan="1" %)(% colspan="1" %)
661 +(((
662 +0001
663 +)))|(% colspan="1" %)(% colspan="1" %)
664 +(((
665 +1
666 +)))
667 +|(% colspan="1" %)(% colspan="1" %)
668 +(((
669 +Output
670 +)))|(% colspan="1" %)(% colspan="1" %)
671 +(((
672 +0010
673 +)))|(% colspan="1" %)(% colspan="1" %)
674 +(((
675 +2
676 +)))
677 +|(% colspan="1" %)(% colspan="1" %)
678 +(((
679 +Input
680 +)))|(% colspan="1" %)(% colspan="1" %)
681 +(((
682 +0100
683 +)))|(% colspan="1" %)(% colspan="1" %)
684 +(((
685 +4
686 +)))
687 +|(% colspan="1" %)(% colspan="1" %)
688 +(((
689 +Input Output
690 +)))|(% colspan="1" %)(% colspan="1" %)
691 +(((
692 +0110
693 +)))|(% colspan="1" %)(% colspan="1" %)
694 +(((
695 +6
696 +)))
697 +
698 +Note that internal is intended for variables that are neither input nor output but still part of the source model, in contrast to variables that are created in the compilation (e.g. register flags).
699 +Anyway an input and output is also a internal variable normally.
700 +)))
701 +
702 +=== Python Example ===
703 +
704 +\\
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -33260019
1 +33260105
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/33260019/V2 Simulation
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/33260105/V2 Simulation

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage