Class PacketLayout

Inheritance Relationships

Derived Types

Class Documentation

class PacketLayout

Stores the offsets and sizes of data, weights, and scales in data blocks.

Subclassed by ska::pst::common::HeapLayout::PacketLayout, ska::pst::recv::UDPFormat

Public Functions

PacketLayout() = default

Construct a new PacketLayout object.

~PacketLayout() = default

Destroy the PacketLayout object.

inline auto get_packet_size() const -> unsigned

Get the total size of the data block.

Returns

unsigned total size of data block

inline auto get_packet_header_size() const -> unsigned

Get the size of the header in each data block.

Returns

unsigned size of header block in data block

inline auto get_packet_data_size() const -> unsigned

Get the size of the data in each data block.

Returns

unsigned size of data samples in data block

inline auto get_packet_weights_size() const -> unsigned

Get the size of the weights in each data block.

Returns

unsigned size of the weights data in the data block

inline auto get_packet_scales_size() const -> unsigned

Get the size of the scale factor in each data block.

Returns

unsigned size of the scale factor in the data block

inline auto get_packet_data_offset() const -> unsigned

Get the offset of the data in each data block.

Returns

unsigned offset of data samples in data block

inline auto get_packet_weights_offset() const -> unsigned

Get the offset of the weights in each data block.

Returns

unsigned offset of the weights data in the data block

inline auto get_packet_scales_offset() const -> unsigned

Get the offset of the scales in each data block.

Returns

unsigned offset of scales in data block

inline auto get_samples_per_packet() const -> unsigned

Get the number of samples per UDP packet.

Returns

unsigned number of samples in each UDP packet

inline auto get_nchan_per_packet() const -> unsigned

Get the number of channels per UDP packet.

Returns

unsigned number of channels in each UDP packet

inline auto get_nsamp_per_weight() const -> unsigned

Get the number of samples per weight in each UDP packet.

Returns

unsigned number of samples per weight in each UDP packet

Protected Attributes

unsigned packet_size = {0}

size of the data block

unsigned packet_header_size = {0}

size of the header in each block in bytes

unsigned packet_data_size = {0}

size of the data in each block in bytes

unsigned packet_weights_size = {0}

size of the weights in each block in bytes

unsigned packet_scales_size = {0}

size of the scale factors in each block in bytes

unsigned packet_data_offset = {0}

offset from first byte of each block for the data

unsigned packet_weights_offset = {0}

offset from first byte of each block for the weights

unsigned packet_scales_offset = {0}

offset from first byte of each block for the scale factor

unsigned nsamp_per_packet = {0}

Number of samples per UDP packet.

unsigned nchan_per_packet = {0}

Number of channels per UDP packet.

unsigned nsamp_per_weight = {0}

Number of samples per relative weight.