HOPS
HOPS class reference
Public Member Functions | List of all members
hops::MHO_NotchCombBuilder Class Reference

Class MHO_NotchCombBuilder. More...

#include <MHO_NotchCombBuilder.hh>

Inheritance diagram for hops::MHO_NotchCombBuilder:
[legend]

Public Member Functions

 MHO_NotchCombBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
 
 MHO_NotchCombBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
 
virtual ~MHO_NotchCombBuilder ()
 
virtual bool Build () override
 Constructs and adds a new MHO_NotchComb operator to the toolbox. More...
 
- Public Member Functions inherited from hops::MHO_OperatorBuilder
 MHO_OperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
 
 MHO_OperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
 
virtual ~MHO_OperatorBuilder ()
 
void SetAttributes (const mho_json &attr)
 Setter for attributes. More...
 
void SetConditions (const mho_json &cond)
 Setter for applicability conditions. More...
 
void SetContainerStore (MHO_ContainerStore *cstore)
 Setter for container store. More...
 
void SetFormat (const mho_json &format)
 Setter for format. More...
 
void SetFringeData (MHO_FringeData *fdata)
 Setter for fringe data. More...
 
void SetParameterStore (MHO_ParameterStore *pstore)
 Setter for parameter store. More...
 
void SetToolbox (MHO_OperatorToolbox *toolbox)
 Setter for toolbox. More...
 

Additional Inherited Members

- Protected Member Functions inherited from hops::MHO_OperatorBuilder
std::vector< std::string > ExtractAllStationIdentifiers () const
 
std::vector< std::string > GetMatchingStationIdentifiers () const
 
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...
 
bool StationMatchesCurrentBaseline (const std::string &station_id) const
 
bool StationMatchesRole (const std::string &station_id, const std::string &role) const
 
- Protected Attributes inherited from hops::MHO_OperatorBuilder
mho_json fAttributes
 
mho_json fConditions
 
MHO_ContainerStorefContainerStore
 
mho_json fFormat
 
MHO_FringeDatafFringeData
 
MHO_OperatorToolboxfOperatorToolbox
 
MHO_ParameterStorefParameterStore
 

Detailed Description

Class MHO_NotchCombBuilder.

builds a notches (frequency cut) operator

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Tue Jun 20 12:35:56 2023 -0400

Constructor & Destructor Documentation

◆ MHO_NotchCombBuilder() [1/2]

hops::MHO_NotchCombBuilder::MHO_NotchCombBuilder ( MHO_OperatorToolbox toolbox,
MHO_FringeData fdata 
)
inline

◆ MHO_NotchCombBuilder() [2/2]

hops::MHO_NotchCombBuilder::MHO_NotchCombBuilder ( MHO_OperatorToolbox toolbox,
MHO_ContainerStore cstore = nullptr,
MHO_ParameterStore pstore = nullptr 
)
inline

◆ ~MHO_NotchCombBuilder()

virtual hops::MHO_NotchCombBuilder::~MHO_NotchCombBuilder ( )
inlinevirtual

Member Function Documentation

◆ Build()

bool hops::MHO_NotchCombBuilder::Build ( )
overridevirtual

Constructs and adds a new MHO_NotchComb operator to the toolbox.

Returns
True if successful, false otherwise.

Implements hops::MHO_OperatorBuilder.


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