Module org.yamcs.core

Package org.yamcs.algo

Class RemainingBinaryDecoder

java.lang.Object

org.yamcs.mdb.AbstractDataDecoder

org.yamcs.algo.RemainingBinaryDecoder

All Implemented Interfaces:

AlgorithmExecutor, DataDecoder

public class RemainingBinaryDecoder
extends AbstractDataDecoder

A decoder that returns a binary value containing all of the remaining bytes.

An example where this may be useful is a packet that contains an arbitrarily sized blob of data with no length indication.

The following XTCE snippet illustrates intended usage.

 <BinaryParameterType name="outputData">
   <BinaryDataEncoding>
     <SizeInBits>
       <DynamicValue>
         <ParameterInstanceRef parameterRef="_yamcs_ignore"/>
       </DynamicValue>
     </SizeInBits>
     <FromBinaryTransformAlgorithm name="org_yamcs_algo_RemainingBinaryDecoder">
       <AlgorithmText language="java">org.yamcs.algo.RemainingBinaryDecoder</AlgorithmText>
     </FromBinaryTransformAlgorithm>
   </BinaryDataEncoding>
 </BinaryParameterType>
 

Constructor Summary

Constructors

Constructor	Description
RemainingBinaryDecoder(org.yamcs.xtce.CustomAlgorithm alg, AlgorithmExecutionContext ctx)

Method Summary

Modifier and Type	Method	Description
Value	extractRaw(org.yamcs.xtce.DataEncoding de, ContainerProcessingContext pcontext, BitBuffer buffer)	Extracts the raw value from the buffer.

Methods inherited from class org.yamcs.mdb.AbstractDataDecoder

addExecListener, execute, getAlgorithm, getExecutionContext, removeExecListener, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.yamcs.algorithms.AlgorithmExecutor

dispose, getInputList, getOutputList

Constructor Details

RemainingBinaryDecoder

public RemainingBinaryDecoder(org.yamcs.xtce.CustomAlgorithm alg,
 AlgorithmExecutionContext ctx)

Method Details

extractRaw

public Value extractRaw(org.yamcs.xtce.DataEncoding de,
 ContainerProcessingContext pcontext,
 BitBuffer buffer)

Description copied from interface: DataDecoder

Extracts the raw value from the buffer. The offset inside the buffer shall be moved to the end of the parameter