Skip to content

Commit a73df52

Browse files
authored
Merge pull request #110 from open-simulation-platform/logging/timeStampedFileNames
Document timeStampedFileNames logging attribute
2 parents 21da3d6 + 618f2bb commit a73df52

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

libcosim/logging.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ including case) and placed in the same folder as the configuration file (`OspSys
1515

1616
| sub-element | attribute | Description |
1717
| :--------------- | :------------| :-------------------------------------------------------------------------------------------------------------------------------------- |
18+
| <*simulators*> | `timeStampedFileNames` | Whether or not the output filenames should contain a trailing time-stamp. `Default="True"`.
1819
| <*simulator*> | `name` | Contains all variables to be logged, attribute `name` declares of the name of the simulator.
1920
| | `decimationFactor` | Optional attribute `decimationFactor` declares the sampling rate of the simulation results. For example, decimationFactor=1 means the results of every simulation step of the simulator are logged. And decimationFactor=10 means every 10th of the simulation results are logged. |
2021
| <*variable*> | `name` | Declares the name of the simulator variable to be logged.
@@ -38,4 +39,4 @@ A `<simulator>` element with no `<variable>` child elements will lead to all var
3839
As aforementioned this could results in a large amount of data to be saved.
3940
It helps to reduce the logged data by the optional attribute `decimationFactor` if not every sample data is required.
4041
Leaving out a simulator from the configuration will disable logging for that simulator.
41-
The result logs are persisted as csv files.
42+
The result logs are persisted as csv files.

0 commit comments

Comments
 (0)