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

Base class for output steps. More...

#include <OutputStep.h>

Inheritance diagram for dp3::steps::OutputStep:
dp3::steps::Step dp3::steps::MSBDAWriter dp3::steps::MSUpdater dp3::steps::MSWriter dp3::steps::NullStep dp3::steps::Split dp3::steps::WSCleanWriter

Public Member Functions

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...
 
virtual void finish ()=0
 Finish the processing of this step and subsequent steps. 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 dp3::common::Fields getRequiredFields () const =0
 Get the fields required by the current step. More...
 
virtual MsType outputs () const
 Return which datatype this step outputs. More...
 
virtual bool process (std::unique_ptr< base::BdaBuffer >)
 
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 show (std::ostream &) const =0
 Show the step parameters. More...
 
virtual void showCounts (std::ostream &) const
 
virtual void showTimings (std::ostream &, double duration) const
 
virtual void updateInfo (const base::DPInfo &)
 

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

Base class for output steps.

Member Function Documentation

◆ GetFieldsToWrite()

const dp3::common::Fields& dp3::steps::OutputStep::GetFieldsToWrite ( ) const
inline
Returns
The fields the step should write.

◆ getProvidedFields()

common::Fields dp3::steps::OutputStep::getProvidedFields ( ) const
inlineoverridevirtual

Common override for all output steps. Since they should output all data, they never provide any new fields.

Implements dp3::steps::Step.

◆ SetFieldsToWrite()

virtual void dp3::steps::OutputStep::SetFieldsToWrite ( const dp3::common::Fields fields)
inlinevirtual

Set which fields the step should write.

Parameters
fieldsA combination of fields. Non-writable fields are ignored.

Reimplemented in dp3::steps::Split, and dp3::steps::MSUpdater.


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