org.yamcs.protobuf

Class AbstractParameterArchiveApi<T>

java.lang.Object

org.yamcs.protobuf.AbstractParameterArchiveApi<T>

All Implemented Interfaces:

Api<T>

Direct Known Subclasses:

ParameterArchiveApiClient

public abstract class AbstractParameterArchiveApi<T>
extends Object
implements Api<T>

Constructor Summary

Constructors

Constructor and Description
AbstractParameterArchiveApi()

Method Summary

Modifier and Type	Method and Description
void	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, com.google.protobuf.Message request, Observer<com.google.protobuf.Message> future)
Observer<com.google.protobuf.Message>	callMethod(com.google.protobuf.Descriptors.MethodDescriptor method, T ctx, Observer<com.google.protobuf.Message> future)
abstract void	deletePartitions(T ctx, DeletePartitionsRequest request, Observer<Yamcs.StringMessage> observer) Delete partitions Response is of type string and list the partitions that have been removed.
abstract void	getArchivedParameterInfo(T ctx, GetArchivedParameterInfoRequest request, Observer<Yamcs.StringMessage> observer) Get parameter info
com.google.protobuf.Descriptors.ServiceDescriptor	getDescriptorForType()
abstract void	getParameterRanges(T ctx, GetParameterRangesRequest request, Observer<Pvalue.Ranges> observer) Get parameter ranges A range is a tuple ``(start, stop, value, count)`` that represents the time interval for which the parameter has been steadily coming in with the same value.
abstract void	getParameterSamples(T ctx, Archive.GetParameterSamplesRequest request, Observer<Pvalue.TimeSeries> observer) Get parameter samples This divides the query interval in a number of intervals and returns aggregated statistics (max,min,avg) about each interval.
com.google.protobuf.Message	getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
com.google.protobuf.Message	getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)
abstract void	listParameterHistory(T ctx, Archive.ListParameterHistoryRequest request, Observer<Archive.ListParameterHistoryResponse> observer) List parameter history
abstract void	rebuildRange(T ctx, RebuildRangeRequest request, Observer<com.google.protobuf.Empty> observer) Rebuild range The back filler has to be enabled for this purpose.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractParameterArchiveApi

public AbstractParameterArchiveApi()

Method Detail

rebuildRange

public abstract void rebuildRange(T ctx,
                                  RebuildRangeRequest request,
                                  Observer<com.google.protobuf.Empty> observer)

  Rebuild range
 
  The back filler has to be enabled for this purpose. The back filling process does not
  remove data but just overwrites it. That means that if the parameter replay returns
  less parameters than originally stored in the archive, the old parameters will still
  be found in the archive.
 
  It also means that if a replay returns the parameter of a different type than
  originally stored, the old ones will still be stored. This is because the parameter
  archive treats parameter with the same name but different type as different parameters.
  Each of them is given an id and the id is stored in the archive.
 

deletePartitions

public abstract void deletePartitions(T ctx,
                                      DeletePartitionsRequest request,
                                      Observer<Yamcs.StringMessage> observer)

  Delete partitions
 
  Response is of type string and list the partitions that have been removed.
 

getArchivedParameterInfo

public abstract void getArchivedParameterInfo(T ctx,
                                              GetArchivedParameterInfoRequest request,
                                              Observer<Yamcs.StringMessage> observer)

  Get parameter info
 

getParameterSamples

public abstract void getParameterSamples(T ctx,
                                         Archive.GetParameterSamplesRequest request,
                                         Observer<Pvalue.TimeSeries> observer)

  Get parameter samples
 
  This divides the query interval in a number of intervals and returns aggregated
  statistics (max,min,avg) about each interval.
 
  This operation is useful when making high-level overviews (such as plots) of a
  parameter's value over large time intervals without having to retrieve each
  and every individual parameter value.
 
  By default this operation fetches data from the parameter archive and/or
  parameter cache. If these services are not configured, you can still get
  correct results by specifying the option ``source=replay`` as detailed below.
 

getParameterRanges

public abstract void getParameterRanges(T ctx,
                                        GetParameterRangesRequest request,
                                        Observer<Pvalue.Ranges> observer)

  Get parameter ranges
 
  A range is a tuple ``(start, stop, value, count)`` that represents the time
  interval for which the parameter has been steadily coming in with the same
  value. This request is useful for retrieving an overview for parameters that
  change unfrequently in a large time interval. For example an on/off status
  of a device, or some operational status. Two consecutive ranges containing
  the same value will be returned if there was a gap in the data. The gap is
  determined according to the parameter expiration time configured in the
  Mission Database.
 

listParameterHistory

public abstract void listParameterHistory(T ctx,
                                          Archive.ListParameterHistoryRequest request,
                                          Observer<Archive.ListParameterHistoryResponse> observer)

  List parameter history
 

getDescriptorForType

public final com.google.protobuf.Descriptors.ServiceDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Api<T>

getRequestPrototype

public final com.google.protobuf.Message getRequestPrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getRequestPrototype in interface Api<T>

getResponsePrototype

public final com.google.protobuf.Message getResponsePrototype(com.google.protobuf.Descriptors.MethodDescriptor method)

Specified by:

getResponsePrototype in interface Api<T>

callMethod

public final void callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
                             T ctx,
                             com.google.protobuf.Message request,
                             Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>

callMethod

public final Observer<com.google.protobuf.Message> callMethod(com.google.protobuf.Descriptors.MethodDescriptor method,
                                                              T ctx,
                                                              Observer<com.google.protobuf.Message> future)

Specified by:

callMethod in interface Api<T>