This class defines a step in the DP3 pipeline that keeps the result to make it possible to get the result of another step. It stores the result and does NOT call process() of the next step. More...
#include <ResultStep.h>
Public Member Functions | |
| ResultStep () | |
| Creates a MultiResultStep and sets a NullStep as its next step. More... | |
| ~ResultStep () override | |
| void | finish () override |
| Finish does not do anything. More... | |
| const base::DPBuffer & | get () const |
| common::Fields | getProvidedFields () const override |
| common::Fields | getRequiredFields () const override |
| Get the fields required by the current step. More... | |
| bool | process (std::unique_ptr< base::DPBuffer > buffer) override |
| Keep the buffer. More... | |
| void | show (std::ostream &) const override |
| std::unique_ptr< base::DPBuffer > | take () |
 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 |
| 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 step in the DP3 pipeline that keeps the result to make it possible to get the result of another step. It stores the result and does NOT call process() of the next step.
Constructor & Destructor Documentation
◆ ResultStep()
| dp3::steps::ResultStep::ResultStep | ( | ) |
Creates a MultiResultStep and sets a NullStep as its next step.
◆ ~ResultStep()
|
inlineoverride |
Member Function Documentation
◆ finish()
|
inlineoverridevirtual |
Finish does not do anything.
Implements dp3::steps::Step.
◆ get()
|
inline |
Get the result. Does not transfer ownership of the buffer to the caller. If that is required, use take() instead.
◆ getProvidedFields()
|
inlineoverridevirtual |
Get the fields provided (modified and/or created) by the current step. The returned fields thus should not include (required) fields that are forwarded without modifications.
Implements dp3::steps::Step.
◆ getRequiredFields()
|
inlineoverridevirtual |
Get the fields required by the current step.
Implements dp3::steps::Step.
◆ process()
|
inlineoverridevirtual |
Keep the buffer.
Reimplemented from dp3::steps::Step.
◆ show()
|
inlineoverridevirtual |
Show the step parameters. It does nothing.
Implements dp3::steps::Step.
◆ take()
|
inline |
Extract the result. Transfers ownership of the buffer to the caller.
The documentation for this class was generated from the following file:
