Dictionary¶
-
class
ingenialink.dictionary.
Dictionary
(dictionary_path)[source]¶ Ingenia dictionary Abstract Base Class.
- Parameters
dictionary_path (str) – Dictionary file path.
- Raises
ILCreationError – If the dictionary could not be created.
-
registers
(subnode)[source]¶ Gets the register dictionary to the targeted subnode.
- Parameters
subnode (int) – Identifier for the subnode.
- Returns
Dictionary of all the registers for a subnode.
- Return type
dict
-
categories
¶ Instance of all the categories in the dictionary.
- Type
-
errors
¶ Instance of all the errors in the dictionary.
- Type
-
firmware_version
¶ Firmware version declared in the dictionary.
- Type
str
-
interface
¶ Interface declared in the dictionary.
- Type
str
-
part_number
¶ Part number declared in the dictionary.
- Type
str
-
path
¶ Path of the dictionary.
- Type
str
-
product_code
¶ Product code declared in the dictionary.
- Type
int
-
revision_number
¶ Revision number declared in the dictionary.
- Type
int
-
subnodes
¶ Number of subnodes in the dictionary.
- Type
int
-
version
¶ Version of the dictionary.
- Type
str
-
class
ingenialink.dictionary.
DictionaryCategories
(list_xdf_categories)[source]¶ Contains all categories from a Dictionary.
- Parameters
list_xdf_categories (list) – List of Elements from xdf file
-
labels
(cat_id)[source]¶ Obtain labels for a certain category ID.
Args: cat_id (str): Category ID
- Returns
Labels dictionary.
- Return type
dict
-
property
category_ids
¶ Category IDs.
- Type
list