Isis::ParameterFx Class Reference

This class is used to bind function names with corresponding Calculator functions that take a parameter. More...

#include <InlineCalculator.h>

Inheritance diagram for Isis::ParameterFx:

Collaboration diagram for Isis::ParameterFx:

Public Types
typedef void(InlineCalculator::*	calcOp) (const QVariant &arg)
	Defines an InlineCalculator function that takes arguments.

Public Member Functions
	ParameterFx (const QString &name, calcOp function, InlineCalculator *calculator)
	Constructs a Parameter function from the given name (containing the appropriate parameters), InlineCalculator operator, and InlineCalculator.
virtual	~ParameterFx ()
	Destroys the ParameterFx object.
void	dispatch ()
	Calls the function corresponding to this object using its stored InlineCalculator, InlineCalculator operator, and arguments.
QString	name () const
	The name assigned to this function binder.
void	execute ()
	Executes the function.
void	operator() ()
	Executes the function.
virtual QVariant	args ()
	Accesses the arguments for this function.

Private Attributes
calcOp	m_func
	The InlineCalculator operator that takes parameters.
InlineCalculator *	m_calc
	The InlineCalculator used to evaluate this function.
QString	m_name
	Name of function.

Detailed Description

This class is used to bind function names with corresponding Calculator functions that take a parameter.

Author

2012-07-15 Kris Becker

History

2012-07-15 Kris Becker - Original version.

Definition at line 193 of file InlineCalculator.h.

Member Typedef Documentation

calcOp

typedef void(InlineCalculator::* Isis::ParameterFx::calcOp) (const QVariant &arg)

Defines an InlineCalculator function that takes arguments.

Definition at line 196 of file InlineCalculator.h.

Constructor & Destructor Documentation

ParameterFx()

Isis::ParameterFx::ParameterFx	(	const QString &	name,
		calcOp	function,
		InlineCalculator *	calculator )

Constructs a Parameter function from the given name (containing the appropriate parameters), InlineCalculator operator, and InlineCalculator.

Parameters

name	A string containing a name for this function. Note: The name given should include the parameters to be passed into this function.
function	An InlineCalculator operator that takes parameters.
calculator	The InlineCalculator used to evaluate this function.

Definition at line 815 of file InlineCalculator.cpp.

~ParameterFx()

Isis::ParameterFx::~ParameterFx ( )

virtual

Destroys the ParameterFx object.

Definition at line 825 of file InlineCalculator.cpp.

Member Function Documentation

args()

QVariant Isis::FxBinder::args ( )

virtualinherited

Accesses the arguments for this function.

For scalars and variables, the argument is also the function name.

Returns

QVariant The parameters of this function, as a QVariant.

Definition at line 768 of file InlineCalculator.cpp.

References Isis::FxBinder::m_name.

Referenced by dispatch().

dispatch()

void Isis::ParameterFx::dispatch ( )

virtual

Calls the function corresponding to this object using its stored InlineCalculator, InlineCalculator operator, and arguments.

Implements Isis::FxBinder.

Definition at line 834 of file InlineCalculator.cpp.

References Isis::FxBinder::args(), m_calc, and m_func.

execute()

void Isis::FxBinder::execute ( )

inherited

Executes the function.

This method is a wrapper for the virtual dispatch method.

Definition at line 748 of file InlineCalculator.cpp.

References Isis::FxBinder::dispatch().

name()

QString Isis::FxBinder::name ( ) const

inherited

The name assigned to this function binder.

Returns

QString A string containing the name of this function.

Definition at line 739 of file InlineCalculator.cpp.

References Isis::FxBinder::m_name.

operator()()

void Isis::FxBinder::operator() ( )

inherited

Executes the function.

This method is a wrapper for the virtual dispatch method.

Definition at line 757 of file InlineCalculator.cpp.

References Isis::FxBinder::dispatch().

Member Data Documentation

m_calc

InlineCalculator* Isis::ParameterFx::m_calc

private

The InlineCalculator used to evaluate this function.

Definition at line 205 of file InlineCalculator.h.

Referenced by dispatch().

m_func

calcOp Isis::ParameterFx::m_func

private

The InlineCalculator operator that takes parameters.

Definition at line 204 of file InlineCalculator.h.

Referenced by dispatch().

m_name

QString Isis::FxBinder::m_name

privateinherited

Name of function.

Definition at line 157 of file InlineCalculator.h.

Referenced by Isis::FxBinder::args(), and Isis::FxBinder::name().

---

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

• src/base/objs/InlineCalculator/InlineCalculator.h
• src/base/objs/InlineCalculator/InlineCalculator.cpp