Package 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	Description
protected Subscription	subscription
XtceDb	xtcedb

Constructor Summary

Constructors

Constructor	Description
XtceTmExtractor(XtceDb xtcedb)	Create a standalone TM extractor
XtceTmExtractor(XtceDb xtcedb, ProcessorData pdata)	Create a new TM extractor with the given context

Method Summary

Modifier and Type	Method	Description
ContainerProcessingOptions	getOptions()
ProcessingStatistics	getStatistics()
Subscription	getSubscription()
ContainerProcessingResult	processPacket(byte[] b, long generationTime, long acquisitionTime)	Extract one packet, starting at the root sequence container
ContainerProcessingResult	processPacket(byte[] b, long generationTime, long acquisitionTime, SequenceContainer startContainer)	Extract one packet, starting at the specified container.
ContainerProcessingResult	processPacket(BitBuffer buf, long generationTime, long acquisitionTime)	Extract one packet, starting at the root sequence container
ContainerProcessingResult	processPacket(BitBuffer buf, long generationTime, long acquisitionTime, SequenceContainer startContainer)	Extract one packet, starting at the specified container.
void	provideAll()	Adds all containers and parameters to the subscription
void	resetStatistics()
void	setOptions(ContainerProcessingOptions opts)
void	startProviding(Parameter param)	Adds a parameter to the current subscription list.
void	startProviding(SequenceContainer sequenceContainer)
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)

Create a standalone TM extractor

Parameters:

xtcedb -

XtceTmExtractor

public XtceTmExtractor(XtceDb xtcedb,
                       ProcessorData pdata)

Create a new TM extractor with the given context

Parameters:

xtcedb -

pdata -

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.
• for each sequence container adds the parameter needed to instantiate the sequence container.
• if there is any IndirectParameterRefEntry having its alias namespace as one of the aliases of param, adds it also to the subcription

Parameters:

param - parameter to be added to the current subscription list

provideAll

public void provideAll()

Adds all containers and parameters to the subscription

stopProviding

public void stopProviding(Parameter param)

processPacket

public ContainerProcessingResult processPacket(byte[] b,
                                               long generationTime,
                                               long acquisitionTime)

Extract one packet, starting at the root sequence container

processPacket

public ContainerProcessingResult processPacket(BitBuffer buf,
                                               long generationTime,
                                               long acquisitionTime)

Extract one packet, starting at the root sequence container

processPacket

public ContainerProcessingResult processPacket(byte[] b,
                                               long generationTime,
                                               long acquisitionTime,
                                               SequenceContainer startContainer)

Extract one packet, starting at the specified container.

processPacket

public ContainerProcessingResult processPacket(BitBuffer buf,
                                               long generationTime,
                                               long acquisitionTime,
                                               SequenceContainer startContainer)

Extract one packet, starting at the specified container.

resetStatistics

public void resetStatistics()

getStatistics

public ProcessingStatistics getStatistics()

startProviding

public void startProviding(SequenceContainer sequenceContainer)

stopProviding

public void stopProviding(SequenceContainer sequenceContainer)

getSubscription

public Subscription getSubscription()

toString

public String toString()

Overrides:

toString in class Object

setOptions

public void setOptions(ContainerProcessingOptions opts)

getOptions

public ContainerProcessingOptions getOptions()