This class defines a null step in the DP3 pipeline. It can be used as the last step in the pipeline, so other steps do not need to test if there is a next step. More...
#include <NullStep.h>
Public Member Functions | |
| ~NullStep () override | |
| bool | accepts (MsType t) const override |
| Accept BDA and regular data. More... | |
| void | finish () override |
| common::Fields | getProvidedFields () const override |
| A null step provides nothing. More... | |
| common::Fields | getRequiredFields () const override |
| A null step requires nothing. More... | |
| bool | process (std::unique_ptr< base::BdaBuffer >) override |
| Process bda data. It does nothing. More... | |
| bool | process (std::unique_ptr< base::DPBuffer >) override |
| Process regular data. It does nothing. More... | |
| void | show (std::ostream &) const 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 () |
| 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 |
| 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< 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
This class defines a null step in the DP3 pipeline. It can be used as the last step in the pipeline, so other steps do not need to test if there is a next step.
Constructor & Destructor Documentation
◆ ~NullStep()
|
inlineoverride |
Member Function Documentation
◆ accepts()
|
inlineoverridevirtual |
Accept BDA and regular data.
Reimplemented from dp3::steps::Step.
◆ finish()
|
inlineoverridevirtual |
Finish the processing of this step and subsequent steps. It does nothing.
Implements dp3::steps::Step.
◆ getProvidedFields()
|
inlineoverridevirtual |
A null step provides nothing.
Implements dp3::steps::Step.
◆ getRequiredFields()
|
inlineoverridevirtual |
A null step requires nothing.
Implements dp3::steps::Step.
◆ process() [1/2]
|
inlineoverridevirtual |
Process bda data. It does nothing.
Reimplemented from dp3::steps::Step.
◆ process() [2/2]
|
inlineoverridevirtual |
Process regular data. It does nothing.
Reimplemented from dp3::steps::Step.
◆ show()
|
inlineoverridevirtual |
Show the step parameters. It does nothing.
Implements dp3::steps::Step.
The documentation for this class was generated from the following file:
