Module org.yamcs.core

Package org.yamcs.cmdhistory

Interface CommandHistoryPublisher

All Known Implementing Classes:

StreamCommandHistoryPublisher

public interface CommandHistoryPublisher

Used by the commanding applications to save commands and commands acknowledgements into a history.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	CommandHistoryPublisher.AckStatus	provides acknowledgment status during execution of command

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AcknowledgeQueued_KEY
static final String	AcknowledgeReleased_KEY
static final String	AcknowledgeSent	Used by the links to add entries in the command history when the command has been sent via the link.
static final String	CcsdsSeq_KEY
static final String	CommandComplete_KEY
static final String	Queue_KEY
static final String	SUFFIX_MESSAGE
static final String	SUFFIX_RETURN
static final String	SUFFIX_STATUS
static final String	SUFFIX_TIME
static final String	TransmissionConstraints_KEY
static final String	Verifier_KEY_PREFIX

Method Summary

Modifier and Type	Method	Description
void	addCommand(PreparedCommand pc)
default void	commandFailed(org.yamcs.protobuf.Commanding.CommandId cmdId, long time, String reason)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, byte[] binary)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, int value)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, long value)
void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, String value)
default void	publish(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, ParameterValue returnPv)
default void	publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, long time, CommandHistoryPublisher.AckStatus state)
default void	publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, long time, CommandHistoryPublisher.AckStatus state, String message)
default void	publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId, String key, long time, CommandHistoryPublisher.AckStatus state, String message, ParameterValue returnPv)	Publish an acknowledgement status to the command history.

Field Details

CommandComplete_KEY

static final String CommandComplete_KEY

See Also:

• Constant Field Values

TransmissionConstraints_KEY

static final String TransmissionConstraints_KEY

See Also:

• Constant Field Values

AcknowledgeQueued_KEY

static final String AcknowledgeQueued_KEY

See Also:

• Constant Field Values

AcknowledgeReleased_KEY

static final String AcknowledgeReleased_KEY

See Also:

• Constant Field Values

AcknowledgeSent

static final String AcknowledgeSent

Used by the links to add entries in the command history when the command has been sent via the link.

See Also:

• Constant Field Values

Verifier_KEY_PREFIX

static final String Verifier_KEY_PREFIX

See Also:

• Constant Field Values

CcsdsSeq_KEY

static final String CcsdsSeq_KEY

See Also:

• Constant Field Values

Queue_KEY

static final String Queue_KEY

See Also:

• Constant Field Values

SUFFIX_STATUS

static final String SUFFIX_STATUS

See Also:

• Constant Field Values

SUFFIX_TIME

static final String SUFFIX_TIME

See Also:

• Constant Field Values

SUFFIX_MESSAGE

static final String SUFFIX_MESSAGE

See Also:

• Constant Field Values

SUFFIX_RETURN

static final String SUFFIX_RETURN

See Also:

• Constant Field Values

Method Details

publish

void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 String value)

publish

void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 int value)

publish

void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 long value)

publish

void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 byte[] binary)

publish

default void publish(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 ParameterValue returnPv)

addCommand

void addCommand(PreparedCommand pc)

publishAck

default void publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 long time,
 CommandHistoryPublisher.AckStatus state)

publishAck

default void publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 long time,
 CommandHistoryPublisher.AckStatus state,
 String message)

publishAck

default void publishAck(org.yamcs.protobuf.Commanding.CommandId cmdId,
 String key,
 long time,
 CommandHistoryPublisher.AckStatus state,
 String message,
 ParameterValue returnPv)

Publish an acknowledgement status to the command history.

Three entries (corresponding to command history columns) are created:

• key_Time
• key_Status
• key_Message

commandFailed

default void commandFailed(org.yamcs.protobuf.Commanding.CommandId cmdId,
 long time,
 String reason)