Skip to content

Commit 84217bd

Browse files
authored
Update Parametrization.h
1 parent 1999fe2 commit 84217bd

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

src/multio/message/Parametrization.h

+10
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ namespace multio::message {
99

1010
static std::string PARAMETRIZATION_PAYLOAD_KEY = "payloadKey";
1111

12+
/** Global singleton metadata object that contains information that may be send once at the beginning of a run
13+
*
14+
* Important: Key-value pairs are ment to be constant. It is possible to update a key with the same value multiple times.
15+
* However, to enforce consistency a key can not be updated with a different value - this will throw an exception to
16+
* notify about inconsistency.
17+
*
18+
* This singleton object is shared accross multiple multio instances (e.g. IFS and NEMO). Hence it is assumed that
19+
* all global key-value pairs of different models are exclusive to each other or contain the same value.
20+
*
21+
*/
1222
class Parametrization {
1323
public:
1424
Parametrization() = default;

0 commit comments

Comments
 (0)