Application Programming Interface

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

Class Hierarchy

• • Namespace ska
    • Namespace ska::pst
      • Namespace ska::pst::common
        • Namespace ska::pst::common::detail
          • Template Struct Endian
          • Template Struct Endian< std::uint16_t >
          • Template Struct Endian< std::uint32_t >
          • Template Struct Endian< uint64_t >
        • Class ApplicationManager
        • Class AsciiHeader
        • Class BlockProducer
          • Class BlockProducer::Block
        • Class BlockSegmentProducer
        • Class DataUnpacker
        • Class FileBlockProducer
        • Class FileReader
        • Class FileSegmentProducer
        • Class FileWriter
        • Class GaussianNoiseGenerator
        • Class HeapLayout
          • Class HeapLayout::PacketLayout
        • Class LmcService
        • Class LmcServiceException
        • Class LmcServiceHandler
        • Class NormalSequence
        • Class PacketGenerator
        • Class PacketLayout
        • Class pst_state_transition_error
        • Class pst_validation_error
        • Class RandomDataGenerator
        • Class RandomSequence
        • Class ScaleWeightGenerator
        • Class SegmentGenerator
        • Class SegmentProducer
          • Class SegmentProducer::Segment
        • Class SineWaveGenerator
        • Class SquareWaveGenerator
        • Class StateModel
        • Class Time
        • Class Timer
          • Struct Timer::start_epoch
        • Template Class UniformSequence
        • Class ValidationContext
        • Enum Command
        • Enum State

Full API

Namespaces

• Namespace ska
  • Namespaces

• Namespace ska::pst
  • Namespaces

• Namespace ska::pst::common
  • Namespaces
  • Classes
  • Enums
  • Functions
  • Typedefs
  • Variables

• Namespace ska::pst::common::detail
  • Classes

• Namespace ska::pst::lmc
  • Namespaces

• Namespace ska::pst::lmc::PstLmcService

• Namespace std

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

• Class ApplicationManager
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class AsciiHeader
  • Class Documentation

• Class BlockProducer
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class BlockProducer::Block
  • Nested Relationships
  • Class Documentation

• Class BlockSegmentProducer
  • Inheritance Relationships
    • Base Type
    • Derived Type
  • Class Documentation

• Class DataUnpacker
  • 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
  • Nested Relationships
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class LmcService
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class LmcServiceException
  • Inheritance Relationships
    • Base Type
  • Class Documentation

• Class LmcServiceHandler
  • Class Documentation

• Class NormalSequence
  • Class Documentation

• Class PacketGenerator
  • Inheritance Relationships
    • Derived Type
  • Class Documentation

• Class PacketLayout
  • Inheritance Relationships
    • Derived Type
  • 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
  • Nested Relationships
    • Nested Types
  • Inheritance Relationships
    • Derived Types
  • Class Documentation

• 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

• Template Class UniformSequence
  • Class Documentation

• Class ValidationContext
  • Class Documentation

Enums

• Enum Command
  • Enum Documentation

• Enum State
  • Enum Documentation

Functions

• 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::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

Variables

• 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::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::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

Defines

• 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 STRUCT_TM_INIT
  • Define Documentation

• Define UNIX_TIME_TO_MJD
  • Define Documentation

Typedefs

• Typedef ska::pst::common::validation_error_record_t
  • Typedef Documentation