org.yamcs.xtceproc

Class XtceTmExtractor

java.lang.Object

org.yamcs.xtceproc.XtceTmExtractor

public class XtceTmExtractor
extends Object

Extracts parameters out of packets based on the XTCE description

Field Summary

Fields

Modifier and Type	Field and Description
protected Subscription	subscription
XtceDb	xtcedb

Constructor Summary

Constructors

Constructor and Description
XtceTmExtractor(XtceDb xtcedb) Creates a TmExtractor extracting data according to the XtceDb

Method Summary

Modifier and Type	Method and Description
ArrayList<ContainerExtractionResult>	getContainerResult()
ParameterValueList	getParameterResult()
ProcessingStatistics	getStatistics()
Subscription	getSubscription()
boolean	isIgnoreOutOfContainerEntries()
void	processPacket(ByteBuffer bb, long generationTime, long acquisitionTime) Extract one packet, starting at the root sequence container
void	processPacket(ByteBuffer bb, long generationTime, long aquisitionTime, SequenceContainer startContainer) Extract one packet, starting at the specified container.
void	resetStatistics()
void	setIgnoreOutOfContainerEntries(boolean ignoreOutOfContainerEntries) If set to true, the entries that fit outside the packet definition, will not be even logged.
void	startProviding(Parameter param) Adds a parameter to the current subscription list: finds all the SequenceContainers in which this parameter may appear and adds them to the list.
void	startProviding(SequenceContainer sequenceContainer)
void	startProvidingAll() Adds all containers and parameters to the subscription
void	stopProviding(Parameter param)
void	stopProviding(SequenceContainer sequenceContainer)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

subscription

protected final Subscription subscription

xtcedb

public final XtceDb xtcedb

Constructor Detail

XtceTmExtractor

public XtceTmExtractor(XtceDb xtcedb)

Creates a TmExtractor extracting data according to the XtceDb

Parameters:

xtcedb -

Method Detail

startProviding

public void startProviding(Parameter param)

Adds a parameter to the current subscription list: finds all the SequenceContainers in which this parameter may appear and adds them to the list. also for each sequence container adds the parameter needed to instantiate the sequence container.

Parameters:

param - parameter to be added to the current subscription list

startProvidingAll

public void startProvidingAll()

Adds all containers and parameters to the subscription

stopProviding

public void stopProviding(Parameter param)

processPacket

public void processPacket(ByteBuffer bb,
                          long generationTime,
                          long acquisitionTime)

Extract one packet, starting at the root sequence container

processPacket

public void processPacket(ByteBuffer bb,
                          long generationTime,
                          long aquisitionTime,
                          SequenceContainer startContainer)

Extract one packet, starting at the specified container.

resetStatistics

public void resetStatistics()

getStatistics

public ProcessingStatistics getStatistics()

isIgnoreOutOfContainerEntries

public boolean isIgnoreOutOfContainerEntries()

setIgnoreOutOfContainerEntries

public void setIgnoreOutOfContainerEntries(boolean ignoreOutOfContainerEntries)

If set to true, the entries that fit outside the packet definition, will not be even logged. If set to false, a log message at WARNING level will be printed for the first entry that fits outside the binary packet. In both cases, the processing stops at first such entry.

Parameters:

ignoreOutOfContainerEntries -

startProviding

public void startProviding(SequenceContainer sequenceContainer)

stopProviding

public void stopProviding(SequenceContainer sequenceContainer)

getParameterResult

public ParameterValueList getParameterResult()

getContainerResult

public ArrayList<ContainerExtractionResult> getContainerResult()

getSubscription

public Subscription getSubscription()

toString

public String toString()

Overrides:

toString in class Object