Cheetah - SKA - PSS - Prototype Time Domain Search Pipeline
Public Types | Public Member Functions | Protected Member Functions | List of all members
ska::cheetah::rcpt::Config Class Reference

configurable parameters for the rcpt More...

#include <cheetah/rcpt/Config.h>

Inheritance diagram for ska::cheetah::rcpt::Config:
Inheritance graph
Collaboration diagram for ska::cheetah::rcpt::Config:
Collaboration graph

Public Types

typedef panda::ProcessingEngine Engine
 
- Public Types inherited from ska::cheetah::utils::Config
typedef System SystemType
 
typedef panda::PoolManager< SystemTypePoolManagerType
 
typedef PoolManagerType::PoolType PoolType
 

Public Member Functions

boost::asio::ip::udp::endpoint remote_end_point () const
 geters and setters for the UDP connection (IP address and port or remote peer)
 
void remote_end_point (boost::asio::ip::udp::endpoint const &endpoint)
 
Engine & engine () const
 
unsigned samples_per_chunk () const
 return the number of time samples in a chunk
 
void samples_per_chunk (unsigned samples)
 setthe number of time samples in a chunk
 
unsigned number_of_channels () const
 return the number of channels in a chunk
 
void number_of_channels (unsigned samples)
 setthe number of channels in a chunk NOTE that this has to correspond to the number actually being sent
 
std::size_t max_buffers () const
 return the maximum number of UDP packet buffers to use More...
 
- Public Member Functions inherited from ska::cheetah::utils::Config
 Config (std::string module_name)
 
void terminate () const
 call for notifiers to indicate a termination condition More...
 

Protected Member Functions

void add_options (OptionsDescriptionEasyInit &add_options) override
 

Detailed Description

configurable parameters for the rcpt

Definition at line 42 of file Config.h.

Member Function Documentation

◆ max_buffers()

std::size_t ska::cheetah::rcpt::Config::max_buffers ( ) const

return the maximum number of UDP packet buffers to use

must be at least 1

Definition at line 93 of file Config.cpp.

94 {
95  return _max_buffer_count;
96 }

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