Package org.yamcs.archive

Class XtceTmRecorder

java.lang.Object

com.google.common.util.concurrent.AbstractService

org.yamcs.AbstractYamcsService

org.yamcs.archive.XtceTmRecorder

All Implemented Interfaces:

com.google.common.util.concurrent.Service, YamcsService

public class XtceTmRecorder
extends AbstractYamcsService

Records XTCE TM sequence containers.

The main job of this class is to populate the "pname" column of the tm table. The other columns are copied verbatim from the TM input streams. It does that by creating a XtceTmExtractor and subscribing to all sequence containers having the flag SequenceContainer.useAsPacketName() set. The pname is the qualified name of the most specific (lowest in the XTCE hierarchy) container matching the telemetry packet.

It subscribes to all the streams configured with the "streams" config key or, if not present, to all TM streams defined in the instance (streamConfig section of the instance configuration).

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.common.util.concurrent.Service

com.google.common.util.concurrent.Service.Listener, com.google.common.util.concurrent.Service.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CF_NAME
static final String	PNAME_COLUMN
static final String	REC_STREAM_NAME
static final TupleDefinition	RECORDED_TM_TUPLE_DEFINITION
static final String	TABLE_NAME

Fields inherited from class org.yamcs.AbstractYamcsService

config, log, serviceName, yamcsInstance

Constructor Summary

Constructors

Constructor	Description
XtceTmRecorder()

Method Summary

Modifier and Type	Method	Description
static String	deriveArchivePartition(ContainerProcessingResult cpr)	Deprecated. use derivePacketName(ContainerProcessingResult)
static String	derivePacketName(ContainerProcessingResult cpr)	Derives the packet name (the value of the pname column) from the result of processing a packet.
protected void	doStart()
protected void	doStop()
long	getNumProcessedPackets()
TmPartitionGroups	getPartitionGroups()	Returns the partition groups or null if the tm table is not partitioned by group.
Spec	getSpec()	Returns the valid configuration options for this service.
void	init(String yamcsInstance, String serviceName, YConfiguration config)	Initialize this service.

Methods inherited from class org.yamcs.AbstractYamcsService

findStream, getConfig, getYamcsInstance

Methods inherited from class com.google.common.util.concurrent.AbstractService

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, doCancelStart, failureCause, isRunning, notifyFailed, notifyStarted, notifyStopped, startAsync, state, stopAsync, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.common.util.concurrent.Service

addListener, awaitRunning, awaitRunning, awaitRunning, awaitTerminated, awaitTerminated, awaitTerminated, failureCause, isRunning, startAsync, state, stopAsync

Field Details

REC_STREAM_NAME

public static final String REC_STREAM_NAME

See Also:

• Constant Field Values

TABLE_NAME

public static final String TABLE_NAME

See Also:

• Constant Field Values

PNAME_COLUMN

public static final String PNAME_COLUMN

See Also:

• Constant Field Values

CF_NAME

public static final String CF_NAME

See Also:

• Constant Field Values

RECORDED_TM_TUPLE_DEFINITION

public static final TupleDefinition RECORDED_TM_TUPLE_DEFINITION

Constructor Details

XtceTmRecorder

public XtceTmRecorder()

Method Details

getSpec

public Spec getSpec()

Description copied from interface: YamcsService

Returns the valid configuration options for this service.

Returns:

the argument specification, or null if the args should not be validated.

init

public void init(String yamcsInstance,
 String serviceName,
 YConfiguration config)
          throws InitException

Description copied from interface: YamcsService

Initialize this service. This is called before the service is started. All operations should finish fast.

Specified by:

init in interface YamcsService

Overrides:

init in class AbstractYamcsService

Parameters:

yamcsInstance - The yamcs instance, or null if this is a global service.

serviceName - The service name.

config - The configured arguments for this service. If YamcsService.getSpec() is implemented then this contains the arguments after being validated (including any defaults).

Throws:

InitException - When something goes wrong during the execution of this method.

getPartitionGroups

public TmPartitionGroups getPartitionGroups()

Returns the partition groups or null if the tm table is not partitioned by group.

doStart

protected void doStart()

Specified by:

doStart in class com.google.common.util.concurrent.AbstractService

doStop

protected void doStop()

Specified by:

doStop in class com.google.common.util.concurrent.AbstractService

getNumProcessedPackets

public long getNumProcessedPackets()

derivePacketName

public static String derivePacketName(ContainerProcessingResult cpr)

Derives the packet name (the value of the pname column) from the result of processing a packet.

The first container is the root container. We take the name of the most specific one derived directly from the root, having the SequenceContainer.useAsPacketName() flag set. If none has the flag set, the name of the root container is used.

deriveArchivePartition

@Deprecated
public static String deriveArchivePartition(ContainerProcessingResult cpr)

Deprecated.

use derivePacketName(ContainerProcessingResult)