dp3::steps::DummyStep Class Reference

DP3 step class that does nothing. This class is an empty Step subclass to use as implementation template. More...

#include <DummyStep.h>

Inheritance diagram for dp3::steps::DummyStep:

Public Member Functions
	DummyStep (const common::ParameterSet &, const std::string &prefix)
void	finish () override
	Finish the processing of this step and subsequent steps. More...
common::Fields	getProvidedFields () const override
common::Fields	getRequiredFields () const override
bool	process (std::unique_ptr< base::BdaBuffer >) override
	Process BDA data. The dummy step forwards the data to its next step. More...
bool	process (std::unique_ptr< base::DPBuffer >) override
	Process the data. The dummy step forwards the data to its next step. More...
void	show (std::ostream &) const override
	Show the step parameters. More...
void	showTimings (std::ostream &, double duration) const override
	Show the timings. More...
void	updateInfo (const base::DPInfo &) override
	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 class that does nothing. This class is an empty Step subclass to use as implementation template.

Constructor & Destructor Documentation

DummyStep()

dp3::steps::DummyStep::DummyStep	(	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::DummyStep::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getProvidedFields()

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

inlineoverridevirtual

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

Implements dp3::steps::Step.

getRequiredFields()

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

inlineoverridevirtual

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

Implements dp3::steps::Step.

process() [1/2]

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

overridevirtual

Process BDA data. The dummy step forwards the data to its next step.

Reimplemented from dp3::steps::Step.

process() [2/2]

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

overridevirtual

Process the data. The dummy step forwards the data to its next step.

Reimplemented from dp3::steps::Step.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateInfo()

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

overridevirtual

Update the general info.

Reimplemented from dp3::steps::Step.

---

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

• DummyStep.h