Verifiers¶

Verifier¶

class yamcs.pymdb.Verifier¶

Bases: object

Verifier(check: ‘Check’, timeout: ‘float’, delay: ‘float’ = 0, name: ‘str | None’ = None, on_success: ‘TerminationAction | None’ = None, on_fail: ‘TerminationAction | None’ = None, on_timeout: ‘TerminationAction | None’ = None, extra: ‘dict[str, str]’ = <factory>)

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = None¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

TransferredToRangeVerifier¶

class yamcs.pymdb.TransferredToRangeVerifier¶

Bases: Verifier

A verifier that checks whether the command has been received to the network that connects the ground system to the spacecraft.

The result of this verifier must originate from something other than the spacecraft.

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: yamcs.pymdb.verifiers.TerminationAction | None = TerminationAction.FAIL, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

SentFromRangeVerifier¶

class yamcs.pymdb.SentFromRangeVerifier¶

Bases: Verifier

A verifier that checks whether the command been transmitted to the spacecraft by the network that connects the ground system to the spacecraft.

The result of this verifier must originate from something other than the system.

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: yamcs.pymdb.verifiers.TerminationAction | None = TerminationAction.FAIL, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

ReceivedVerifier¶

class yamcs.pymdb.ReceivedVerifier¶

Bases: Verifier

A verifier that checks that the system has received the command

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: yamcs.pymdb.verifiers.TerminationAction | None = TerminationAction.FAIL, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

AcceptedVerifier¶

class yamcs.pymdb.AcceptedVerifier¶

Bases: Verifier

A verifier that checks that the system has accepted the command

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: yamcs.pymdb.verifiers.TerminationAction | None = TerminationAction.FAIL, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

QueuedVerifier¶

class yamcs.pymdb.QueuedVerifier¶

Bases: Verifier

A verifier that checks that the command is scheduled for execution by the system

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: yamcs.pymdb.verifiers.TerminationAction | None = TerminationAction.FAIL, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

ExecutionVerifier¶

class yamcs.pymdb.ExecutionVerifier¶

Bases: Verifier

A verifier that checks that the command is being executed.

__init__(check: yamcs.pymdb.verifiers.AlgorithmCheck | yamcs.pymdb.verifiers.ContainerCheck | yamcs.pymdb.verifiers.ExpressionCheck, timeout: float, delay: float = 0, name: ~typing.Optional[str] = None, on_success: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, on_fail: yamcs.pymdb.verifiers.TerminationAction | None = TerminationAction.FAIL, on_timeout: ~typing.Optional[~yamcs.pymdb.verifiers.TerminationAction] = None, extra: dict[str, str] = <factory>) → None¶

check: AlgorithmCheck | ContainerCheck | ExpressionCheck¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = None¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

timeout: float¶: How long to wait for a check result (in seconds)

CompleteVerifier¶

class yamcs.pymdb.CompleteVerifier¶

Bases: Verifier

A verifier that checks whether the command to be considered completed

__init__(check: Check, timeout: float, delay: float = 0, name: str | None = None, on_success: TerminationAction | None = TerminationAction.SUCCESS, on_fail: TerminationAction | None = TerminationAction.FAIL, on_timeout: TerminationAction | None = None, extra: dict[str, str] = <factory>, return_parameter: Parameter | None = None) → None¶

check: Check¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = 1¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

return_parameter: Parameter | None = None¶

timeout: float¶: How long to wait for a check result (in seconds)

FailedVerifier¶

class yamcs.pymdb.FailedVerifier¶

Bases: Verifier

A verifier that checks that the command failed.

__init__(check: Check, timeout: float, delay: float = 0, name: str | None = None, on_success: TerminationAction | None = TerminationAction.FAIL, on_fail: TerminationAction | None = None, on_timeout: TerminationAction | None = None, extra: dict[str, str] = <factory>, return_parameter: Parameter | None = None) → None¶

check: Check¶: Check to perform

delay: float = 0¶: Wait time before starting to check (in seconds)

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

name: str | None = None¶: Optional name

on_fail: TerminationAction | None = None¶: What it means for the whole command, when this single verifier fails

on_success: TerminationAction | None = 2¶: What it means for the whole command, when this single verifier succeeds

on_timeout: TerminationAction | None = None¶: What it means for the whole command, when this single verifier times out

return_parameter: Parameter | None = None¶

timeout: float¶: How long to wait for a check result (in seconds)

TerminationAction¶

class yamcs.pymdb.TerminationAction¶

Bases: Enum

An enumeration.

SUCCESS = 1¶

FAIL = 2¶

AlgorithmCheck¶

class yamcs.pymdb.AlgorithmCheck¶

Bases: object

__init__(algorithm: UnnamedAlgorithm)¶

ContainerCheck¶

class yamcs.pymdb.ContainerCheck¶

Bases: object

__init__(container: Container)¶

ExpressionCheck¶

class yamcs.pymdb.ExpressionCheck¶

Bases: object

__init__(expression: Expression)¶