dp3::steps::WSCleanWriter Class Reference

#include <WSCleanWriter.h>

Inheritance diagram for dp3::steps::WSCleanWriter:

Public Member Functions
	WSCleanWriter (const common::ParameterSet &parset, const std::string &prefix)
	~WSCleanWriter ()
void	finish () override
	Finish the processing of this step and subsequent steps. More...
common::Fields	getRequiredFields () const override
	Get the fields required by the current step. More...
bool	process (std::unique_ptr< base::DPBuffer > buffer) override
void	show (std::ostream &os) const override
	Show the step parameters. More...
void	showTimings (std::ostream &os, double duration) const override
void	updateInfo (const base::DPInfo &info_obj) override
Public Member Functions inherited from dp3::steps::OutputStep
const dp3::common::Fields &	GetFieldsToWrite () const
common::Fields	getProvidedFields () const override
virtual void	SetFieldsToWrite (const dp3::common::Fields &fields)
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...
virtual bool	process (std::unique_ptr< base::BdaBuffer >)
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

Public Attributes
const common::Fields	kRequiredFields

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 ()

Constructor & Destructor Documentation

WSCleanWriter()

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

explicit

~WSCleanWriter()

dp3::steps::WSCleanWriter::~WSCleanWriter

(

)

Member Function Documentation

finish()

void dp3::steps::WSCleanWriter::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getRequiredFields()

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

inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

process()

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

overridevirtual

Process the data. When processed, the step should invoke the process function of the next step with the same buffer as argument.

Returns

False at the end of the input. True if there is more input.

Reimplemented from dp3::steps::Step.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings. The default implementation does nothing.

Reimplemented from dp3::steps::Step.

updateInfo()

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

overridevirtual

Update the general info (called by setInfo). The default implementation copies the info.

Reimplemented from dp3::steps::Step.

Member Data Documentation

kRequiredFields

const common::Fields dp3::steps::WSCleanWriter::kRequiredFields

Initial value:

=
      kDataField | kFlagsField | kWeightsField | kUvwField

---

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

• WSCleanWriter.h