Isis::VoidFx Class Reference

This class is used to bind function names with corresponding Calculator functions that do not take parameters. More...

#include <InlineCalculator.h>

Inherits Isis::FxBinder.

List of all members.

Public Types
typedef void(Calculator::*	calcOp )()
	Defines a Calculator function that takes no arguments.
Public Member Functions
	VoidFx (const QString &name, calcOp function, InlineCalculator *calculator)
	Constructs a Void function from the given name, Calculator operator, and Calculator.
virtual	~VoidFx ()
	Destroys the VoidFx object.
void	dispatch ()
	Calls the function corresponding to this object using its stored Calculator and Calculator operator.
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.

---

Detailed Description

This class is used to bind function names with corresponding Calculator functions that do not take parameters.

Author:

2012-07-15 Kris Becker

---

Member Typedef Documentation

typedef void(Calculator::* Isis::VoidFx::calcOp)()

Defines a Calculator function that takes no arguments.

---

Constructor & Destructor Documentation

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

Constructs a Void function from the given name, Calculator operator, and Calculator.

Parameters:

	name	A string containing a name for this function.
	function	A Calculator operator that takes no arguments.
	calculator	The Calculator used to evaluate this function.

Isis::VoidFx::~VoidFx

(

)

[virtual]

Destroys the VoidFx object.

---

Member Function Documentation

QVariant Isis::FxBinder::args

(

)

[virtual, inherited]

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.

Referenced by Isis::ParameterFx::dispatch().

void Isis::VoidFx::dispatch

(

)

[virtual]

Calls the function corresponding to this object using its stored Calculator and Calculator operator.

Implements Isis::FxBinder.

References CALL_MEMBER_FN.

void Isis::FxBinder::execute

(

)

[inherited]

Executes the function.

This method is a wrapper for the virtual dispatch method.

References Isis::FxBinder::dispatch().

Referenced by Isis::InlineCalculator::evaluate().

QString Isis::FxBinder::name

(

)

const [inherited]

The name assigned to this function binder.

Returns:

QString A string containing the name of this function.

Referenced by Isis::InlineCalculator::addFunction().

void Isis::FxBinder::operator()

(

)

[inherited]

Executes the function.

This method is a wrapper for the virtual dispatch method.

References Isis::FxBinder::dispatch().

---

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

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