Array

This class is the representation of an array of an object dictionary. It is a mutable auto-associative mapping and may contain zero or more of Variable.

Auto-associative mapping

The Array class is a mutable auto-associative mapping of Variables and the properties for association are subindex and name. It's possible to get a Variable by subindex or name from the mapping.

To add a element to the mapping, the add function is used. The subindex and the name of the elements inside the list must be unique. Additionally, the index of the variable must match the index of the array.

the_array = canopen.objectdictionary.Array("arr", 0x1000, canopen.objectdictionary.INTEGER32)

one_variable = canopen.objectdictionary.Variable("var1", 0x1000, 0x01, canopen.objectdictionary.INTEGER32)
other_variable = canopen.objectdictionary.Variable("var2", 0x1000, 0x01, canopen.objectdictionary.INTEGER32)

the_array.add(one_variable)
# This fails, because there is already a variable with subindex 1.
the_array.add(other_variable)

After adding the element to the mapping, it can be accessed via subscription. If the subindex and the name belong to the same element, the two lines will retrieve the same element:

# Use the subindex
variable_1 = the_array[0x01]
# Use the name
variable_1 = the_array["var1"]

It implements the iterator interface too. The iterator yields all elements (variables, ...) added to the Array.

the_array = canopen.objectdictionary.Array("arr", 0x1000, canopen.objectdictionary.INTEGER32)

# ... add some elements ...

for v in the_array:
        print(v.name)