#include <BDAResultStep.h>
Inheritance diagram for dp3::steps::BDAResultStep:
Public Member Functions | |
| BDAResultStep () | |
| Creates an empty BDAResultStep. More... | |
| ~BDAResultStep () override | |
| std::vector< std::unique_ptr< base::BdaBuffer > > | Extract () |
| Extracts all stored buffers from the result step. More... | |
| void | finish () override |
| Does nothing. More... | |
| 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::BdaBuffer > buffer) override |
| Adds a buffer to the internal queue. More... | |
| void | show (std::ostream &) const override |
| Does nothing. More... | |
 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::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 |
| 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
Defines a result step for BDA buffers.
- The process() function adds all buffers to an internal queue.
- The result step should always be the last step in a series of steps.
- The owner of the BDAResultStep (BDADDECal) extracts buffers from the queue.
Constructor & Destructor Documentation
◆ BDAResultStep()
|
inline |
Creates an empty BDAResultStep.
◆ ~BDAResultStep()
|
inlineoverride |
Member Function Documentation
◆ Extract()
|
inline |
Extracts all stored buffers from the result step.
◆ finish()
|
inlineoverridevirtual |
Does nothing.
Implements dp3::steps::Step.
◆ 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 |
Adds a buffer to the internal queue.
Reimplemented from dp3::steps::Step.
◆ show()
|
inlineoverridevirtual |
Does nothing.
Implements dp3::steps::Step.
The documentation for this class was generated from the following file:
