Package org.yamcs.tctm

Class GenericCommandPostprocessor

java.lang.Object

org.yamcs.tctm.GenericCommandPostprocessor

All Implemented Interfaces:

CommandPostprocessor

public class GenericCommandPostprocessor
extends Object
implements CommandPostprocessor

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandHistoryPublisher	commandHistoryListener

Constructor Summary

Constructors

Constructor	Description
GenericCommandPostprocessor()

Method Summary

Modifier and Type	Method	Description
int	getBinaryLength(PreparedCommand pc)	Return the size of the binary packet for this command.
void	init(String yamcsInstance, YConfiguration config)	Called to initialise the postprocessor and set the cmd hist publisher (used to publish command acknowledgments), the timeService (required to timestamp acks) and the configuration
byte[]	process(PreparedCommand pc)	processes the command and returns the binary buffer.
void	setCommandHistoryPublisher(CommandHistoryPublisher commandHistoryListener)	sets the command history listener which can be used by the preprocessor to provide command history entries related to the command processed

Methods inherited from class java.lang.Object

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

Field Details

commandHistoryListener

protected CommandHistoryPublisher commandHistoryListener

Constructor Details

GenericCommandPostprocessor

public GenericCommandPostprocessor()

Method Details

init

public void init(String yamcsInstance,
 YConfiguration config)

Description copied from interface: CommandPostprocessor

Called to initialise the postprocessor and set the cmd hist publisher (used to publish command acknowledgments), the timeService (required to timestamp acks) and the configuration

Specified by:

init in interface CommandPostprocessor

process

public byte[] process(PreparedCommand pc)

Description copied from interface: CommandPostprocessor

processes the command and returns the binary buffer. Returns null if the command cannot be processed (e.g. its size does not correspond to what this processor expects). In this case, the post-processor is expected to fail the command in the command history (also filling in an appropriate reason)

Specified by:

process in interface CommandPostprocessor

Returns:

the processed command or null if the command cannot be processed

setCommandHistoryPublisher

public void setCommandHistoryPublisher(CommandHistoryPublisher commandHistoryListener)

Description copied from interface: CommandPostprocessor

sets the command history listener which can be used by the preprocessor to provide command history entries related to the command processed

Specified by:

setCommandHistoryPublisher in interface CommandPostprocessor

getBinaryLength

public int getBinaryLength(PreparedCommand pc)

Description copied from interface: CommandPostprocessor

Return the size of the binary packet for this command.

This is required in the frame links which bundle multiple commands together to know if the command will fit into the frame before post-processing it.

Specified by:

getBinaryLength in interface CommandPostprocessor

Returns:

the size of the binary packet which the method CommandPostprocessor.process(PreparedCommand) will return.