USGS

Isis 3.0 Object Programmers' Reference

Home

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.

Private Attributes

calcOp m_func
 The Calculator operator that takes no parameters.
InlineCalculatorm_calc
 The Calculator used to evaluate 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
History:
2012-07-15 Kris Becker - Original version.

Definition at line 232 of file InlineCalculator.h.

Member Typedef Documentation

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

Defines a Calculator function that takes no arguments.

Definition at line 235 of file InlineCalculator.h.

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
nameA string containing a name for this function.
functionA Calculator operator that takes no arguments.
calculatorThe Calculator used to evaluate this function.

Definition at line 814 of file InlineCalculator.cpp.

Isis::VoidFx::~VoidFx ( )
virtual

Destroys the VoidFx object.

Definition at line 824 of file InlineCalculator.cpp.

Member Function Documentation

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 735 of file InlineCalculator.cpp.

References Isis::FxBinder::m_name.

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.

Definition at line 832 of file InlineCalculator.cpp.

References CALL_MEMBER_FN, m_calc, and m_func.

void Isis::FxBinder::execute ( )
inherited

Executes the function.

This method is a wrapper for the virtual dispatch method.

Definition at line 715 of file InlineCalculator.cpp.

References Isis::FxBinder::dispatch().

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 706 of file InlineCalculator.cpp.

References Isis::FxBinder::m_name.

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

Executes the function.

This method is a wrapper for the virtual dispatch method.

Definition at line 724 of file InlineCalculator.cpp.

References Isis::FxBinder::dispatch().

Member Data Documentation

InlineCalculator* Isis::VoidFx::m_calc
private

The Calculator used to evaluate this function.

Definition at line 244 of file InlineCalculator.h.

Referenced by dispatch().

calcOp Isis::VoidFx::m_func
private

The Calculator operator that takes no parameters.

Definition at line 243 of file InlineCalculator.h.

Referenced by dispatch().


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