ska_ser_skallop.mvp_control.describing package

Submodules

ska_ser_skallop.mvp_control.describing.base module

ska_ser_skallop.mvp_control.describing.inspections module

class ska_ser_skallop.mvp_control.describing.inspections.DevList(*items: Union[str, List[str]])[source]

Bases: list

filter_out(domain: ska_ser_skallop.mvp_control.describing.mvp_names.DomainList, *tags: str)[source]
select(domain: ska_ser_skallop.mvp_control.describing.mvp_names.DomainList, *tags: str)[source]
class ska_ser_skallop.mvp_control.describing.inspections.DevicesInState(count, items)[source]

Bases: tuple

property count

Alias for field number 0

property items

Alias for field number 1

class ska_ser_skallop.mvp_control.describing.inspections.Inspection(name: str, val: str)[source]

Bases: object

generate_faulty_message(*state: str) → List[source]
in_state(*state: str) → Dict[source]
is_in_state(*state: str) → bool[source]
not_in_state(*state: str) → Dict[source]
class ska_ser_skallop.mvp_control.describing.inspections.ListInspection(the_list: Dict[str, str])[source]

Bases: object

are_all_the_same() → bool[source]
are_in_state(*state: str) → List[bool][source]
are_not_in_state(*state: str) → Dict[str, str][source]
property devices
generate_faulty_message(*state: str) → List[source]
get_grouping() → Dict[str, ska_ser_skallop.mvp_control.describing.inspections.DevicesInState][source]
in_state(*state: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
not_in_state(*state: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
property value
class ska_ser_skallop.mvp_control.describing.inspections.ListInspections[source]

Bases: dict

A composite structure of multiple ListInspection objects (or recursively ListInspections) that is ‘ducked typed’ into a listInspection class. I.e. it allows to be handled in the same way as the more simpler ListInspection (are_in_state,in_state etc ) except the multiplicity is implicitly taken into account

Parameters

dict ([type]) – [description]

are_all_the_same() → bool[source]
are_in_state(*state: str) → List[source]
are_not_in_state(*state: str) → Dict[str, str][source]
property devices
generate_faulty_message(*state: str) → List[source]
get_grouping() → Dict[source]
in_state(*state: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
property list
not_in_state(*state: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
property value

ska_ser_skallop.mvp_control.describing.mvp_conditions module

Module that defines a class for mannaging different orthogonal conditions about a running MVP in order to aggregate the states of various devices into a combined condition of FAULTY, OK or DEGRADED

class ska_ser_skallop.mvp_control.describing.mvp_conditions.Condition(getter: ska_ser_skallop.mvp_control.describing.mvp_conditions.Getter, *desired_value: str)[source]

Bases: object

are_in_state(*state: str) → List[bool][source]
are_not_in_state(*state: str) → Dict[str, str][source]
data: Union[ska_ser_skallop.mvp_control.describing.inspections.ListInspection, ska_ser_skallop.mvp_control.describing.inspections.ListInspections]
describe_unhealthy_state() → Optional[str][source]
property devices
get_state: Callable[], None]
property grouping
in_state(*state: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
is_inconsistent() → bool[source]
is_not_ok() → bool[source]
is_ok() → bool[source]
is_wrong() → bool[source]
items() → ItemsView[str, ska_ser_skallop.mvp_control.describing.inspections.ListInspection][source]
keys() → KeysView[str][source]
not_in_state(*state: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
state: ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionState
update_condition(*desired_value: str) → bool[source]
property value
values() → ValuesView[ska_ser_skallop.mvp_control.describing.inspections.ListInspection][source]
class ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionDescription(label, desc, unhealthy_states, desired, state)[source]

Bases: tuple

property desc

Alias for field number 1

property desired

Alias for field number 3

property label

Alias for field number 0

property state

Alias for field number 4

property unhealthy_states

Alias for field number 2

class ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionLabel(desc, label, dim)[source]

Bases: tuple

property desc

Alias for field number 0

property dim

Alias for field number 2

property label

Alias for field number 1

class ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionLabels[source]

Bases: object

classmethod as_labels() → Set[source]
class ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionState(value)[source]

Bases: enum.Enum

Used to specify the current state of a condition. OK means all the reported states are what they are supposed to be. INCONSISTENT means some of them are in the wrong state and WRONG means all of the states are in the wrong (but consistent) state. Lastly, UNKNOWN means the state can not be determined as it is unable to communicate with the MVP or has not yet done so.

Parameters

Enum ([type]) – [description]

INCONSISTENT = 2
OK = 1
UNKNOWN = 4
WRONG = 3
class ska_ser_skallop.mvp_control.describing.mvp_conditions.Conditional(desc, cond, dim)[source]

Bases: tuple

property cond

Alias for field number 1

property desc

Alias for field number 0

property dim

Alias for field number 2

class ska_ser_skallop.mvp_control.describing.mvp_conditions.FilteredConditions(conditions: Dict[str, ska_ser_skallop.mvp_control.describing.mvp_conditions.Conditional])[source]

Bases: object

get(condition_label: ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionLabel) → Optional[ska_ser_skallop.mvp_control.describing.mvp_conditions.Condition][source]
includes(condition_label: ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionLabel) → bool[source]
class ska_ser_skallop.mvp_control.describing.mvp_conditions.Getter(fn: Callable[[…], Union[ska_ser_skallop.mvp_control.describing.inspections.ListInspection, ska_ser_skallop.mvp_control.describing.inspections.ListInspections]], *args: Any)[source]

Bases: object

get() → Union[ska_ser_skallop.mvp_control.describing.inspections.ListInspection, ska_ser_skallop.mvp_control.describing.inspections.ListInspections][source]
exception ska_ser_skallop.mvp_control.describing.mvp_conditions.NotReady(message: str, result: ska_ser_skallop.mvp_control.describing.mvp_conditions.Readiness)[source]

Bases: Exception

class ska_ser_skallop.mvp_control.describing.mvp_conditions.Readiness(*labels: Union[Set[str], ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionLabels])[source]

Bases: object

property aggregate_condition
property aggregate_results
conditions: Dict[str, ska_ser_skallop.mvp_control.describing.mvp_conditions.Conditional]
describe_why_not_ready() → str[source]
expect(description: str, label='general', dim: str = 'state')[source]
filter_by(state: str) → ska_ser_skallop.mvp_control.describing.inspections.ListInspection[source]
get(condition_label: ska_ser_skallop.mvp_control.describing.mvp_conditions.ConditionLabel) → Optional[ska_ser_skallop.mvp_control.describing.mvp_conditions.Condition][source]
get_inconsistent_conditions() → ska_ser_skallop.mvp_control.describing.mvp_conditions.FilteredConditions[source]
get_not_ok_conditions() → ska_ser_skallop.mvp_control.describing.mvp_conditions.FilteredConditions[source]
get_wrong_conditions() → ska_ser_skallop.mvp_control.describing.mvp_conditions.FilteredConditions[source]
load_condition(desc: str, condition: ska_ser_skallop.mvp_control.describing.mvp_conditions.Condition, label='general', dim: str = 'state') → None[source]
select(state: str, *value: str) → ska_ser_skallop.mvp_control.describing.inspections.DevList[source]
set_labels(labels: Set[str]) → None[source]
state(get_function: Callable[[…], Union[ska_ser_skallop.mvp_control.describing.inspections.ListInspection, ska_ser_skallop.mvp_control.describing.inspections.ListInspections]], *get_args: Any)[source]
to_be(*desired_values: str)[source]
update()[source]
ska_ser_skallop.mvp_control.describing.mvp_conditions.aggregate_string(line1: str, line2: str) → str[source]
ska_ser_skallop.mvp_control.describing.mvp_conditions.aggregate_string_with_and(line1: str, line2: str) → str[source]

ska_ser_skallop.mvp_control.describing.mvp_names module

class ska_ser_skallop.mvp_control.describing.mvp_names.CBF(tag)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

fsp(index: int) → ska_ser_skallop.mvp_control.describing.mvp_names.FSP[source]
subarray(index: int) → str[source]
vcc(index: int) → ska_ser_skallop.mvp_control.describing.mvp_names.VCC[source]
class ska_ser_skallop.mvp_control.describing.mvp_names.CSP(tag)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

subarray(index: int) → str[source]
class ska_ser_skallop.mvp_control.describing.mvp_names.Correlator(tag: str, index: int)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.FSPSubelement

type = 'corr'
class ska_ser_skallop.mvp_control.describing.mvp_names.DeviceName(name: str, *tags: str)[source]

Bases: object

name: str
tags: Tuple
class ska_ser_skallop.mvp_control.describing.mvp_names.DomainList(token: Optional[Union[int, List[ska_ser_skallop.mvp_control.describing.mvp_names.DeviceName]]])[source]

Bases: object

filter(*tags: str)[source]
filterables() → collections.Counter[source]
get_inner_list() → List[ska_ser_skallop.mvp_control.describing.mvp_names.DeviceName][source]
property list
subtract(tag: str)[source]
class ska_ser_skallop.mvp_control.describing.mvp_names.FSP(tag: str, index: int)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

pulsar_timing(index: int) → str[source]
vlbi(index: int) → str[source]
class ska_ser_skallop.mvp_control.describing.mvp_names.FSPSubelement(tag: str, index: int)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

subarray(nr: int) → str[source]
type = ''
class ska_ser_skallop.mvp_control.describing.mvp_names.Masters[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.DomainList

class ska_ser_skallop.mvp_control.describing.mvp_names.Mid[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

csp = <ska_ser_skallop.mvp_control.describing.mvp_names.CSP object>
static dish(index: int) → str[source]
static dishes(ids: List[int]) → List[str][source]
sdp = <ska_ser_skallop.mvp_control.describing.mvp_names.SDP object>
tag = 'mid'
tm = <ska_ser_skallop.mvp_control.describing.mvp_names.TM object>
class ska_ser_skallop.mvp_control.describing.mvp_names.NameBase[source]

Bases: object

class ska_ser_skallop.mvp_control.describing.mvp_names.PSS(tag: str, index: int)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.FSPSubelement

type = 'pss'
class ska_ser_skallop.mvp_control.describing.mvp_names.SDP(tag)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

subarray(index: int) → str[source]
class ska_ser_skallop.mvp_control.describing.mvp_names.Sensors(token: Optional[Union[int, List[ska_ser_skallop.mvp_control.describing.mvp_names.DeviceName]]])[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.DomainList

nr_bands = 4
nr_switches = 2
class ska_ser_skallop.mvp_control.describing.mvp_names.SubArrays(token: Optional[Union[int, List[ska_ser_skallop.mvp_control.describing.mvp_names.DeviceName]]])[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.DomainList

nr_of_fsps = 4
class ska_ser_skallop.mvp_control.describing.mvp_names.TM(tag)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

dish_leafnode(index: int)[source]
subarray(index: int) → ska_ser_skallop.mvp_control.describing.mvp_names.TMSubarray[source]
class ska_ser_skallop.mvp_control.describing.mvp_names.TMSubarray(index: int, tag: str)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

class ska_ser_skallop.mvp_control.describing.mvp_names.VCC(tag: str, index: int)[source]

Bases: ska_ser_skallop.mvp_control.describing.mvp_names.NameBase

band(index: int) → str[source]
band_mappings = {1: '12', 2: '3', 3: '4', 4: '5'}
sw(index: int) → str[source]

ska_ser_skallop.mvp_control.describing.mvp_states module

Module contents