Component Manager

This module implements a functionality for component managers in MCCS.

class MccsBaseComponentManager(*args, **kwargs)

The base component manager for MCCS.

set_communication_state_callback(communication_state_callback)

Set the callback to be called when communication status changes.

Parameters:

communication_state_callback (Optional[Callable[[CommunicationStatus], None]]) – the callback to be called when status of communication with the component changes. If None, no callback will be called.

Return type:

None

set_component_state_callback(component_state_callback)

Set the callback to be called when component state changes.

Parameters:

component_state_callback (Optional[Callable[..., None]]) – the callback to be called when component state changed. If None, no callback will be called.

Return type:

None

class MccsComponentManagerProtocol(*args, **kwargs)

Specification of the interface of an MCCS component manager (for type-checking).

Classes that provide this interface are considered to be an MCCS component manager even if they don’t inherit from MccsBaseComponentManager. (e.g. the SwitchingComponentManager implements a passthrough mechanism that makes it an MCCS component manager even though it doesn’t inherit from MccsBaseComponentManager).

__init__(*args, **kwargs)

property communication_state: CommunicationStatus

Return the status of communication with the component.

off()

Turn off the component.

Return type:

ResultCode

on()

Turn on the component.

Return type:

ResultCode

reset()

Reset the component.

Return type:

ResultCode

standby()

Put the component into standby mode.

Return type:

ResultCode

start_communicating()

Establish communication with the component.

Return type:

None

stop_communicating()

Break off communicating with the component.

Return type:

None