hops::MHO_OperatorBuilder Class Reference

Abtract base class for a builder object (creates an operator for later use) More...

#include <MHO_OperatorBuilder.hh>

Inheritance diagram for hops::MHO_OperatorBuilder:

Public Member Functions
	MHO_OperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
	MHO_OperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
virtual	~MHO_OperatorBuilder ()
virtual bool	Build ()=0
	Builds the object and passes it to toolbox if successful, otherwise returns false. More...
virtual void	SetAttributes (const mho_json &attr)
	Setter for attributes. More...
virtual void	SetConditions (const mho_json &cond)
	Setter for applicability conditions. More...
virtual void	SetContainerStore (MHO_ContainerStore *cstore)
	Setter for container store. More...
virtual void	SetFormat (const mho_json &format)
	Setter for format. More...
virtual void	SetFringeData (MHO_FringeData *fdata)
	Setter for fringe data. More...
virtual void	SetParameterStore (MHO_ParameterStore *pstore)
	Setter for parameter store. More...
virtual void	SetToolbox (MHO_OperatorToolbox *toolbox)
	Setter for toolbox. More...

Protected Member Functions
virtual bool	IsConfigurationOk ()
	Function IsConfigurationOk provided for derived class to validate fAttributes against fFormat and/or fConditions but the default implementation tries to check a few things. More...

Protected Attributes
mho_json	fAttributes
mho_json	fConditions
MHO_ContainerStore *	fContainerStore
mho_json	fFormat
MHO_FringeData *	fFringeData
MHO_OperatorToolbox *	fOperatorToolbox
MHO_ParameterStore *	fParameterStore

Detailed Description

Abtract base class for a builder object (creates an operator for later use)

Date

Wed May 31 17:11:03 2023 -0400

Author

J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Constructor & Destructor Documentation

MHO_OperatorBuilder() [1/2]

hops::MHO_OperatorBuilder::MHO_OperatorBuilder ( MHO_OperatorToolbox *  toolbox, MHO_FringeData *  fdata  )

inline

MHO_OperatorBuilder() [2/2]

hops::MHO_OperatorBuilder::MHO_OperatorBuilder ( MHO_OperatorToolbox *  toolbox, MHO_ContainerStore *  cstore = nullptr, MHO_ParameterStore *  pstore = nullptr  )

inline

~MHO_OperatorBuilder()

virtual hops::MHO_OperatorBuilder::~MHO_OperatorBuilder ( )

inlinevirtual

Member Function Documentation

Build()

virtual bool hops::MHO_OperatorBuilder::Build ( )

pure virtual

Builds the object and passes it to toolbox if successful, otherwise returns false.

Returns

bool indicating success or failure

Note

This is a virtual function.

Implemented in hops::MHO_PythonOperatorBuilder, hops::MHO_StationDelayCorrectionBuilder, hops::MHO_SamplerLabelerBuilder, hops::MHO_PolProductSummationBuilder, hops::MHO_PassbandBuilder, hops::MHO_NotchesBuilder, hops::MHO_MultitonePhaseCorrectionBuilder, hops::MHO_MixedPolYShiftBuilder, hops::MHO_MinWeightBuilder, hops::MHO_ManualPolPhaseCorrectionBuilder, hops::MHO_ManualPolDelayCorrectionBuilder, hops::MHO_ManualChannelPhaseCorrectionBuilder, hops::MHO_ManualChannelDelayCorrectionBuilder, hops::MHO_LSBOffsetBuilder, hops::MHO_LinearDParCorrectionBuilder, hops::MHO_DCBlockBuilder, hops::MHO_DataSelectionBuilder, hops::MHO_CircularFieldRotationBuilder, and hops::MHO_ChannelLabelerBuilder.

IsConfigurationOk()

virtual bool hops::MHO_OperatorBuilder::IsConfigurationOk ( )

inlineprotectedvirtual

Function IsConfigurationOk provided for derived class to validate fAttributes against fFormat and/or fConditions but the default implementation tries to check a few things.

Returns

Return value (bool)

Note

This is a virtual function.

SetAttributes()

virtual void hops::MHO_OperatorBuilder::SetAttributes ( const mho_json &  attr )

inlinevirtual

Setter for attributes.

Parameters

attr	Input attribute data of type const mho_json&

Note

This is a virtual function.

SetConditions()

virtual void hops::MHO_OperatorBuilder::SetConditions ( const mho_json &  cond )

inlinevirtual

Setter for applicability conditions.

Parameters

cond	Input conditions of type const mho_json&

Note

This is a virtual function.

SetContainerStore()

virtual void hops::MHO_OperatorBuilder::SetContainerStore ( MHO_ContainerStore *  cstore )

inlinevirtual

Setter for container store.

Parameters

cstore

Pointer to MHO_ContainerStore object

Note

This is a virtual function.

SetFormat()

virtual void hops::MHO_OperatorBuilder::SetFormat ( const mho_json &  format )

inlinevirtual

Setter for format.

Parameters

format

The new format for the operator.

Note

This is a virtual function.

SetFringeData()

virtual void hops::MHO_OperatorBuilder::SetFringeData ( MHO_FringeData *  fdata )

inlinevirtual

Setter for fringe data.

Parameters

fdata

Pointer to MHO_FringeData structure

Note

This is a virtual function.

SetParameterStore()

virtual void hops::MHO_OperatorBuilder::SetParameterStore ( MHO_ParameterStore *  pstore )

inlinevirtual

Setter for parameter store.

Parameters

pstore

Pointer to MHO_ParameterStore object

Note

This is a virtual function.

SetToolbox()

virtual void hops::MHO_OperatorBuilder::SetToolbox ( MHO_OperatorToolbox *  toolbox )

inlinevirtual

Setter for toolbox.

Parameters

toolbox

Pointer to the MHO_OperatorToolbox object to be set.

Note

This is a virtual function.

Member Data Documentation

fAttributes

mho_json hops::MHO_OperatorBuilder::fAttributes

protected

fConditions

mho_json hops::MHO_OperatorBuilder::fConditions

protected

fContainerStore

MHO_ContainerStore* hops::MHO_OperatorBuilder::fContainerStore

protected

fFormat

mho_json hops::MHO_OperatorBuilder::fFormat

protected

fFringeData

MHO_FringeData* hops::MHO_OperatorBuilder::fFringeData

protected

fOperatorToolbox

MHO_OperatorToolbox* hops::MHO_OperatorBuilder::fOperatorToolbox

protected

fParameterStore

MHO_ParameterStore* hops::MHO_OperatorBuilder::fParameterStore

protected

---

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

• MHO_OperatorBuilder.hh