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

#include <MockStep.h>

Inheritance diagram for dp3::steps::MockStep:
dp3::steps::test::ThrowStep dp3::steps::Step

Public Member Functions

 MockStep ()
 
 ~MockStep () override
 
void ClearBdaBuffers ()
 
void finish () override
 
std::size_t FinishCount () const
 
const std::vector< std::unique_ptr< base::BdaBuffer > > & GetBdaBuffers () const
 
const std::vector< std::unique_ptr< base::DPBuffer > > & GetRegularBuffers () const
 
bool process (std::unique_ptr< base::BdaBuffer > buffer) override
 
bool process (std::unique_ptr< base::DPBuffer > buffer) override
 
std::size_t TotalRowCount () const
 
- Public Member Functions inherited from dp3::steps::test::ThrowStep
void finish () override
 Finish the processing of this step and subsequent steps. More...
 
common::Fields getProvidedFields () const override
 
common::Fields getRequiredFields () const override
 Get the fields required by the current step. More...
 
void show (std::ostream &) const override
 Show the step parameters. More...
 
void updateInfo (const base::DPInfo &) override
 
- 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...
 
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 ()
 

Constructor & Destructor Documentation

◆ MockStep()

dp3::steps::MockStep::MockStep ( )
inline

◆ ~MockStep()

dp3::steps::MockStep::~MockStep ( )
inlineoverride

Member Function Documentation

◆ ClearBdaBuffers()

void dp3::steps::MockStep::ClearBdaBuffers ( )
inline

◆ finish()

void dp3::steps::MockStep::finish ( )
inlineoverridevirtual

Mocked finish() function, which counts the number of calls. Use FinishCount() for accessing the count.

Implements dp3::steps::Step.

◆ FinishCount()

std::size_t dp3::steps::MockStep::FinishCount ( ) const
inline

◆ GetBdaBuffers()

const std::vector<std::unique_ptr<base::BdaBuffer> >& dp3::steps::MockStep::GetBdaBuffers ( ) const
inline

◆ GetRegularBuffers()

const std::vector<std::unique_ptr<base::DPBuffer> >& dp3::steps::MockStep::GetRegularBuffers ( ) const
inline

◆ process() [1/2]

bool dp3::steps::MockStep::process ( std::unique_ptr< base::BdaBuffer buffer)
inlineoverridevirtual

Mocked process() function for bda buffers. Adds the bda buffer to an internal list. Use GetBdaBuffers for accessing them.

Reimplemented from dp3::steps::Step.

◆ process() [2/2]

bool dp3::steps::MockStep::process ( std::unique_ptr< base::DPBuffer buffer)
inlineoverridevirtual

Mocked process() function for regular buffers. Adds the regular buffer to an internal list. Use GetRegularBuffers for accessing them.

Reimplemented from dp3::steps::Step.

◆ TotalRowCount()

std::size_t dp3::steps::MockStep::TotalRowCount ( ) const

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