atef.procedure.PreparedPlanComparison

class atef.procedure.PreparedPlanComparison(cache: ~atef.cache.DataCache, identifier: str = '', comparison: ~atef.check.Comparison = <factory>, name: str | None = None, parent: ~atef.procedure.PreparedPlanStep | None = None, result: ~atef.result.Result = <factory>, plan_data: ~atef.procedure.ComparisonToPlanData | None = None, data: ~typing.Any | None = None)[source]

Unified representation for comparisons to Bluesky Plan data

Attributes:

data
name
parent
plan_data

Methods

`compare`()	Run the comparison and return the Result.
`get_data_async`()	Get the data according to the comparison's configuration.

from_comp_to_plan

Methods

__init__(cache: ~atef.cache.DataCache, identifier: str = '', comparison: ~atef.check.Comparison = <factory>, name: str | None = None, parent: ~atef.procedure.PreparedPlanStep | None = None, result: ~atef.result.Result = <factory>, plan_data: ~atef.procedure.ComparisonToPlanData | None = None, data: ~typing.Any | None = None) → None

async compare() → Result

Run the comparison and return the Result.

Returns:

Result: The result of the comparison.

classmethod from_comp_to_plan(origin: ComparisonToPlanData, cache: DataCache | None = None, parent: PreparedPlanStep | None = None) → PreparedPlanComparison[source]

async get_data_async() → Any[source]

Get the data according to the comparison’s configuration.

To be implemented in subclass.

Returns:

dataAny: The acquired data.

Attributes

data: Any | None = None: The value from the plan, to which the comparison will take place

identifier: str = '': The identifier used for the comparison.

name: str | None = None: The name of the associated configuration.

parent: PreparedPlanStep | None = None: The hierarchical parent of this comparison

plan_data: ComparisonToPlanData | None = None: Original plan data, holds relevant data coordinates

cache: DataCache: The data cache to use for the preparation step.

comparison: Comparison: The comparison itself.

result: Result: The last result of the comparison, if run.