dp3::steps::Combine Class Reference

DP3 step to combine two named buffers This class is a DP3 step to combine to named buffers. More...

#include <Combine.h>

Inheritance diagram for dp3::steps::Combine:

Public Member Functions
	Combine (const common::ParameterSet &, const std::string &prefix)
void	finish () final
	Finish the processing of this step and subsequent steps. More...
common::Fields	getProvidedFields () const final
common::Fields	getRequiredFields () const final
bool	process (std::unique_ptr< base::BdaBuffer >) final
	TODO: Process BDA data. More...
bool	process (std::unique_ptr< base::DPBuffer >) final
	Process the data. More...
void	SetOperation (const std::string &operation)
	Set operation. More...
void	show (std::ostream &) const final
	Show the step parameters. More...
void	showTimings (std::ostream &, double duration) const final
	Show the timings. More...
void	updateInfo (const base::DPInfo &) final
	Update the general info. More...
Public Member Functions inherited from dp3::steps::Step
	Step ()
virtual	~Step ()
virtual bool	accepts (MsType dt) const
	Boolean if this step can process this type of data. More...
const base::DPInfo &	getInfoIn () const
	Get access to the info of the input. More...
const base::DPInfo &	getInfoOut () const
	Get access to the info of the output. More...
const Step::ShPtr &	getNextStep () const
	Get the next step. More...
Step *	getPrevStep () const
	Get the previous step. More...
virtual MsType	outputs () const
	Return which datatype this step outputs. More...
void	setInfo (const base::DPInfo &)
virtual void	setNextStep (Step::ShPtr nextStep)
	Set the next step. More...
void	setPrevStep (Step *prevStep)
	Set the previous step. More...
virtual void	showCounts (std::ostream &) const

Additional Inherited Members
Public Types inherited from dp3::steps::Step
enum class	MsType { kRegular , kBda }
	To check compatibility between steps before running. More...
typedef std::shared_ptr< Step >	ShPtr
Static Public Member Functions inherited from dp3::steps::Step
static void	SetThreadingIsInitialized ()
Static Public Attributes inherited from dp3::steps::Step
static constexpr dp3::common::Fields	kDataField
static constexpr dp3::common::Fields	kFlagsField
static constexpr dp3::common::Fields	kUvwField
static constexpr dp3::common::Fields	kWeightsField
Protected Member Functions inherited from dp3::steps::Step
virtual void	addToMS (const std::string &msName)
base::DPInfo &	GetWritableInfoOut ()

Detailed Description

DP3 step to combine two named buffers This class is a DP3 step to combine to named buffers.

Constructor & Destructor Documentation

Combine()

dp3::steps::Combine::Combine	(	const common::ParameterSet &	,
		const std::string &	prefix
	)

Construct the object. Parameters are obtained from the parset using the given prefix.

Member Function Documentation

finish()

void dp3::steps::Combine::finish ( )

finalvirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getProvidedFields()

common::Fields dp3::steps::Combine::getProvidedFields ( ) const

inlinefinalvirtual

getProvidedFields should return all fields that process() writes. This implementation is merely an example.

Implements dp3::steps::Step.

getRequiredFields()

common::Fields dp3::steps::Combine::getRequiredFields ( ) const

inlinefinalvirtual

getRequiredFields should return all fields that process() reads. This implementation is merely an example.

Implements dp3::steps::Step.

process() [1/2]

bool dp3::steps::Combine::process ( std::unique_ptr< base::BdaBuffer >  )

finalvirtual

TODO: Process BDA data.

Reimplemented from dp3::steps::Step.

process() [2/2]

bool dp3::steps::Combine::process ( std::unique_ptr< base::DPBuffer >  )

finalvirtual

Process the data.

Reimplemented from dp3::steps::Step.

SetOperation()

void dp3::steps::Combine::SetOperation

(

const std::string &

operation

)

Set operation.

show()

void dp3::steps::Combine::show ( std::ostream &  ) const

finalvirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

void dp3::steps::Combine::showTimings ( std::ostream &  , double  duration  ) const

finalvirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateInfo()

void dp3::steps::Combine::updateInfo ( const base::DPInfo &  )

finalvirtual

Update the general info.

Reimplemented from dp3::steps::Step.

---

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

• Combine.h