pulp::signal::ScopeCaptureT< SampleType, MaxSamples > Class Template Reference

#include <scope_capture.hpp>

Public Types
using	Frame = ScopeCaptureFrameT<SampleType, MaxSamples>

Public Member Functions
	ScopeCaptureT () noexcept
bool	configure (const ScopeCaptureConfig &config) noexcept
	Control-thread operation. Invalid configurations leave all state intact.
void	reset () noexcept
void	arm () noexcept
	Arms a one-shot capture without discarding accumulated pretrigger history.
void	process (std::span< const SampleType > input) noexcept
bool	capture_ready () const noexcept
bool	armed () const noexcept
bool	capturing () const noexcept
const Frame &	capture () const noexcept
	Same-thread view. This reference is not a concurrent publication API.
const ScopeCaptureConfig &	config () const noexcept
std::uint64_t	samples_seen () const noexcept
std::uint64_t	holdoff_remaining () const noexcept
std::size_t	capture_completion_latency_samples () const noexcept

Member Typedef Documentation

Frame

template<typename SampleType = float, std::size_t MaxSamples = 8192>

using pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::Frame = ScopeCaptureFrameT<SampleType, MaxSamples>

Constructor & Destructor Documentation

ScopeCaptureT()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::ScopeCaptureT ( )

inlinenoexcept

Member Function Documentation

arm()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

void pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::arm ( )

inlinenoexcept

Arms a one-shot capture without discarding accumulated pretrigger history.

armed()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

bool pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::armed ( ) const

inlinenodiscardnoexcept

capture()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

const Frame & pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::capture ( ) const

inlinenodiscardnoexcept

Same-thread view. This reference is not a concurrent publication API.

capture_completion_latency_samples()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

std::size_t pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::capture_completion_latency_samples ( ) const

inlinenodiscardnoexcept

capture_ready()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

bool pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::capture_ready ( ) const

inlinenodiscardnoexcept

capturing()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

bool pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::capturing ( ) const

inlinenodiscardnoexcept

config()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

const ScopeCaptureConfig & pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::config ( ) const

inlinenodiscardnoexcept

configure()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

bool pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::configure ( const ScopeCaptureConfig & config )

inlinenodiscardnoexcept

Control-thread operation. Invalid configurations leave all state intact.

holdoff_remaining()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

std::uint64_t pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::holdoff_remaining ( ) const

inlinenodiscardnoexcept

process()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

void pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::process ( std::span< const SampleType > input )

inlinenoexcept

reset()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

void pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::reset ( )

inlinenoexcept

samples_seen()

template<typename SampleType = float, std::size_t MaxSamples = 8192>

std::uint64_t pulp::signal::ScopeCaptureT< SampleType, MaxSamples >::samples_seen ( ) const

inlinenodiscardnoexcept

---

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

• /home/runner/work/pulp/pulp/core/signal/include/pulp/signal/scope_capture.hpp