hops::MHO_TransformingOperator< XArgType1, XArgType2 > Class Template Reference

Class MHO_TransformingOperator. More...

#include <MHO_TransformingOperator.hh>

Inheritance diagram for hops::MHO_TransformingOperator< XArgType1, XArgType2 >:

Public Member Functions
	MHO_TransformingOperator ()
virtual	~MHO_TransformingOperator ()
virtual bool	Execute () override
	Executes transformation using provided arguments. More...
virtual bool	Initialize () override
	Initializes the system by calling InitializeImpl with arguments from fArgs. More...
virtual void	SetArgs (const XArgType1 *in, XArgType2 *out)
	Setter for args (operation transforms the original type into another) More...
Public Member Functions inherited from hops::MHO_Operator
	MHO_Operator ()
virtual	~MHO_Operator ()
std::string	GetName () const
	Getter for operator name. 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...

Protected Member Functions
virtual bool	ExecuteImpl (const XArgType1 *in, XArgType2 *out)=0
	Executes an operation transforming input type to output type. More...
virtual bool	InitializeImpl (const XArgType1 *in, XArgType2 *out)=0
	Initializes implementation using input and output arguments. More...

Protected Attributes
std::tuple< const XArgType1 *, XArgType2 * >	fArgs

Detailed Description

template<class XArgType1, class XArgType2>
class hops::MHO_TransformingOperator< XArgType1, XArgType2 >

Class MHO_TransformingOperator.

Operator which changes one N-D array type into a different N-D array type.

Author

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

Date

Fri Oct 15 12:58:01 2021 -0400

Constructor & Destructor Documentation

MHO_TransformingOperator()

template<class XArgType1 , class XArgType2 >

hops::MHO_TransformingOperator< XArgType1, XArgType2 >::MHO_TransformingOperator ( )

inline

~MHO_TransformingOperator()

template<class XArgType1 , class XArgType2 >

virtual hops::MHO_TransformingOperator< XArgType1, XArgType2 >::~MHO_TransformingOperator ( )

inlinevirtual

Member Function Documentation

Execute()

template<class XArgType1 , class XArgType2 >

virtual bool hops::MHO_TransformingOperator< XArgType1, XArgType2 >::Execute ( )

inlineoverridevirtual

Executes transformation using provided arguments.

Returns

bool indicating success/failure of execution.

Note

This is a virtual function.

Implements hops::MHO_Operator.

ExecuteImpl()

template<class XArgType1 , class XArgType2 >

virtual bool hops::MHO_TransformingOperator< XArgType1, XArgType2 >::ExecuteImpl ( const XArgType1 *  in, XArgType2 *  out  )

protectedpure virtual

Executes an operation transforming input type to output type.

Parameters

in	Input data of type XArgType1
out	Output data of type XArgType2

Returns

True if execution is successful, false otherwise.

Note

This is a virtual function.

Implemented in hops::MHO_ElementTypeCaster< XArgType1, XArgType2 >, hops::MHO_SBDTableGenerator, and hops::MHO_VisibilityChannelizer.

Initialize()

template<class XArgType1 , class XArgType2 >

virtual bool hops::MHO_TransformingOperator< XArgType1, XArgType2 >::Initialize ( )

inlineoverridevirtual

Initializes the system by calling InitializeImpl with arguments from fArgs.

Returns

bool indicating success/failure of initialization.

Note

This is a virtual function.

Implements hops::MHO_Operator.

InitializeImpl()

template<class XArgType1 , class XArgType2 >

virtual bool hops::MHO_TransformingOperator< XArgType1, XArgType2 >::InitializeImpl ( const XArgType1 *  in, XArgType2 *  out  )

protectedpure virtual

Initializes implementation using input and output arguments.

Parameters

in	Input argument of type const XArgType1*
out	Output argument of type XArgType2*

Returns

Boolean indicating success/failure of initialization.

Note

This is a virtual function.

Implemented in hops::MHO_SBDTableGenerator, hops::MHO_ElementTypeCaster< XArgType1, XArgType2 >, and hops::MHO_VisibilityChannelizer.

SetArgs()

template<class XArgType1 , class XArgType2 >

virtual void hops::MHO_TransformingOperator< XArgType1, XArgType2 >::SetArgs ( const XArgType1 *  in, XArgType2 *  out  )

inlinevirtual

Setter for args (operation transforms the original type into another)

Parameters

in	Pointer to constant XArgType1
out	Pointer to XArgType2

Note

This is a virtual function.

Member Data Documentation

fArgs

template<class XArgType1 , class XArgType2 >

std::tuple< const XArgType1*, XArgType2* > hops::MHO_TransformingOperator< XArgType1, XArgType2 >::fArgs

protected

---

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

• MHO_TransformingOperator.hh