/  Python Yamcs Client  /  Mission Database  /  Model

Model

class yamcs.mdb.model.Algorithm(proto)
property aliases

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

property description

Short description.

property long_description

Long description.

property name

Short name

property qualified_name

Full name (incl. space system)

class yamcs.mdb.model.ArrayType(proto)
property array_type

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.

Type

ArrayType

property dimensions

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

property members

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

Type

List[Member]

property name

Short name of this type.

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

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

property aliases

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

property base_command
property description

Short description.

property long_description

Long description.

property name

Short name

property qualified_name

Full name (incl. space system)

property significance
class yamcs.mdb.model.Container(proto)
property aliases

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

property description

Short description.

property long_description

Long description.

property name

Short name

property qualified_name

Full name (incl. space system)

class yamcs.mdb.model.DataEncoding(proto)
property bitlength

The size in bits

property encoding

Encoding detail

property little_endian

True if little-endian

property type

Raw type

class yamcs.mdb.model.EnumValue(proto)
property description

State description

property label

String value

property value

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

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

Type

ArrayType

property members

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

Type

List[Member]

property name

Short name

property type

Engineering type.

Type

str

class yamcs.mdb.model.Parameter(proto)

From XTCE:

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

property aliases

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

property array_type

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

Type

ArrayType

property data_encoding

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

Type

DataEncoding

property data_source

Specifies how this parameter originated (example: TELEMETERED)

Type

str

property description

Short description.

property enum_values

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

Type

List[EnumValue]

property long_description

Long description.

property members

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

Type

List[Member]

property name

Short name

property qualified_name

Full name (incl. space system)

property type

Engineering type.

Type

str

property units

Engineering unit(s)

Type

List[str]

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

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

property reason

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 of (namespace, name) pairs, as 2-tuples

property description

Short description.

property long_description

Long description.

property name

Short name

property qualified_name

Full name (incl. space system)