SolDefines module¶
-
SolDefines.
solStructure
(type_id)¶ Return the SOL structure according to the given type id If the element is not found, it raises a ValueError.
Parameters: type_id (int|str) – Returns: a dictionary that contains the following keys: type, description, structure, fields
-
SolDefines.
sol_name_to_type
(type_name)¶
-
SolDefines.
sol_type_to_type_name
(type_id)¶
This file describes the SOL Objects structure.
How to add an Object structure¶
1. Create an issue with name: “Adding YOUR_OBJECT_NAME structure”. This will create a issue number like #49.
Create a new branch with the name:
develop_<your issue number>
ex: develop_49
Add the object type in the list at the top of the SolDefines.py file.
- Prepend the string “SOL_TYPE” to your object name.
- Increment the last number of the list to get an object id
Refer to the other object if you are not sure.
- Add the object structure at the bottom of the SolDefines.py file.
Refere to the python structure to know which field to set: https://docs.python.org/2/library/struct.html
- Run the the
registry_gen.py
script. That will update theregistry.md
file. - Commit your changes starting with the issue number.
Commit message example: “
#49 adding YOUR_OBJECT_NAME structure
”. - Push your changes to the repo:
git push origin develop_49
- Create a merge request on branch develop using GitHub UI.