echomap::DFTResult Class Reference

Denotes a completed DFT computation from a DFTTask. More...

#include <DFTResult.hpp>

Public Member Functions
	DFTResult (id_type source_id, std::unique_ptr< FrequencySpectrum > spectrum, std::size_t transform_size)
	DFTResult (const DFTResult &)=delete
DFTResult &	operator= (const DFTResult &)=delete
	DFTResult (DFTResult &&) noexcept
DFTResult &	operator= (DFTResult &&) noexcept
std::unique_ptr< FrequencySpectrum >	take_spectrum () &&noexcept
const FrequencySpectrum *	observe_spectrum () const noexcept
id_type	get_source_id () const noexcept
std::size_t	get_transform_size () const noexcept

Private Attributes
id_type	source_id
std::unique_ptr< FrequencySpectrum >	spectrum
std::size_t	transform_size

Detailed Description

Denotes a completed DFT computation from a DFTTask.

Definition at line 26 of file DFTResult.hpp.

Constructor & Destructor Documentation

DFTResult()

echomap::DFTResult::DFTResult ( id_type source_id, std::unique_ptr< FrequencySpectrum > spectrum, std::size_t transform_size )

explicit

Definition at line 17 of file DFTResult.cpp.

  :
    source_id(source_id),
    spectrum(std::move(spectrum)),
    transform_size(transform_size)
{
    assert(this->spectrum != nullptr);
}

Member Function Documentation

get_source_id()

id_type echomap::DFTResult::get_source_id ( ) const

nodiscardnoexcept

Definition at line 45 of file DFTResult.cpp.

{
    return source_id;
}

get_transform_size()

std::size_t echomap::DFTResult::get_transform_size ( ) const

nodiscardnoexcept

Definition at line 50 of file DFTResult.cpp.

{
    return transform_size;
}

observe_spectrum()

const FrequencySpectrum * echomap::DFTResult::observe_spectrum ( ) const

nodiscardnoexcept

Definition at line 40 of file DFTResult.cpp.

{
    return spectrum.get();
}

take_spectrum()

std::unique_ptr< FrequencySpectrum > echomap::DFTResult::take_spectrum ( ) &&

nodiscardnoexcept

Definition at line 35 of file DFTResult.cpp.

{
    return std::move(spectrum);
}

Member Data Documentation

source_id

id_type echomap::DFTResult::source_id

private

Definition at line 49 of file DFTResult.hpp.

spectrum

std::unique_ptr<FrequencySpectrum> echomap::DFTResult::spectrum

private

Definition at line 50 of file DFTResult.hpp.

transform_size

std::size_t echomap::DFTResult::transform_size

private

Definition at line 51 of file DFTResult.hpp.

---

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

• src/async/results/DFTResult.hpp
• src/async/results/DFTResult.cpp