C++ API

The ska-pst library provides and API that is used by the applications. This API is described below.

Full API

Classes and Structs

Template Struct Endian
- Struct Documentation

Template Struct Endian< std::uint16_t >
- Struct Documentation

Template Struct Endian< std::uint32_t >
- Struct Documentation

Template Struct Endian< uint64_t >
- Struct Documentation

Struct Timer::start_epoch
- Nested Relationships
- Struct Documentation

Struct DiskManager::stats
- Nested Relationships
- Struct Documentation

Struct FlowThroughManager::stats
- Nested Relationships
- Struct Documentation

Struct cbf_psr_header
- Struct Documentation

Struct cbf_psr_packet
- Struct Documentation

Struct db_accounting
- Struct Documentation

Struct ibv_slot
- Struct Documentation

Struct UDPFormat::data_and_weights
- Nested Relationships
- Struct Documentation

Struct UDPSocket::other_udp_sock
- Nested Relationships
- Struct Documentation

Struct UDPSocket::udp_sock
- Nested Relationships
- Struct Documentation

Struct DataBlockStats::stats
- Nested Relationships
- Struct Documentation

Struct stat_hdf5_header
- Struct Documentation

Struct StatStorage
- Nested Relationships
  - Nested Types
- Struct Documentation

Struct StatStorage::scalar_stats_t
- Nested Relationships
- Struct Documentation

Class ApplicationManager
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class AsciiHeader
- Class Documentation

Class BlockProducer

Class BlockProducer::Block
- Nested Relationships
- Class Documentation

Class BlockSegmentProducer
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class DataUnpacker
- Class Documentation

Class EthernetFrame
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FileBlockProducer
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FileReader
- Class Documentation

Class FileSegmentProducer
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FileWriter
- Class Documentation

Class GaussianNoiseGenerator
- Inheritance Relationships
  - Base Type
  - Derived Type
- Class Documentation

Class HeapLayout
- Nested Relationships
  - Nested Types
- Class Documentation

Class HeapLayout::PacketLayout

Class IPv4Packet
- Inheritance Relationships
  - Base Type
- Class Documentation

Class LmcService
- Inheritance Relationships
  - Base Type
- Class Documentation

Class LmcServiceException
- Inheritance Relationships
  - Base Type
- Class Documentation

Class LmcServiceHandler
- Inheritance Relationships
  - Derived Types
- Class Documentation

Class NormalSequence
- Class Documentation

Class PacketBuffer
- Inheritance Relationships
  - Derived Types
- Class Documentation

Class PacketCaptureFile
- Inheritance Relationships
  - Base Type
- Class Documentation

Class PacketGenerator
- Inheritance Relationships
  - Derived Types
- Class Documentation

Class PacketLayout
- Inheritance Relationships
  - Derived Types
- Class Documentation

Class pst_state_transition_error
- Inheritance Relationships
  - Base Type
- Class Documentation

Class pst_validation_error
- Inheritance Relationships
  - Base Type
- Class Documentation

Class RandomDataGenerator
- Inheritance Relationships
  - Base Type
- Class Documentation

Class RandomSequence
- Class Documentation

Class ScaleWeightGenerator
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class SegmentGenerator
- Inheritance Relationships
  - Base Type
- Class Documentation

Class SegmentProducer

Class SegmentProducer::Segment
- Nested Relationships
- Class Documentation

Class SineWaveGenerator
- Inheritance Relationships
  - Base Type
- Class Documentation

Class SquareWaveGenerator
- Inheritance Relationships
  - Base Type
- Class Documentation

Class StateModel
- Inheritance Relationships
  - Derived Type
- Class Documentation

Class Time
- Class Documentation

Class Timer
- Nested Relationships
  - Nested Types
- Class Documentation

Class UDPPacket
- Inheritance Relationships
  - Base Type
- Class Documentation

Template Class UniformSequence
- Class Documentation

Class ValidationContext
- Class Documentation

Class CUDAUtils
- Class Documentation

Class DiskManager

Class DiskMonitor
- Inheritance Relationships
  - Base Type
- Class Documentation

Class DspDiskLmcServiceHandler
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FlowThroughLmcServiceHandler
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FlowThroughManager

