/  Python Yamcs Client  /  Mission Database  /  Model

Model

class yamcs.mdb.model.Algorithm(proto)
property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property description: Optional[str]

Short description.

property long_description: Optional[str]

Long description.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

class yamcs.mdb.model.ArrayType(proto)
property array_type: Optional[ArrayType]

In case the elements of an array of this type are also of type array, this returns type info of the elements’ array type.

Note

This is an uncommon use case. Multi-dimensional arrays are more prevalent.

property dimensions: Optional[int]

The number of dimensions in case of a multi-dimensional array.

property members: List[Member]

In case the elements of this array are of type aggregate, this returns an ordered list of its direct sub-members.

property name: str

Short name of this type.

class yamcs.mdb.model.Command(proto)
property abstract: bool

Whether this is an abstract command. Abstract commands are intended for inheritance and cannot be issued directly.

property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property base_command: Optional[Command]
property description: Optional[str]

Short description.

property long_description: Optional[str]

Long description.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

property significance: Optional[Significance]
class yamcs.mdb.model.Container(proto)
property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property description: Optional[str]

Short description.

property long_description: Optional[str]

Long description.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

class yamcs.mdb.model.DataEncoding(proto)
property bitlength: Optional[int]

The size in bits

property encoding: Optional[str]

Encoding detail

property little_endian: bool

True if little-endian

property type: str

Raw type

class yamcs.mdb.model.EnumValue(proto)
property description: Optional[str]

State description

property label: str

String value

property value: int

Numeric value

class yamcs.mdb.model.Member(proto)

A member is a data structure for a specific field of a parent data type (either another member, or a parameter of type aggregate).

This is similar to C structs. The top-level of a member hierarchy is a parameter of type aggregate.

property array_type: Optional[ArrayType]

In case this member is of type array, this returns array-specific type info.

property members: List[Member]

In case this member is of type aggregate, this returns an ordered list of its direct sub-members.

property name: str

Short name

property type: str

Engineering type.

class yamcs.mdb.model.MissionDatabaseItem(proto)

Superclass for MDB items. Implementations:

property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property description: Optional[str]

Short description.

property long_description: Optional[str]

Long description.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

class yamcs.mdb.model.Parameter(proto)

A Parameter is a description of something that can have a value. It is not the value itself.

property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property array_type: Optional[ArrayType]

In case this parameter is of type array, this returns array-specific type info.

property data_encoding: Optional[DataEncoding]

Information on the raw encoding of this parameter, if applicable.

property data_source: Optional[str]

TELEMETERED)

Type:

Specifies the source of this parameter (example

property description: Optional[str]

Short description.

property enum_values: List[EnumValue]

In case this parameter is of type enumeration, this returns an ordered list of possible values.

property long_description: Optional[str]

Long description.

property members: List[Member]

In case this parameter is of type aggregate, this returns an ordered list of its direct members.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

property type: Optional[str]

Engineering type.

property units: List[str]

Engineering unit(s)

class yamcs.mdb.model.ParameterType(proto)
property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property array_type: Optional[ArrayType]

In case this parameter type is of type array, this returns array-specific type info.

property data_encoding: Optional[DataEncoding]

Information on the raw encoding of this parameter type, if applicable.

property description: Optional[str]

Short description.

property enum_values: List[EnumValue]

In case this parameter type is of type enumeration, this returns an ordered list of possible values.

property long_description: Optional[str]

Long description.

property members: List[Member]

In case this parameter type is of type aggregate, this returns an ordered list of its direct members.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

property type: str

Engineering type.

property units: List[str]

Engineering unit(s)

class yamcs.mdb.model.RangeSet(watch: Optional[Tuple[float, float]] = None, warning: Optional[Tuple[float, float]] = None, distress: Optional[Tuple[float, float]] = None, critical: Optional[Tuple[float, float]] = None, severe: Optional[Tuple[float, float]] = None, min_violations: int = 1)

A set of alarm range that apply in a specific context.

Parameters:

  • watch – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

  • warning – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

  • distress – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

  • critical – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

  • severe – Range expressed as a tuple (lo, hi) where lo and hi are assumed exclusive.

  • min_violations – Minimum violations before an alarm is generated.

class yamcs.mdb.model.Significance(proto)
property consequence_level: str

One of NONE, WATCH, WARNING, DISTRESS, CRITICAL or SEVERE.

property reason: Optional[str]

Message attached to this significance.

class yamcs.mdb.model.SpaceSystem(proto)

From XTCE:

A SpaceSystem is a collection of SpaceSystem(s) including space assets, ground assets, multi-satellite systems and sub-systems. A SpaceSystem is the root element for the set of data necessary to monitor and command an arbitrary space device - this includes the binary decomposition of the data streams going into and out of a device.

property aliases: List[Tuple[str, str]]

List of (namespace, name) pairs, as 2-tuples

Deprecated since version 1.9.2: Use aliases_dict instead, which returns a dictionary instead of a list of 2-tuples.

In a future release, the aliases property will be changed to match the return type of aliases_dict.

property aliases_dict: Dict[str, str]

Aliases, keyed by namespace

property description: Optional[str]

Short description.

property long_description: Optional[str]

Long description.

property name: str

Short name

property qualified_name: str

Full name (incl. space system)

PREVIOUS HOME NEXT