configuration module#

The configuration of a design held by the runtime.

Reached through RuntimeDesign.configuration. Requests change settings of the design that apply on its next load, such as its reference designators.

class AsyncConfiguration(rmap, send)[source]#

Bases: object

The configuration of an async runtime design.

Parameters:

rmap (Callable[[], ReverseMapper])
send (Callable[[cpb2.ConfigurationOperations], Awaitable[cpb2.ConfigurationOperationsResponse]])

async reassign_reference_designators(designators, /)[source]#

Replace the reference designators of the design. This does not update the live model. The new designators show on the design after another submit().

Parameters:

designators (Mapping[Component, str]) – The new designator of every component whose designator is not set in code.

Raises:

ValueError – if the runtime has no ID for a component.
RequestRejected – if the runtime refused the designators.

Return type:

None

class SyncConfiguration(rmap, send)[source]#

Bases: object

The configuration of a sync runtime design.

Parameters:

rmap (Callable[[], ReverseMapper])
send (Callable[[cpb2.ConfigurationOperations], cpb2.ConfigurationOperationsResponse])

reassign_reference_designators(designators, /)[source]#

Replace the reference designators of the design. See AsyncConfiguration.reassign_reference_designators().

Return type:: None
Parameters:: designators (Mapping[Component, str])