Subarray Beam Health Rules

A file to store health transition rules for subarray.

class SubarrayBeamHealthRules(*args, **kwargs)

A class to handle transition rules for subarray beam.

property default_thresholds: dict[str, float]

Get the default thresholds for this device.

Returns:

the default thresholds

degraded_rule(subarray_beam_health, beam_locked, station_beam_healths)

Test whether DEGRADED is valid for the subarray.

Parameters:

• subarray_beam_health (HealthState) – the subarray beam’s computed health from its communication and fault states, among others

• beam_locked (bool) – whether the beam is locked

• station_beam_healths (dict[str, Optional[HealthState]]) – health of the station beams.

Return type:

bool

Returns:

If the subarray beam is degraded or not.

failed_rule(subarray_beam_health, beam_locked, station_beam_healths)

Test whether FAILED is valid for the subarray beam.

Parameters:

• subarray_beam_health (HealthState) – the subarray beam’s computed health from its communication and fault states, among others

• beam_locked (bool) – whether the beam is locked

• station_beam_healths (dict[str, Optional[HealthState]]) – health of the station beams.

Return type:

bool

Returns:

If the subarray beam is failed or not.

healthy_rule(subarray_beam_health, beam_locked, station_beam_healths)

Test whether OK is valid for the subarray beam.

Parameters:

• subarray_beam_health (HealthState) – the subarray beam’s computed health from its communication and fault states, among others

• beam_locked (bool) – whether the beam is locked

• station_beam_healths (dict[str, Optional[HealthState]]) – health of the station beams.

Return type:

bool

Returns:

If the subarray beam is healthy or not.

unknown_rule(subarray_beam_health, beam_locked, station_beam_healths)

Test whether UNKNOWN is valid for the subarray beam.

Parameters:

• subarray_beam_health (HealthState) – the subarray beam’s computed health from its communication and fault states, among others

• beam_locked (bool) – whether the beam is locked

• station_beam_healths (dict[str, Optional[HealthState]]) – health of the station beams.

Return type:

bool

Returns:

If the subarray beam is in unknown state.