Package org.yamcs.client
Class Command
java.lang.Object
org.yamcs.client.Command
- All Implemented Interfaces:
Comparable<Command>
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionint
boolean
getAcknowledgment
(String name) All acknowledgments by name<T> T
getAttribute
(String key) Returns all attributes of this commands.byte[]
Binary representation of the commandReturns command records that capture state of upstream (cascaded) servers.getError()
Error message in case this command failedReturns non-standard attributesgetId()
getName()
Fully qualified command nameAlias under the specified namespace.getQueue()
The assigned command queueint
String representation of the commandbyte[]
Unprocessed binary representation of the command (prior to postprocessing).Username of the issuerint
hashCode()
boolean
Returns whether this command is complete.boolean
Returns true if this command failedboolean
Returns true if this command has completed successfullyvoid
void
toString()
-
Constructor Details
-
Command
-
Command
-
Command
-
-
Method Details
-
getId
-
getGenerationTime
-
getName
Fully qualified command name -
getName
Alias under the specified namespace. Returnsnull
if this command has no such alias. -
getAssignments
-
getOrigin
-
getSequenceNumber
public int getSequenceNumber() -
getUsername
Username of the issuer -
getQueue
The assigned command queue -
getSource
String representation of the command -
getUnprocessedBinary
public byte[] getUnprocessedBinary()Unprocessed binary representation of the command (prior to postprocessing). -
getBinary
public byte[] getBinary()Binary representation of the command -
getAttribute
-
isComplete
public boolean isComplete()Returns whether this command is complete. A command can be complete, yet still failed. -
isSuccess
public boolean isSuccess()Returns true if this command has completed successfully -
isFailure
public boolean isFailure()Returns true if this command failed -
getError
Error message in case this command failed -
getComment
-
getAttributes
Returns all attributes of this commands. -
merge
-
merge
-
getExtraAttributes
Returns non-standard attributes -
getAcknowledgments
All acknowledgments by name -
getQueuedAcknowledgment
-
getReleasedAcknowledgment
-
getSentAcknowledgment
-
getAcknowledgment
-
getCascadedRecords
Returns command records that capture state of upstream (cascaded) servers.The returned map is keyed by the cascading prefix, for example:
yamcs<SERVER1>_
when the information is cascaded from SERVER1, oryamcs<SERVER2>_yamcs<SERVER1>_
when the information is cascaded from SERVER 1 over SERVER2. -
compareTo
- Specified by:
compareTo
in interfaceComparable<Command>
-
equals
-
hashCode
public int hashCode() -
toString
-