TmTransferFrame (Yamcs :: Core 5.2.4 API)

java.lang.Object
- org.yamcs.tctm.ccsds.DownlinkTransferFrame
- - org.yamcs.tctm.ccsds.TmTransferFrame

public class TmTransferFrame
extends DownlinkTransferFrame

Field Summary
- Fields inherited from class org.yamcs.tctm.ccsds.DownlinkTransferFrame
  data, spacecraftId, virtualChannelId

Constructor Summary

Constructors
Constructor Description

TmTransferFrame(byte[] data, int spacecraftId, int virtualChannelId)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`containsOnlyIdleData()`
`int`	`getShLength()`	Return the length of the secondary header in bytes
`int`	`getShStart()`
`void`	`setShLength(int length)`	Set secondary header length in bytes
`void`	`setShStart(int offset)`	Set secondary header start offset.
`String`	`toString()`

Methods inherited from class org.yamcs.tctm.ccsds.DownlinkTransferFrame
getData, getDataEnd, getDataStart, getEarthRceptionTime, getFirstHeaderPointer, getOcf, getSpacecraftId, getVcFrameSeq, getVirtualChannelId, hasOcf, lostFramesCount, setEearthRceptionTime, setOcf, setVcFrameSeq

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TmTransferFrame
```
public TmTransferFrame(byte[] data,
                       int spacecraftId,
                       int virtualChannelId)
```
- Method Detail
  - containsOnlyIdleData
```
public boolean containsOnlyIdleData()
```
  - getShStart
```
public int getShStart()
```
    Returns:
    
    the start offset of the secondary header or -1 if the frame does not have a secondary header
  - setShStart
```
public void setShStart(int offset)
```
    Set secondary header start offset. Set to -1 if the frame does not contain a secondary header
    
    Parameters:
    
    offset -
  - getShLength
```
public int getShLength()
```
    Return the length of the secondary header in bytes
    
    Returns:
  - setShLength
```
public void setShLength(int length)
```
    Set secondary header length in bytes
    
    Parameters:
    
    length -
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object