---
orphan: true
---

# {py:mod}`ros_sugar.core._action_registry`

```{py:module} ros_sugar.core._action_registry
```

```{autodoc2-docstring} ros_sugar.core._action_registry
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`RegisteredAction <ros_sugar.core._action_registry.RegisteredAction>`
  - ```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction
    :summary:
    ```
* - {py:obj}`RegisteredEvent <ros_sugar.core._action_registry.RegisteredEvent>`
  - ```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent
    :summary:
    ```
* - {py:obj}`SystemActionRegistry <ros_sugar.core._action_registry.SystemActionRegistry>`
  - ```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry
    :summary:
    ```
````

### API

`````{py:class} RegisteredAction
:canonical: ros_sugar.core._action_registry.RegisteredAction

Bases: {py:obj}`ros_sugar.config.base_attrs.BaseAttrs`

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction
```

````{py:method} asdict(filter: typing.Optional[typing.Callable] = None) -> typing.Dict
:canonical: ros_sugar.core._action_registry.RegisteredAction.asdict

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.asdict
```

````

````{py:method} to_dict() -> typing.Dict
:canonical: ros_sugar.core._action_registry.RegisteredAction.to_dict

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.to_dict
```

````

````{py:method} asdict_explicit() -> typing.Dict
:canonical: ros_sugar.core._action_registry.RegisteredAction.asdict_explicit

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.asdict_explicit
```

````

````{py:method} from_dict(dict_obj: typing.Dict) -> None
:canonical: ros_sugar.core._action_registry.RegisteredAction.from_dict

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.from_dict
```

````

````{py:method} from_file(file_path: str, nested_root_name: typing.Union[str, None] = None, get_common: bool = False) -> bool
:canonical: ros_sugar.core._action_registry.RegisteredAction.from_file

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.from_file
```

````

````{py:method} to_json() -> typing.Union[str, bytes, bytearray]
:canonical: ros_sugar.core._action_registry.RegisteredAction.to_json

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.to_json
```

````

````{py:method} from_json(json_obj: typing.Union[str, bytes, bytearray]) -> None
:canonical: ros_sugar.core._action_registry.RegisteredAction.from_json

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.from_json
```

````

````{py:method} has_attribute(attr_name: str) -> bool
:canonical: ros_sugar.core._action_registry.RegisteredAction.has_attribute

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.has_attribute
```

````

````{py:method} get_attribute_type(attr_name: str) -> typing.Optional[type]
:canonical: ros_sugar.core._action_registry.RegisteredAction.get_attribute_type

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.get_attribute_type
```

````

````{py:method} update_value(attr_name: str, attr_value: typing.Any) -> bool
:canonical: ros_sugar.core._action_registry.RegisteredAction.update_value

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.update_value
```

````

````{py:method} get_fields_info(class_object) -> typing.Dict[str, typing.Dict[str, typing.Any]]
:canonical: ros_sugar.core._action_registry.RegisteredAction.get_fields_info
:classmethod:

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredAction.get_fields_info
```

````

`````

`````{py:class} RegisteredEvent
:canonical: ros_sugar.core._action_registry.RegisteredEvent

Bases: {py:obj}`ros_sugar.config.base_attrs.BaseAttrs`

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent
```

````{py:method} asdict(filter: typing.Optional[typing.Callable] = None) -> typing.Dict
:canonical: ros_sugar.core._action_registry.RegisteredEvent.asdict

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.asdict
```

````

````{py:method} to_dict() -> typing.Dict
:canonical: ros_sugar.core._action_registry.RegisteredEvent.to_dict

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.to_dict
```

````

````{py:method} asdict_explicit() -> typing.Dict
:canonical: ros_sugar.core._action_registry.RegisteredEvent.asdict_explicit

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.asdict_explicit
```

````

````{py:method} from_dict(dict_obj: typing.Dict) -> None
:canonical: ros_sugar.core._action_registry.RegisteredEvent.from_dict

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.from_dict
```

````

````{py:method} from_file(file_path: str, nested_root_name: typing.Union[str, None] = None, get_common: bool = False) -> bool
:canonical: ros_sugar.core._action_registry.RegisteredEvent.from_file

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.from_file
```

````

