Package org.yamcs.tctm
Interface CommandPostprocessor
- All Known Implementing Classes:
CfsCommandPostprocessor
,CspCommandPostprocessor
,GenericCommandPostprocessor
,IssCommandPostprocessor
,PusCommandPostprocessor
public interface CommandPostprocessor
The command post processor is responsible to provide the binary packet that will be send out for a PreparedCommand.
It is used to add sequence counts, compute checkwords, etc
-
Method Summary
Modifier and TypeMethodDescriptiondefault int
Return the size of the binary packet for this command.byte[]
processes the command and returns the binary buffer.default 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
-
Method Details
-
process
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)- Parameters:
pc
-- Returns:
-
setCommandHistoryPublisher
sets the command history listener which can be used by the preprocessor to provide command history entries related to the command processed- Parameters:
commandHistoryListener
-
-
getBinaryLength
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.
- Parameters:
pc
-- Returns:
- the size of the binary packet which the method
process(PreparedCommand)
will return.
-