DP3
Public Member Functions | List of all members
dp3::steps::MSBDAWriter Class Reference

Step for writing BDA data to an MS. More...

#include <MSBDAWriter.h>

Inheritance diagram for dp3::steps::MSBDAWriter:
dp3::steps::OutputStep dp3::steps::Step

Public Member Functions

 MSBDAWriter (const std::string &out_name, const common::ParameterSet &parset, const std::string &prefix)
 
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::BdaBuffer >) override
 
void show (std::ostream &) const override
 Show the step parameters. More...
 
void updateInfo (const base::DPInfo &) override
 
- Public Member Functions inherited from dp3::steps::OutputStep
const dp3::common::FieldsGetFieldsToWrite () 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::DPInfogetInfoIn () const
 Get access to the info of the input. More...
 
const base::DPInfogetInfoOut () const
 Get access to the info of the output. More...
 
const Step::ShPtrgetNextStep () const
 Get the next step. More...
 
StepgetPrevStep () const
 Get the previous step. More...
 
virtual MsType outputs () const
 Return which datatype this step outputs. More...
 
virtual bool process (std::unique_ptr< base::DPBuffer > buffer)
 
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
 
virtual void showTimings (std::ostream &, double duration) 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< StepShPtr
 
- 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::DPInfoGetWritableInfoOut ()
 

Detailed Description

Step for writing BDA data to an MS.

Constructor & Destructor Documentation

◆ MSBDAWriter()

dp3::steps::MSBDAWriter::MSBDAWriter ( const std::string &  out_name,
const common::ParameterSet parset,
const std::string &  prefix 
)
explicit

Member Function Documentation

◆ finish()

void dp3::steps::MSBDAWriter::finish ( )
overridevirtual

Finish the processing of this step and subsequent steps.

Implements dp3::steps::Step.

◆ getRequiredFields()

common::Fields dp3::steps::MSBDAWriter::getRequiredFields ( ) const
inlineoverridevirtual

Get the fields required by the current step.

Implements dp3::steps::Step.

◆ process()

bool dp3::steps::MSBDAWriter::process ( std::unique_ptr< base::BdaBuffer )
overridevirtual

Process the BDA data. When processed, it invokes the process function of the next step. It should return False at the end.

Reimplemented from dp3::steps::Step.

◆ show()

void dp3::steps::MSBDAWriter::show ( std::ostream &  ) const
overridevirtual

Show the step parameters.

Implements dp3::steps::Step.

◆ updateInfo()

void dp3::steps::MSBDAWriter::updateInfo ( const base::DPInfo )
overridevirtual

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

Reimplemented from dp3::steps::Step.


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