````{py:method} to_json() -> typing.Union[str, bytes, bytearray]
:canonical: ros_sugar.core._action_registry.RegisteredEvent.to_json

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.to_json
```

````

````{py:method} from_json(json_obj: typing.Union[str, bytes, bytearray]) -> None
:canonical: ros_sugar.core._action_registry.RegisteredEvent.from_json

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.from_json
```

````

````{py:method} has_attribute(attr_name: str) -> bool
:canonical: ros_sugar.core._action_registry.RegisteredEvent.has_attribute

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.has_attribute
```

````

````{py:method} get_attribute_type(attr_name: str) -> typing.Optional[type]
:canonical: ros_sugar.core._action_registry.RegisteredEvent.get_attribute_type

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.get_attribute_type
```

````

````{py:method} update_value(attr_name: str, attr_value: typing.Any) -> bool
:canonical: ros_sugar.core._action_registry.RegisteredEvent.update_value

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.update_value
```

````

````{py:method} get_fields_info(class_object) -> typing.Dict[str, typing.Dict[str, typing.Any]]
:canonical: ros_sugar.core._action_registry.RegisteredEvent.get_fields_info
:classmethod:

```{autodoc2-docstring} ros_sugar.core._action_registry.RegisteredEvent.get_fields_info
```

````

`````

`````{py:class} SystemActionRegistry(actions: typing.Optional[typing.Iterable[ros_sugar.core._action_registry.RegisteredAction]] = None)
:canonical: ros_sugar.core._action_registry.SystemActionRegistry

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry
```

````{py:method} parse_ref(ref: str) -> typing.Tuple[str, str]
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.parse_ref
:staticmethod:

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.parse_ref
```

````

````{py:method} normalize(ref: str) -> str
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.normalize
:classmethod:

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.normalize
```

````

````{py:method} short_name(server_name: str, owner: str) -> str
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.short_name
:staticmethod:

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.short_name
```

````

````{py:method} add(action: ros_sugar.core._action_registry.RegisteredAction, interface: typing.Any = None) -> None
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.add

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.add
```

````

````{py:method} interface_for(ref: str) -> typing.Any
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.interface_for

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.interface_for
```

````

````{py:method} add_event_factory(event: ros_sugar.core._action_registry.RegisteredEvent, factory: typing.Callable) -> None
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.add_event_factory

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.add_event_factory
```

````

````{py:method} event_factory_for(ref: str) -> typing.Optional[typing.Callable]
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.event_factory_for

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.event_factory_for
```

````

````{py:method} events(owner: typing.Optional[str] = None) -> typing.List[ros_sugar.core._action_registry.RegisteredEvent]
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.events

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.events
```

````

````{py:property} events_dictionary
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.events_dictionary
:type: typing.List[typing.Dict]

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.events_dictionary
```

````

````{py:method} get_event(ref: str) -> ros_sugar.core._action_registry.RegisteredEvent
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.get_event

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.get_event
```

````

````{py:method} remove_event(ref: str) -> ros_sugar.core._action_registry.RegisteredEvent
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.remove_event

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.remove_event
```

````

````{py:method} get(ref: str) -> ros_sugar.core._action_registry.RegisteredAction
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.get

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.get
```

````

````{py:method} remove(ref: str) -> ros_sugar.core._action_registry.RegisteredAction
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.remove

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.remove
```

````

````{py:method} owners() -> typing.List[str]
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.owners

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.owners
```

````

````{py:method} refs(owner: typing.Optional[str] = None) -> typing.List[str]
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.refs

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.refs
```

````

````{py:method} list(owner: typing.Optional[str] = None, kind: typing.Optional[str] = None) -> typing.List[ros_sugar.core._action_registry.RegisteredAction]
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.list

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.list
```

````

````{py:property} dictionary
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.dictionary
:type: typing.List[typing.Dict]

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.dictionary
```

````

````{py:method} from_components(components: typing.Iterable, monitor_methods: typing.Optional[typing.Iterable[str]] = None, monitor_class: typing.Optional[type] = None, out_of_process: typing.Optional[typing.Iterable[str]] = None, plugins: typing.Optional[typing.Iterable] = None) -> ros_sugar.core._action_registry.SystemActionRegistry
:canonical: ros_sugar.core._action_registry.SystemActionRegistry.from_components
:classmethod:

```{autodoc2-docstring} ros_sugar.core._action_registry.SystemActionRegistry.from_components
```

````

`````