Isis Developer Reference
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>

Inheritance diagram for Isis::VoidFx:
Inheritance graph
Collaboration diagram for Isis::VoidFx:
Collaboration graph

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

◆ calcOp

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

Defines a Calculator function that takes no arguments.

Constructor & Destructor Documentation

◆ VoidFx()

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

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

Parameters
nameA string containing a name for this function.
functionA Calculator operator that takes no arguments.
calculatorThe Calculator used to evaluate this function.

◆ ~VoidFx()

Isis::VoidFx::~VoidFx ( )
virtual

Destroys the VoidFx object.

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.

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

◆ 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.

◆ execute()

void Isis::FxBinder::execute ( )
inherited

Executes the function.

This method is a wrapper for the virtual dispatch method.

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.

◆ operator()()

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: