Model¶

class yamcs.archive.model.ColumnData(proto)¶

property name¶: Column name.

property value¶: Value for this column.

class yamcs.archive.model.IndexGroup(proto)¶

Group of index records that represent the same type of underlying objects.

property name¶

Name associated with this group. The meaning is defined by the objects represented by this index. For example:

In an index of events, index records are grouped by source.
In an index of packets, index records are grouped by packet name.

property records¶

Index records within this group

Type: List[IndexRecord]

class yamcs.archive.model.IndexRecord(proto)¶

Represents a block of uninterrupted data (derived from the index definition for the type of underlying objects, in combination with the requested merge_time.

property count¶: Number of underlying objects this index record represents

property start¶

Start time of the record

Type: datetime

property stop¶

Stop time of the record

Type: datetime

class yamcs.archive.model.ParameterRange(proto)¶

Indicates an interval during which a parameter’s value was uninterrupted and unchanged.

property eng_value¶

The engineering (calibrated) value within this range.

If the request was made using min_range option, this will be the most-frequent value only. Retrieve the complete distribution using the entries attribute.

property entries¶

Value distribution within this range.

Unless the request was made using min_range option, there should be only one entry only.

Type: List[ParameterRangeEntry]

property parameter_count¶: The total number of parameter values within this range.

property start¶

Start time of this range (inclusive).

Type: datetime

property stop¶

Stop time of this range (exclusive).

Type: datetime

class yamcs.archive.model.ParameterRangeEntry(proto)¶

Value holder for an engineering value and its number of appearances within a ParameterRange.

property eng_value¶: The engineering (calibrated) value.

property parameter_count¶: The number of received parameter values during this range.

class yamcs.archive.model.ResultSet(response)¶

Provides capability to consume the rows returned by a SQL query, or access related information.

property column_types¶

Column types.

Type: str[]

property columns¶

Column names. This returns None as long as no row has been consumed yet.

Type: str[]

class yamcs.archive.model.Sample(proto)¶

Provides aggregation properties over a range of a parameter’s values.

property avg¶: Average value.

property max¶: Maximum value.

property min¶: Minimum value.

property parameter_count¶: The number of parameter values this sample represents.

property time¶

Sample time.

Type: datetime

class yamcs.archive.model.Stream(proto)¶

property name¶: Stream name.

class yamcs.archive.model.StreamData(proto)¶

property columns¶: Tuple columns.

property stream¶: Stream name.

class yamcs.archive.model.Table(proto)¶

property name¶: Table name.