Get Archived Parameter Segments¶

// Recorded segments for the requested parameter
interface ArchivedParameterSegmentsResponse {
  parameterInfo: ArchivedParameterInfo;
  segments: ArchiveParameterSegmentInfo[];
}

// This message contains information about one parameter in the parameter archive.
// Each (parameter name, raw type, engineering type) is assigned a unique id and all
// the samples are stored with that id.
// If a MDB change results in the parameter having a different engineering or raw type,
// a new pid will be allocated.
// This is why for the same parameter name, we can have multiple parameter ids.
// The parameter archive will contain data even for parameters removed from the MDB
interface ArchivedParameterInfo {

  //parameter id
  pid: number;

  //parameter fully qualified name
  fqn: string;

  // parameter raw type
  rawType: Type;

  //parameter engineering type
  engType: Type;

  //the groups which this parameter is part of
  gids: number[];
}

interface ArchiveParameterSegmentInfo {

  // Multiple parameters are grouped such that all in one group have
  // the same timestamps. For example: all parameters extracted from
  // one TM packet usually have the same timestamp.
  // This way we have a unique segment storing the timestamps for a
  // group of parameters. The groupId can be used to retrieve all parameters
  // from the same group.
  groupId: number;

  //the segment start
  start: string;  // RFC 3339 timestamp

  //the segment end
  end: string;  // RFC 3339 timestamp

  //the number of samples in the segment
  count: number;
}

enum Type {
  FLOAT = "FLOAT",
  DOUBLE = "DOUBLE",
  UINT32 = "UINT32",
  SINT32 = "SINT32",
  BINARY = "BINARY",
  STRING = "STRING",
  TIMESTAMP = "TIMESTAMP",
  UINT64 = "UINT64",
  SINT64 = "SINT64",
  BOOLEAN = "BOOLEAN",
  AGGREGATE = "AGGREGATE",
  ARRAY = "ARRAY",

  // Enumerated values have both an integer (sint64Value) and a string representation
  ENUMERATED = "ENUMERATED",
  NONE = "NONE",
}