Class StreamWriter
- Inheritance Relationships
  - Base Type
- Class Documentation

Class IBVCompletionQueue
- Class Documentation

Class IBVFlow
- Class Documentation

Class IBVMemoryRegion
- Class Documentation

Class IBVProtectionDomain
- Class Documentation

Class IBVQueue
- Inheritance Relationships
  - Base Type
- Class Documentation

Class IBVQueuePair
- Class Documentation

Class LowPST
- Inheritance Relationships
  - Base Type
- Class Documentation

Class LowTestVector
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MidPST
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class MidPSTBand1
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MidPSTBand2
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MidPSTBand3
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MidPSTBand4
- Inheritance Relationships
  - Base Type
- Class Documentation

Class MidPSTBand5
- Inheritance Relationships
  - Base Type
- Class Documentation

Class RDMACommunicationManager
- Class Documentation

Class RDMAEventChannel
- Class Documentation

Class Receiver
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class RecvLmcServiceHandler
- Inheritance Relationships
  - Base Type
- Class Documentation

Class Socket
- Inheritance Relationships
  - Derived Type
- Class Documentation

Class SocketReceive
- Inheritance Relationships
  - Derived Types
- Class Documentation

Class UDPFormat

Class UDPGenerator
- Class Documentation

Class UDPHeader
- Class Documentation

Class UDPReceiveDB
- Inheritance Relationships
  - Base Type
- Class Documentation

Class UDPReceiver
- Inheritance Relationships
  - Base Type
- Class Documentation

Class UDPSocket

Class UDPSocketReceive
- Inheritance Relationships
  - Base Types
- Class Documentation

Class UDPSocketSend
- Inheritance Relationships
  - Base Type
- Class Documentation

Class UDPStats
- Class Documentation

Class DataBlock
- Inheritance Relationships
  - Derived Types
- Class Documentation

Class DataBlockAccessor
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation

Class DataBlockCreate
- Inheritance Relationships
  - Base Type
- Class Documentation

Class DataBlockManager
- Inheritance Relationships
  - Base Type
- Class Documentation

Class DataBlockRead
- Inheritance Relationships
  - Base Type
- Class Documentation

Class DataBlockStats
- Nested Relationships
  - Nested Types
- Class Documentation

Class DataBlockView
- Inheritance Relationships
  - Base Type
- Class Documentation

Class DataBlockWrite
- Inheritance Relationships
  - Base Type
- Class Documentation

Class SmrbBlockProducer
- Inheritance Relationships
  - Base Type
- Class Documentation

Class SmrbLmcServiceHandler
- Inheritance Relationships
  - Base Type
- Class Documentation

Class SmrbSegmentProducer
- Inheritance Relationships
  - Base Type
- Class Documentation

Class FileProcessor
- Class Documentation

Class ScalarStatPublisher
- Inheritance Relationships
  - Base Type
- Class Documentation

Class StatApplicationManager
- Inheritance Relationships
  - Base Type
- Class Documentation

Class StatComputer
- Class Documentation

Class StatFilenameConstructor
- Class Documentation

Class StatHdf5FileWriter
- Inheritance Relationships
  - Base Type
- Class Documentation

Class StatLmcServiceHandler
- Inheritance Relationships
  - Base Type
- Class Documentation

Class StatProcessor
- Class Documentation

Class StatPublisher
- Inheritance Relationships
  - Derived Types
- Class Documentation

Enums

Enum Command
- Enum Documentation

Enum State
- Enum Documentation

Enum FailureType
- Enum Documentation

Enum State
- Enum Documentation

Functions

Function pst_isfinite
- Function Documentation

Template Function ska::pst::common::betoh
- Function Documentation

Function ska::pst::common::get_lmclog_level
- Function Documentation

Function ska::pst::common::get_spdlog_level
- Function Documentation

Function ska::pst::common::get_supported_data_generators
- Function Documentation

Function ska::pst::common::get_supported_data_generators_list
- Function Documentation

Function ska::pst::common::get_version_string
- Function Documentation

Template Function ska::pst::common::htobe
- Function Documentation

Function ska::pst::common::interface_mac
- Function Documentation

