20,290
edits
LibMISB/LibMISB Introduction/ Functionalities supported: Difference between revisions
LibMISB/LibMISB Introduction/ Functionalities supported (view source)
Revision as of 18:24, 5 January 2024
, 5 Januaryno edit summary
mNo edit summary |
mNo edit summary |
||
| Line 38: | Line 38: | ||
In other words, the user chooses which file format to use for both encoding and decoding actions. | In other words, the user chooses which file format to use for both encoding and decoding actions. | ||
'''Important''': before using encode or decode methods you need to set a formatter. | {{Ambox | ||
|type=notice | |||
|small=left | |||
|issue='''Important''': before using encode or decode methods you need to set a formatter. | |||
|style=width:unset; | |||
}} | |||
* Composition input format: To encode the input file, it must follow the following structure (a use case will be shown using the JSON format). | * Composition input format: To encode the input file, it must follow the following structure (a use case will be shown using the JSON format). | ||
| Line 75: | Line 80: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Note''': | {{Ambox | ||
|type=notice | |||
|small=left | |||
|issue='''Note''': Some tags are mandatory depending on the standard. In this case, tag 2 is mandatory. | |||
|style=width:unset; | |||
}} | |||
The method header is: | The method header is: | ||
| Line 89: | Line 98: | ||
void SetFormatter(std::shared_ptr<libmisb::formatter::iFormatter> formatter); | void SetFormatter(std::shared_ptr<libmisb::formatter::iFormatter> formatter); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Use case''': | '''Use case''': | ||
| Line 121: | Line 128: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Note''': The formatter must be set, otherwise the encode method will send an error. | {{Ambox | ||
|type=notice | |||
|small=left | |||
|issue='''Note''': The formatter must be set, otherwise the encode method will send an error. | |||
|style=width:unset; | |||
}} | |||
'''Use case''': | '''Use case''': | ||
| Line 148: | Line 160: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Note''': The formatter must be set, otherwise the decode method will send an error. | {{Ambox | ||
|type=notice | |||
|small=left | |||
|issue='''Note''': The formatter must be set, otherwise the decode method will send an error. | |||
|style=width:unset; | |||
}} | |||
'''Use case''': | '''Use case''': | ||