Algorithms¶

Algorithm¶

class yamcs.pymdb.Algorithm¶

Bases: object

__init__(system: System, name: str, *, aliases: Mapping[str, str] | None = None, short_description: str | None = None, long_description: str | None = None, extra: Mapping[str, str] | None = None, language: str, text: str, inputs: Sequence[InputParameter] | None = None, outputs: Sequence[OutputParameter] | None = None, triggers: Sequence[Trigger] | None = None)¶

aliases: dict[str, str]¶: Alternative names, keyed by namespace

extra: dict[str, str]¶: Arbitrary information, keyed by name

inputs: list[InputParameter]¶: Parameter inputs available to the algorithm

language: str¶: Algorithm language

long_description: str | None¶: Multiline description

name: str¶: Short name of this algorithm

outputs: list[OutputParameter]¶: Parameter outputs available to the algorithm

property qualified_name: str¶: Absolute path of this item covering the full system tree. For example, an item C in a subystem B of a top-level system A is represented as /A/B/C

short_description: str | None¶: Oneline description

system: System¶: System this algorithm belongs to

text: str¶: Algorithm text

triggers: list[Trigger]¶: Algorithm triggers

InputParameter¶

class yamcs.pymdb.InputParameter¶

Bases: object

__init__(parameter: Parameter | str, *, name: str | None = None, required: bool = False, instance: int = 0)¶

name: str | None¶: Variable name to be used inside the algorithm. If not specified, a name is derived from the basename of the parameter.

parameter¶: Reference parameter

OutputParameter¶

class yamcs.pymdb.OutputParameter¶

Bases: object

__init__(parameter: Parameter | str, *, name: str | None = None)¶

name: str | None¶: Variable name to be used inside the algorithm. If not specified, a name is derived from the basename of the parameter.

parameter¶: Reference parameter

Trigger¶

class yamcs.pymdb.Trigger¶: Bases: object

ParameterTrigger¶

class yamcs.pymdb.ParameterTrigger¶

Bases: Trigger

__init__(parameter: Parameter | str) → None¶

parameter¶: Reference parameter

ContainerTrigger¶

class yamcs.pymdb.ContainerTrigger¶

Bases: Trigger

__init__(container: Container | str) → None¶

container¶: Reference container

UnnamedAlgorithm¶

class yamcs.pymdb.UnnamedAlgorithm¶

Bases: object

__init__(language: str, text: str, *, inputs: Optional[Sequence[InputParameter]] = None, extra: Optional[Union[Mapping[str, str], AncillaryData]] = None)¶

extra: AncillaryData¶: Arbitrary information, keyed by name

inputs: list[InputParameter]¶: Parameter inputs available to the algorithm

UnnamedJavaAlgorithm¶

class yamcs.pymdb.UnnamedJavaAlgorithm¶

Bases: UnnamedAlgorithm

__init__(java: str, *, inputs: Optional[Sequence[InputParameter]] = None, extra: Optional[Union[Mapping[str, str], AncillaryData]] = None)¶

extra: AncillaryData¶: Arbitrary information, keyed by name

inputs: list[InputParameter]¶: Parameter inputs available to the algorithm

language: str¶

text: str¶

UnnamedJavaScriptAlgorithm¶

class yamcs.pymdb.UnnamedJavaScriptAlgorithm¶

Bases: UnnamedAlgorithm

__init__(js: str, *, inputs: Optional[Sequence[InputParameter]] = None, extra: Optional[Union[Mapping[str, str], AncillaryData]] = None)¶

extra: AncillaryData¶: Arbitrary information, keyed by name

inputs: list[InputParameter]¶: Parameter inputs available to the algorithm

language: str¶

text: str¶