Function ska::pst::common::operator””_exa(unsigned long long)
- Function Documentation

Function ska::pst::common::operator””_exa(long double)
- Function Documentation

Function ska::pst::common::operator””_giga(unsigned long long)
- Function Documentation

Function ska::pst::common::operator””_giga(long double)
- Function Documentation

Function ska::pst::common::operator””_kilo(unsigned long long)
- Function Documentation

Function ska::pst::common::operator””_kilo(long double)
- Function Documentation

Function ska::pst::common::operator””_mega(unsigned long long)
- Function Documentation

Function ska::pst::common::operator””_mega(long double)
- Function Documentation

Function ska::pst::common::operator””_peta(unsigned long long)
- Function Documentation

Function ska::pst::common::operator””_peta(long double)
- Function Documentation

Function ska::pst::common::operator””_tera(unsigned long long)
- Function Documentation

Function ska::pst::common::operator””_tera(long double)
- Function Documentation

Function ska::pst::common::operator==
- Function Documentation

Function ska::pst::common::PacketGeneratorFactory
- Function Documentation

Function ska::pst::common::setup_spdlog
- Function Documentation

Function ska::pst::common::udp_from_ethernet
- Function Documentation

Function ska::pst::recv::__attribute__
- Function Documentation

Function ska::pst::recv::configure_packet_defaults
- Function Documentation

Function ska::pst::recv::get_failure_type
- Function Documentation

Function ska::pst::recv::get_scale1_byte_offset
- Function Documentation

Function ska::pst::recv::get_supported_formats
- Function Documentation

Function ska::pst::recv::get_supported_formats_list
- Function Documentation

Function ska::pst::recv::is_format_supported
- Function Documentation

Function ska::pst::recv::print_packet_header
- Function Documentation

Function ska::pst::recv::UDPFormatFactory
- Function Documentation

Function ska::pst::recv::validate_packet_header
- Function Documentation

Variables

Variable beam_number
- Variable Documentation

Variable cbf_version_major
- Variable Documentation

Variable cbf_version_minor
- Variable Documentation

Variable channel_separation
- Variable Documentation

Variable channels_per_packet
- Variable Documentation

Variable data_precision
- Variable Documentation

Variable first_channel_freq
- Variable Documentation

Variable first_channel_number
- Variable Documentation

Variable magic_word
- Variable Documentation

Variable num_power_samples_averaged
- Variable Documentation

Variable num_time_samples_per_relative_weight
- Variable Documentation

Variable offset_1
- Variable Documentation

Variable offset_2
- Variable Documentation

Variable offset_3
- Variable Documentation

Variable offset_4
- Variable Documentation

Variable os_ratio_denominator
- Variable Documentation

Variable os_ratio_numerator
- Variable Documentation

Variable packet_destination
- Variable Documentation

Variable packet_sequence_number
- Variable Documentation

Variable scale_1
- Variable Documentation

Variable scale_2
- Variable Documentation

Variable scale_3
- Variable Documentation

Variable scale_4
- Variable Documentation

Variable scan_id
- Variable Documentation

Variable ska::pst::common::allowed_commands
- Variable Documentation

Variable ska::pst::common::attoseconds_per_microsecond
- Variable Documentation

Variable ska::pst::common::attoseconds_per_picosecond
- Variable Documentation

Variable ska::pst::common::attoseconds_per_second
- Variable Documentation

Variable ska::pst::common::bits_per_byte
- Variable Documentation

Variable ska::pst::common::bits_per_float
- Variable Documentation

Variable ska::pst::common::bytes_per_gigabyte
- Variable Documentation

Variable ska::pst::common::bytes_per_megabyte
- Variable Documentation

Variable ska::pst::common::command_names
- Variable Documentation

Variable ska::pst::common::deciseconds_per_second
- Variable Documentation

Variable ska::pst::common::default_kernel_socket_bufsz
- Variable Documentation

Variable ska::pst::common::gigabits_per_byte
- Variable Documentation

Variable ska::pst::common::hundred_milliseconds
- Variable Documentation

Variable ska::pst::common::ideal_kernel_socket_bufsz
- Variable Documentation

