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

Class MHO_AdhocFlaggingBuilder. More...

#include <MHO_AdhocFlaggingBuilder.hh>

Inheritance diagram for hops::MHO_AdhocFlaggingBuilder:
[legend]

Public Member Functions

 MHO_AdhocFlaggingBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
 
 MHO_AdhocFlaggingBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
 
virtual ~MHO_AdhocFlaggingBuilder ()
 
virtual bool Build () override
 Constructs (or updates) the MHO_AdhocFlagging operator and registers it. 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_AdhocFlaggingBuilder.

Builds an MHO_AdhocFlagging operator from control-file parameters.

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

Triggered by an 'adhoc_flag_file <path>' compound statement in the control file. The statement may appear inside a station-conditional block ('if station X ...') to set the flag file for a specific station, or outside any condition to apply the same file to both stations.

Because a baseline has two stations (reference and remote), the builder maintains a single 'adhoc_flagging' operator in the toolbox and updates its ref/rem file paths as each control statement is processed. The first call creates the operator; subsequent calls find the existing instance via the toolbox and update whichever station file path applies.

Parameters consumed from the compound statement: flag_file (string) path to the adhoc flag file for this station

Station identity is extracted from the 'if station <id>' condition in fConditions, then compared against: /ref_station/site_id (parameter store) /rem_station/site_id (parameter store)

Constructor & Destructor Documentation

◆ MHO_AdhocFlaggingBuilder() [1/2]

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

◆ MHO_AdhocFlaggingBuilder() [2/2]

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

◆ ~MHO_AdhocFlaggingBuilder()

virtual hops::MHO_AdhocFlaggingBuilder::~MHO_AdhocFlaggingBuilder ( )
inlinevirtual

Member Function Documentation

◆ Build()

bool hops::MHO_AdhocFlaggingBuilder::Build ( )
overridevirtual

Constructs (or updates) the MHO_AdhocFlagging operator and registers it.

Returns
true on success, false if required data or parameters are missing.

Implements hops::MHO_OperatorBuilder.


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