dp3::steps::MSUpdater Class Reference

DP3 step writing to an MS. More...

#include <MSUpdater.h>

Inheritance diagram for dp3::steps::MSUpdater:

Public Member Functions
	MSUpdater (std::string msName, const common::ParameterSet &parset, const std::string &prefix, bool writeHistory=true)
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	SetFieldsToWrite (const common::Fields &fields) override
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::OutputStep
const dp3::common::Fields &	GetFieldsToWrite () const
common::Fields	getProvidedFields () const override
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

Static Public Member Functions
static bool	updateAllowed (const base::DPInfo &info, casacore::String msName, bool throwError=true)
Static Public Member Functions inherited from dp3::steps::Step
static void	SetThreadingIsInitialized ()

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 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 writing to an MS.

This class updates the flags in an existing MeasurementSet. Hardly anything is done in this class. It uses function putFlags in MsReader to do the actual write. Like MSWriter it adds an entry to the HISTORY table of the MS containing the parset values and DPPP version.

Constructor & Destructor Documentation

MSUpdater()

dp3::steps::MSUpdater::MSUpdater ( std::string  msName, const common::ParameterSet &  parset, const std::string &  prefix, bool  writeHistory = true  )

explicit

Member Function Documentation

finish()

void dp3::steps::MSUpdater::finish ( )

overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

getRequiredFields()

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

overridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

process()

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

overridevirtual

Process the next data chunk. It returns false when at the end.

Reimplemented from dp3::steps::Step.

SetFieldsToWrite()

void dp3::steps::MSUpdater::SetFieldsToWrite ( const common::Fields &  fields )

overridevirtual

Set which fields the step should write.

Parameters

fields

A combination of fields. Non-writable fields are ignored.

Reimplemented from dp3::steps::OutputStep.

show()

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

overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

showTimings()

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

overridevirtual

Show the timings.

Reimplemented from dp3::steps::Step.

updateAllowed()

static bool dp3::steps::MSUpdater::updateAllowed ( const base::DPInfo &  info, casacore::String  msName, bool  throwError = true  )

static

Tests if an update of the buffer described in info to the MS msName is possible. When throwError is true, it will throw an error with a descriptive string before returning false

updateInfo()

void dp3::steps::MSUpdater::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:

• MSUpdater.h