echomap::DownsampleResult Class Reference

Denotes a completed for a downsampled Signal produced by a DownsampleTask job. More...

#include <DownsampleResult.hpp>

Public Member Functions
	DownsampleResult (id_type source_id, std::unique_ptr< Signal > downsampled)
	DownsampleResult (const DownsampleResult &)=delete
DownsampleResult &	operator= (const DownsampleResult &)=delete
	DownsampleResult (DownsampleResult &&) noexcept
DownsampleResult &	operator= (DownsampleResult &&) noexcept
std::unique_ptr< Signal >	take_downsampled () &&noexcept
const Signal *	observe_downsampled () const noexcept
id_type	get_source_id () const noexcept

Private Attributes
id_type	source_id
std::unique_ptr< Signal >	downsampled

Detailed Description

Denotes a completed for a downsampled Signal produced by a DownsampleTask job.

Definition at line 25 of file DownsampleResult.hpp.

Constructor & Destructor Documentation

DownsampleResult()

echomap::DownsampleResult::DownsampleResult ( id_type source_id, std::unique_ptr< Signal > downsampled )

explicit

Definition at line 17 of file DownsampleResult.cpp.

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

Member Function Documentation

get_source_id()

id_type echomap::DownsampleResult::get_source_id ( ) const

nodiscardnoexcept

Definition at line 43 of file DownsampleResult.cpp.

{
    return source_id;
}

observe_downsampled()

const Signal * echomap::DownsampleResult::observe_downsampled ( ) const

nodiscardnoexcept

Definition at line 38 of file DownsampleResult.cpp.

{
    return downsampled.get();
}

take_downsampled()

std::unique_ptr< Signal > echomap::DownsampleResult::take_downsampled ( ) &&

nodiscardnoexcept

Definition at line 33 of file DownsampleResult.cpp.

{
    return std::move(downsampled);
}

Member Data Documentation

downsampled

std::unique_ptr<Signal> echomap::DownsampleResult::downsampled

private

Definition at line 47 of file DownsampleResult.hpp.

source_id

id_type echomap::DownsampleResult::source_id

private

Definition at line 46 of file DownsampleResult.hpp.

---

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

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