Systems¶

Bases: object

The top-level system is the root element for the set of metadata necessary to monitor and command a space device, such as a satellite.

A system defines a namespace.

Metadata areas include: telemetry, calibration, alarm, algorithms and commands.

A system may have child Subsystems, forming a system tree.

__init__(name: str, aliases: Optional[Mapping[str, str]] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None)¶

property algorithms: list[Algorithm]¶

Algorithms directly belonging to this system

aliases: dict[str, str]¶

Alternative names, keyed by namespace

property commands: list[Command]¶

Commands directly belonging to this system

property containers: list[Container]¶

Containers directly belonging to this system

dump(fp, indent: str = '  ', top_comment: bool | str = True) → None¶

Serialize this system in XTCE format to a file-like object

dumps(indent: str = '  ', top_comment: bool | str = True) → str¶

Serialize this system to an XTCE formatted string

extra: dict[str, str]¶

Arbitrary information, keyed by name

find_algorithm(name: str) → Algorithm¶

Find an algorithm belonging directly to this system.

Raises an exception if no algorithm is found

find_command(name: str) → Command¶

Find a command belonging directly to this system.

Raises an exception if no command is found

find_container(name: str) → Container¶

Find a container belonging directly to this system.

Raises an exception if no container is found

find_parameter(name: str) → Parameter¶

Find a parameter belonging directly to this system.

Raises an exception if no parameter is found

find_subsystem(name: str) → Subsystem¶

Find a subsystem belonging directly to this system.

Raises an exception if no subsystem is found

long_description: str | None¶

Multiline description

name: str¶

Short name of this system

property parameters: list[Parameter]¶

Parameters directly belonging to this system

property qualified_name: str¶

remove_algorithm(name: str) → bool¶

Removes an algorithm directly belonging to this system.

Raises an exception if no such algorithm exists

remove_command(name: str) → bool¶

Removes a command directly belonging to this system.

Raises an exception if no such command exists

remove_container(name: str) → bool¶

Removes a container directly belonging to this system.

Raises an exception if no such container exists

remove_parameter(name: str) → bool¶

Removes a parameter directly belonging to this system.

Raises an exception if no such parameter exists

remove_subsystem(name: str) → bool¶

Removes a subsystem directly belonging to this system.

Raises an exception if no such subsystem exists

property root: System¶

The top-most system

short_description: str | None¶

Oneline description

property subsystems: list[Subsystem]¶

Subsystems directly belonging to this system

Bases: System

A subsystem is identical to a System, but in addition keeps a reference to its parent system.

__init__(system: System, name: str, aliases: Optional[Mapping[str, str]] = None, short_description: Optional[str] = None, long_description: Optional[str] = None, extra: Optional[Mapping[str, str]] = None)¶

property algorithms: list[Algorithm]¶

Algorithms directly belonging to this system

aliases: dict[str, str]¶

Alternative names, keyed by namespace

property commands: list[Command]¶

Commands directly belonging to this system

property containers: list[Container]¶

Containers directly belonging to this system

dump(fp, indent: str = '  ', top_comment: bool | str = True) → None¶

Serialize this system in XTCE format to a file-like object

dumps(indent: str = '  ', top_comment: bool | str = True) → str¶

Serialize this system to an XTCE formatted string

extra: dict[str, str]¶

Arbitrary information, keyed by name

find_algorithm(name: str) → Algorithm¶

Find an algorithm belonging directly to this system.

Raises an exception if no algorithm is found

find_command(name: str) → Command¶

Find a command belonging directly to this system.

Raises an exception if no command is found

find_container(name: str) → Container¶

Find a container belonging directly to this system.

Raises an exception if no container is found

find_parameter(name: str) → Parameter¶

Find a parameter belonging directly to this system.

Raises an exception if no parameter is found

find_subsystem(name: str) → Subsystem¶

Find a subsystem belonging directly to this system.

Raises an exception if no subsystem is found

long_description: str | None¶

Multiline description

name: str¶

Short name of this system

property parameters: list[Parameter]¶

Parameters directly belonging to this system

property qualified_name: str¶

Fully qualified name of this system (absolute path)

remove_algorithm(name: str) → bool¶

Removes an algorithm directly belonging to this system.

Raises an exception if no such algorithm exists

remove_command(name: str) → bool¶

Removes a command directly belonging to this system.

Raises an exception if no such command exists

remove_container(name: str) → bool¶

Removes a container directly belonging to this system.

Raises an exception if no such container exists

remove_parameter(name: str) → bool¶

Removes a parameter directly belonging to this system.

Raises an exception if no such parameter exists

remove_subsystem(name: str) → bool¶

Removes a subsystem directly belonging to this system.

Raises an exception if no such subsystem exists

property root: System¶

The top-most system

short_description: str | None¶

Oneline description

property subsystems: list[Subsystem]¶

Subsystems directly belonging to this system

system: System¶

Parent system