Module org.yamcs.core

Package org.yamcs.pus

Class PusCommandPostprocessor

java.lang.Object

org.yamcs.tctm.AbstractCommandPostProcessor

org.yamcs.pus.PusCommandPostprocessor

All Implemented Interfaces:

CommandPostprocessor

public class PusCommandPostprocessor
extends AbstractCommandPostProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static final CommandOption	OPTION_SCHEDULE_TIME
protected CcsdsSeqCountFiller	seqFiller
protected CucTimeEncoder	timeEncoder

Fields inherited from class org.yamcs.tctm.AbstractCommandPostProcessor

commandHistoryPublisher, log, timeService

Constructor Summary

Constructors

Constructor	Description
PusCommandPostprocessor()

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.

Methods inherited from class org.yamcs.tctm.AbstractCommandPostProcessor

failCommand, setCommandHistoryPublisher

Methods inherited from class java.lang.Object

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

Field Details

OPTION_SCHEDULE_TIME

public static final CommandOption OPTION_SCHEDULE_TIME

seqFiller

protected CcsdsSeqCountFiller seqFiller

timeEncoder

protected CucTimeEncoder timeEncoder

Constructor Details

PusCommandPostprocessor

public PusCommandPostprocessor()

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

Overrides:

init in class AbstractCommandPostProcessor

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)

Returns:

the processed command or null if the command cannot be processed

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.

Returns:

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