Variable ska::pst::common::kilohertz_per_megahertz
- Variable Documentation

Variable ska::pst::common::log_level_map
- Variable Documentation

Variable ska::pst::common::message
- Variable Documentation

Variable ska::pst::common::microseconds_per_decisecond
- Variable Documentation

Variable ska::pst::common::microseconds_per_millisecond
- Variable Documentation

Variable ska::pst::common::microseconds_per_second
- Variable Documentation

Variable ska::pst::common::millihertz_per_megahertz
- Variable Documentation

Variable ska::pst::common::milliseconds_per_second
- Variable Documentation

Variable ska::pst::common::packet_weights_resolution
- Variable Documentation

Variable ska::pst::common::percentiles_per_100
- Variable Documentation

Variable ska::pst::common::receive_buffer_size
- Variable Documentation

Variable ska::pst::common::seconds_per_microseconds
- Variable Documentation

Variable ska::pst::common::state_names
- Variable Documentation

Variable ska::pst::common::value
- Variable Documentation

Variable ska::pst::common::weights_nbit
- Variable Documentation

Variable ska::pst::recv::magic_word
- Variable Documentation

Variable ska::pst::recv::MALFORMED_PACKET
- Variable Documentation

Variable ska::pst::recv::NO_PACKET
- Variable Documentation

Variable ska::pst::recv::VALID_IGNORED_PACKET
- Variable Documentation

Variable time_samples_per_packet
- Variable Documentation

Variable timestamp_attoseconds
- Variable Documentation

Variable timestamp_seconds
- Variable Documentation

Variable valid_channels_per_packet
- Variable Documentation

Defines

Define INIT_CBF_PST_HEADER_T
- Define Documentation

Define INIT_DB_ACCOUNTING_T
- Define Documentation

Define MJD_1970_01_01
- Define Documentation

Define MJD_TO_UNIX_TIME
- Define Documentation

Define SKA_LOGGING_FORMAT
- Define Documentation

Define SKA_PST_COMMON_UTILS_AsciiHeader_h
- Define Documentation

Define SKA_PST_COMMON_UTILS_PacketGenerator_h
- Define Documentation

Define SKA_PST_RECV_MAX_UDP_PORT
- Define Documentation

Define SKA_PST_RECV_MIN_UDP_PORT
- Define Documentation

Define SKA_PST_RECV_NETWORK_IBVSocket_h
- Define Documentation

Define SKA_PST_RECV_NETWORK_UDPSocket_h
- Define Documentation

Define STRUCT_TM_INIT
- Define Documentation

Define UDP_FORMAT_CBFPSR_LOW_PSS
- Define Documentation

Define UDP_FORMAT_CBFPSR_LOW_PST
- Define Documentation

Define UDP_FORMAT_CBFPSR_MID_PSS
- Define Documentation

Define UDP_FORMAT_CBFPSR_MID_PST
- Define Documentation

Define UDP_FORMAT_CBFPSR_NDIM
- Define Documentation

Define UDP_FORMAT_CBFPSR_NPOL
- Define Documentation

Define UDP_FORMAT_CBFPSR_WEIGHT_NBIT
- Define Documentation

Define UDP_FORMAT_MAX_BEAM
- Define Documentation

Define UDP_FORMAT_MAX_NBEAM
- Define Documentation

Define UDP_FORMAT_MIN_BEAM
- Define Documentation

Define UNIX_TIME_TO_MJD
- Define Documentation

Typedefs

Typedef ska::pst::common::ip_addr_v4
- Typedef Documentation

Typedef ska::pst::common::mac_address
- Typedef Documentation

Typedef ska::pst::common::validation_error_record_t
- Typedef Documentation

Typedef ska::pst::recv::cbf_psr_packet_t
- Typedef Documentation

Typedef ska::pst::recv::db_accounting_t
- Typedef Documentation

Typedef ska::pst::recv::ibv_slot_t
- Typedef Documentation

Typedef ska::pst::stat::stat_hdf5_header_t
- Typedef Documentation

Read the Docs v: latest

Versions: latest; stable; at3-380-rename-pst-integration-to-pst

Downloads

On Read the Docs: Project Home; Builds