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(String yamcsInstance)
GenericCommandPostprocessor(String yamcsInstance, YConfiguration config)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getBinaryLength(PreparedCommand pc)
Return the size of the binary packet for this command.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
-
-
-
Field Detail
-
commandHistoryListener
protected CommandHistoryPublisher commandHistoryListener
-
-
Constructor Detail
-
GenericCommandPostprocessor
public GenericCommandPostprocessor(String yamcsInstance)
-
GenericCommandPostprocessor
public GenericCommandPostprocessor(String yamcsInstance, YConfiguration config)
-
-
Method Detail
-
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 postprocessor is expected to fail the command in the command history (also filling in an appropiate reason)- Specified by:
process
in interfaceCommandPostprocessor
- Returns:
-
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 interfaceCommandPostprocessor
-
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 interfaceCommandPostprocessor
- Returns:
- the size of the binary packet which the method
CommandPostprocessor.process(PreparedCommand)
will return.
-
-