Isis 3 Programmer Reference
Isis::InlineVoidFx Class Reference

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

#include <InlineCalculator.h>

Inheritance diagram for Isis::InlineVoidFx:
Inheritance graph
Collaboration diagram for Isis::InlineVoidFx:
Collaboration graph

Public Types

typedef void(InlineCalculator::* calcOp) ()
 Defines an InlineCalculator function that takes no arguments. More...
 

Public Member Functions

 InlineVoidFx (const QString &name, calcOp function, InlineCalculator *calculator)
 Constructs an InlineVoid function from the given name, InlineCalculator operator, and InlineCalculator. More...
 
virtual ~InlineVoidFx ()
 Destroys the InlineVoidFx object. More...
 
void dispatch ()
 Calls the function corresponding to this object using its stored InlineCalculator and InlineCalculator operator. More...
 
QString name () const
 The name assigned to this function binder. More...
 
void execute ()
 Executes the function. More...
 
void operator() ()
 Executes the function. More...
 
virtual QVariant args ()
 Accesses the arguments for this function. More...
 

Private Attributes

calcOp m_func
 The InlineCalculator operator that takes no parameters. More...
 
InlineCalculatorm_calc
 The InlineCalculator used to evaluate this function. More...
 
QString m_name
 Name of function. More...
 

Detailed Description

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

Author
2012-07-15 Kris Becker
History:
2012-07-15 Kris Becker - Original version.

Definition at line 169 of file InlineCalculator.h.

Member Typedef Documentation

◆ calcOp

typedef void(InlineCalculator::* Isis::InlineVoidFx::calcOp) ()

Defines an InlineCalculator function that takes no arguments.

Definition at line 172 of file InlineCalculator.h.

Constructor & Destructor Documentation

◆ InlineVoidFx()

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

Constructs an InlineVoid function from the given name, InlineCalculator operator, and InlineCalculator.

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

Definition at line 781 of file InlineCalculator.cpp.

◆ ~InlineVoidFx()

Isis::InlineVoidFx::~InlineVoidFx ( )
virtual

Destroys the InlineVoidFx object.

Definition at line 791 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 Isis::ParameterFx::dispatch().

◆ dispatch()

void Isis::InlineVoidFx::dispatch ( )
virtual

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

Implements Isis::FxBinder.

Definition at line 799 of file InlineCalculator.cpp.

References 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::InlineVoidFx::m_calc
private

The InlineCalculator used to evaluate this function.

Definition at line 181 of file InlineCalculator.h.

Referenced by dispatch().

◆ m_func

calcOp Isis::InlineVoidFx::m_func
private

The InlineCalculator operator that takes no parameters.

Definition at line 180 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: