pcdsdevices.state.state_config_dotted_attribute

pcdsdevices.state.state_config_dotted_attribute(config_attr: str, state_count: int, motor_count: int = 1, first_motor_only: bool = False) → list[str]

Returns the full dotted name of all associated state config components.

Parameters:

  • config_attr (str) – The attribute of TwinCATStateConfigOne to target.

  • state_count (int) – The number of known states used by the device.

  • motor_count (int, optional) – The number of motors associated with the states config.

  • first_motor_only (bool, optional) – If switched to True, only return the dotted names associated with the first motor instead of from all of them. Only valid if motor_count is greater than 1. This is useful in cases where we need to locate specific attributes but only need one set, e.g. state names.

Returns:

dotted_names (list of str) – The full dotted names in state enum order, going through all the states of each motor before moving onto the next.