Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Classes | Public Member Functions | Static Public Member Functions | List of all members
ska::cheetah::rcpt::BeamFormerPacket< PayloadSize > Class Template Reference
Collaboration diagram for ska::cheetah::rcpt::BeamFormerPacket< PayloadSize >:
Collaboration graph

Public Member Functions

void packet_count (uint64_t)
 set the counter in the header More...
 
void packet_type (PacketType const)
 set the type of packet
 
PacketType packet_type () const
 retunr the packet type
 
uint64_t packet_count () const
 get the counter info from header
 
void insert (std::size_t sample_number, Sample s)
 insert a sample
 
Sample const & sample (std::size_t sample) const
 return the named sample
 
const Samplebegin () const
 
const Sampleend () const
 
uint16_t first_channel_number () const
 the number of the fitst channel in the packet
 
void first_channel_number (uint16_t number)
 

Static Public Member Functions

static constexpr std::size_t header_size ()
 the total size of the udp packets header
 
static constexpr std::size_t footer_size ()
 the total size of the udp packets footer
 
static constexpr std::size_t payload_size ()
 the total size in bytes of the channel rcpt
 
static constexpr std::size_t number_of_samples ()
 the total number of samples in the rcpt payload
 
static std::size_t number_of_channels ()
 the total number of frequencey channels in the rcpt payload
 
static constexpr std::size_t size ()
 the total size of the packet (header + payload + footer)
 
static constexpr uint64_t max_sequence_number ()
 return the maximum value the packet_count can take
 

Detailed Description

template<std::size_t PayloadSize = 8192>
class ska::cheetah::rcpt::BeamFormerPacket< PayloadSize >

Definition at line 47 of file BeamFormerPacket.h.

Member Function Documentation

◆ packet_count()

template<std::size_t PayloadSize>
void ska::cheetah::rcpt::BeamFormerPacket< PayloadSize >::packet_count ( uint64_t  packet_count)

set the counter in the header

this is stored as a 48bit unsigned integer anything larger than this passed will have the 48bit modulo applied modulo

Definition at line 86 of file BeamFormerPacket.cpp.

87 {
88  _header._counter = static_cast<boost::endian::little_uint64_t>(packet_count);
89 }
uint64_t packet_count() const
get the counter info from header

The documentation for this class was generated from the following files: