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

#include <MHO_PythonOperatorBuilder.hh>

Inheritance diagram for hops::MHO_PythonOperatorBuilder:
[legend]

Public Member Functions

 MHO_PythonOperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_ContainerStore *cstore=nullptr, MHO_ParameterStore *pstore=nullptr)
 
 MHO_PythonOperatorBuilder (MHO_OperatorToolbox *toolbox, MHO_FringeData *fdata)
 
virtual ~MHO_PythonOperatorBuilder ()
 
virtual bool Build () override
 Builds the object and passes it to toolbox if successful, otherwise returns false. More...
 
virtual bool IsConfigurationOk () override
 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...
 
- 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
 
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

Author
J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du
Date
Mon Sep 18 17:22:44 2023 -0400

Constructor & Destructor Documentation

◆ MHO_PythonOperatorBuilder() [1/2]

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

◆ MHO_PythonOperatorBuilder() [2/2]

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

◆ ~MHO_PythonOperatorBuilder()

virtual hops::MHO_PythonOperatorBuilder::~MHO_PythonOperatorBuilder ( )
inlinevirtual

Member Function Documentation

◆ Build()

virtual bool hops::MHO_PythonOperatorBuilder::Build ( )
inlineoverridevirtual

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.

Implements hops::MHO_OperatorBuilder.

◆ IsConfigurationOk()

virtual bool hops::MHO_PythonOperatorBuilder::IsConfigurationOk ( )
inlineoverridevirtual

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.

Reimplemented from hops::MHO_OperatorBuilder.


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