pcdsdevices.state.get_dynamic_state_attr

pcdsdevices.state.get_dynamic_state_attr(state_index: int, motor_index: int = 0) → str

Get the attr string associated with a single state index.

For example, the 5th state should create an attribute on TwinCATStateConfigDynamic called “state05”. Therefore, get_dynamic_state_attr(5) == “state05”.

For a multi-dimensional states class, the motor index would be nonzero and included in the attribute name. For example, motor 3’s state 2 should be get_dynamic_state_attr(2, 3) == “m03_state02”

Parameters:

• state_index (int) – The index of the state.

• motor_index (int) – The index of the motor. Zero has a special meaning here of “there is only one motor”.

Returns:

state_attr (str) – The corresponding attribute name.