HOPS: hops::MHO_Operator Class Reference

HOPS

HOPS class reference

Class MHO_Operator. More...

#include <MHO_Operator.hh>

Inheritance diagram for hops::MHO_Operator:

Public Member Functions
	MHO_Operator ()

virtual	~MHO_Operator ()

virtual bool	Execute ()=0
	Function Execute. More...

std::string	GetName () const
	Getter for operator name. More...

virtual bool	Initialize ()=0
	Function Initialize. More...

virtual double	Priority () const
	Get the the priority field value. More...

void	SetName (std::string name)
	Setter for operator name. More...

virtual void	SetPriority (const double &priority)
	Setter for operator priority (determines order of execution within a operator category) More...

Detailed Description

Class MHO_Operator.

abstract base class for operators

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

Date: Thu Sep 23 16:03:48 2021 -0400

Constructor & Destructor Documentation

◆ MHO_Operator()

hops::MHO_Operator::MHO_Operator ( )

◆ ~MHO_Operator()

hops::MHO_Operator::~MHO_Operator ( )

virtual

Member Function Documentation

◆ Execute()

virtual bool hops::MHO_Operator::Execute ( )

pure virtual

Function Execute.

Returns: Return value (bool)

Note: This is a virtual function.

Implemented in hops::MHO_UnaryOperator< XArgType >, hops::MHO_UnaryOperator< multitone_pcal_type >, hops::MHO_UnaryOperator< XArrayType >, hops::MHO_UnaryOperator< hops::MHO_TableContainer >, hops::MHO_UnaryOperator< weight_type >, hops::MHO_UnaryOperator< MHO_NDArrayWrapper< std::complex< XFloatType >, 1 > >, hops::MHO_UnaryOperator< visibility_type >, hops::MHO_UnaryOperator< MHO_TableContainer< visibility_element_type, mbd_axis_pack > >, hops::MHO_PyUnaryTableOperator, hops::MHO_PyOperator, hops::MHO_PyGenericOperator, hops::MHO_OpenCLComplexPointwiseMultiply, hops::MHO_UnaryOperator< XArgType >, hops::MHO_UnaryOperator< multitone_pcal_type >, hops::MHO_UnaryOperator< XArrayType >, hops::MHO_UnaryOperator< hops::MHO_TableContainer >, hops::MHO_UnaryOperator< weight_type >, hops::MHO_UnaryOperator< MHO_NDArrayWrapper< std::complex< XFloatType >, 1 > >, hops::MHO_UnaryOperator< visibility_type >, hops::MHO_UnaryOperator< MHO_TableContainer< visibility_element_type, mbd_axis_pack > >, hops::MHO_UnaryInPlaceOperator< XArgType >, hops::MHO_TransformingOperator< XArgType1, XArgType2 >, hops::MHO_TransformingOperator< uch_visibility_store_type, visibility_store_type >, hops::MHO_TransformingOperator< uch_weight_store_type, weight_store_type >, hops::MHO_TransformingOperator< visibility_type, sbd_type >, hops::MHO_InspectingOperator< XArgType >, hops::MHO_InspectingOperator< visibility_type >, hops::MHO_BinaryOperator< XArgType1, XArgType2, XArgType3 >, hops::MHO_BinaryOperator< visibility_type, weight_type, sbd_type >, hops::MHO_BinaryOperator< MHO_NDArrayWrapper< std::complex< XFloatType >, RANK >, MHO_NDArrayWrapper< std::complex< XFloatType >, RANK >, MHO_NDArrayWrapper< std::complex< XFloatType >, RANK > >, hops::MHO_InterpolateFringePeak, and hops::MHO_OpenCLBatchedMultidimensionalFastFourierTransform< XArgType >.

◆ GetName()

std::string hops::MHO_Operator::GetName ( ) const

inline

Getter for operator name.

Returns: The stored name as a std::string

◆ Initialize()

virtual bool hops::MHO_Operator::Initialize ( )

pure virtual

Function Initialize.

Returns: Return value (bool)

Note: This is a virtual function.

Implemented in hops::MHO_UnaryOperator< XArgType >, hops::MHO_UnaryOperator< multitone_pcal_type >, hops::MHO_UnaryOperator< XArrayType >, hops::MHO_UnaryOperator< hops::MHO_TableContainer >, hops::MHO_UnaryOperator< weight_type >, hops::MHO_UnaryOperator< MHO_NDArrayWrapper< std::complex< XFloatType >, 1 > >, hops::MHO_UnaryOperator< visibility_type >, hops::MHO_UnaryOperator< MHO_TableContainer< visibility_element_type, mbd_axis_pack > >, hops::MHO_PyUnaryTableOperator, hops::MHO_PyOperator, hops::MHO_PyGenericOperator, hops::MHO_OpenCLComplexPointwiseMultiply, hops::MHO_UnaryOperator< XArgType >, hops::MHO_UnaryOperator< multitone_pcal_type >, hops::MHO_UnaryOperator< XArrayType >, hops::MHO_UnaryOperator< hops::MHO_TableContainer >, hops::MHO_UnaryOperator< weight_type >, hops::MHO_UnaryOperator< MHO_NDArrayWrapper< std::complex< XFloatType >, 1 > >, hops::MHO_UnaryOperator< visibility_type >, hops::MHO_UnaryOperator< MHO_TableContainer< visibility_element_type, mbd_axis_pack > >, hops::MHO_UnaryInPlaceOperator< XArgType >, hops::MHO_TransformingOperator< XArgType1, XArgType2 >, hops::MHO_TransformingOperator< uch_visibility_store_type, visibility_store_type >, hops::MHO_TransformingOperator< uch_weight_store_type, weight_store_type >, hops::MHO_TransformingOperator< visibility_type, sbd_type >, hops::MHO_InspectingOperator< XArgType >, hops::MHO_InspectingOperator< visibility_type >, hops::MHO_BinaryOperator< XArgType1, XArgType2, XArgType3 >, hops::MHO_BinaryOperator< visibility_type, weight_type, sbd_type >, hops::MHO_BinaryOperator< MHO_NDArrayWrapper< std::complex< XFloatType >, RANK >, MHO_NDArrayWrapper< std::complex< XFloatType >, RANK >, MHO_NDArrayWrapper< std::complex< XFloatType >, RANK > >, hops::MHO_InterpolateFringePeak, and hops::MHO_OpenCLBatchedMultidimensionalFastFourierTransform< XArgType >.

◆ Priority()

virtual double hops::MHO_Operator::Priority ( ) const

inlinevirtual

Get the the priority field value.

Returns: Return value (double)

Note: This is a virtual function.

◆ SetName()

void hops::MHO_Operator::SetName ( std::string name )

inline

Setter for operator name.

Parameters

name	New name to set

◆ SetPriority()

virtual void hops::MHO_Operator::SetPriority ( const double & priority )

inlinevirtual

Setter for operator priority (determines order of execution within a operator category)

Parameters

priority New priority value to be assigned to fPriority field (double)

Note: This is a virtual function.

a higher value for the fPriority field implies this operator should happend after other operators with lower priority values order of execution goes from low to high

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