labscheduler.sila_server.generated.labconfigurationcontroller package

Submodules

Module contents

class labscheduler.sila_server.generated.labconfigurationcontroller.ConfigureJobShop_Responses[source]

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ()
classmethod _make(iterable)

Make a new ConfigureJobShop_Responses object from a sequence or iterable

_replace(**kwds)

Return a new ConfigureJobShop_Responses object replacing specified fields with new values

exception labscheduler.sila_server.generated.labconfigurationcontroller.FileFormatError(message: str | None = None)[source]

Bases: DefinedExecutionError

_abc_impl = <_abc._abc_data object>
class labscheduler.sila_server.generated.labconfigurationcontroller.LabConfigurationControllerBase(parent_server: Server)[source]

Bases: FeatureImplementationBase, ABC

abstractmethod ConfigureJobShop(JobShop: list[Machine], *, metadata: MetadataDict) → ConfigureJobShop_Responses[source]
Sets the Job-Shop (set of devices in the lab) for the scheduler.

It will be kept until this method is called again.

Parameters:

  • JobShop – A list of machines/devices available in the job-shop/laboratory to schedule operations on.

  • metadata – The SiLA Client Metadata attached to the call

abstractmethod LoadJobShopFromFile(ConfigurationFile: str, *, metadata: MetadataDict) → LoadJobShopFromFile_Responses[source]

Sets the Job-Shop (set of devices in the lab) for the scheduler. It will be kept until this method is called again. You can also use the ConfigureJobShop method which only uses basic types to achieve the same result.

Parameters:

  • ConfigurationFile – A yaml file in a specific format describing what machines of which capabilities should be used to schedule experiments on. This should be the file content and not the file location.

  • metadata – The SiLA Client Metadata attached to the call

_abc_impl = <_abc._abc_data object>
abstractmethod get_CurrentJobShop(*, metadata: MetadataDict) → list[Machine][source]

The currently used job-shop

Parameters:

metadata – The SiLA Client Metadata attached to the call

Returns:

The currently used job-shop

parent_server: Server

SiLA Server serving this feature implementation

class labscheduler.sila_server.generated.labconfigurationcontroller.LabConfigurationControllerClient[source]

Bases: object

This feature is used to configure the lab environment (called JobShop in this context),

the scheduler can use to schedule processes on.

ConfigureJobShop(JobShop: list[Machine], *, metadata: Iterable[ClientMetadataInstance] | None = None) → ConfigureJobShop_Responses[source]
Sets the Job-Shop (set of devices in the lab) for the scheduler.

It will be kept until this method is called again.

CurrentJobShop: ClientUnobservableProperty[list[Machine]]

The currently used job-shop

LoadJobShopFromFile(ConfigurationFile: str, *, metadata: Iterable[ClientMetadataInstance] | None = None) → LoadJobShopFromFile_Responses[source]

Sets the Job-Shop (set of devices in the lab) for the scheduler. It will be kept until this method is called again. You can also use the ConfigureJobShop method which only uses basic types to achieve the same result.

class labscheduler.sila_server.generated.labconfigurationcontroller.LoadJobShopFromFile_Responses[source]

Bases: NamedTuple

_asdict()

Return a new dict which maps field names to their values.

_field_defaults = {}
_fields = ()
classmethod _make(iterable)

Make a new LoadJobShopFromFile_Responses object from a sequence or iterable

_replace(**kwds)

Return a new LoadJobShopFromFile_Responses object replacing specified fields with new values

labscheduler.sila_server.generated.labconfigurationcontroller.Machine

alias of Any