LibMISB/LibMISB Introduction/ Functionalities supported: Difference between revisions
No edit summary |
No edit summary |
||
| Line 22: | Line 22: | ||
Sets the Formatter object to convert between format and metadata object. In other words, the user chooses which file format to use for both encoding and decoding actions. | Sets the Formatter object to convert between format and metadata object. In other words, the user chooses which file format to use for both encoding and decoding actions. | ||
= | * Composition input format: For the input file to be encoded, it must follow the following structure (an example will be shown using the JSON format). | ||
<syntaxhighlight lang=bash> | |||
{ | |||
"key": "<MISB KEY>", | |||
"items": [ | |||
{ | |||
"tag": "<TAG NUMBER >", | |||
"value": "<TAG VALUE >" | |||
} | |||
] | |||
} | |||
</syntaxhighlight> | |||
Note: some tags are mandatories depending on the standard. | |||
==== Encode ==== | ==== Encode ==== | ||
==== Decode ==== | ==== Decode ==== | ||
Revision as of 06:35, 20 June 2022
| LibMISB |
|---|
 |
| Introduction |
| Supported Standards |
| Getting Started |
| Examples |
| Evaluating |
| Contact Us |
 | Enrique: Here you can show the methods supported by the library: misb.SetDebuggerLever(), SetFormatter(), Encode(), Decode() (please remove this box when addressed) |
General
The functionalities of the library, regardless of the standard used, are as follows
SetDebuggerLevel
Sets the level at which messages will be recorded. The modes, ordered from least to most verbose, are as follows:
- MISB_NONE
- MISB_ERROR
- MISB_WARN
- MISB_INFO
- MISB_DEBUG
SetFormatter
Sets the Formatter object to convert between format and metadata object. In other words, the user chooses which file format to use for both encoding and decoding actions.
- Composition input format: For the input file to be encoded, it must follow the following structure (an example will be shown using the JSON format).
{
"key": "<MISB KEY>",
"items": [
{
"tag": "<TAG NUMBER >",
"value": "<TAG VALUE >"
}
]
}
Note: some tags are mandatories depending on the standard.