Isis 3 Developer Reference
Isis::FxBinder Class Referenceabstract

This is the parent class to the various function classes. More...

#include <InlineCalculator.h>

Inheritance diagram for Isis::FxBinder:
Inheritance graph
Collaboration diagram for Isis::FxBinder:
Collaboration graph

Public Member Functions

 FxBinder (const QString &name)
 Constructs a function binder given a name. More...
 
virtual ~FxBinder ()
 Destroys the FxBinder object. 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 void dispatch ()=0
 This method defines how to execute this function. More...
 
virtual QVariant args ()
 Accesses the arguments for this function. More...
 

Detailed Description

This is the parent class to the various function classes.

Author
2012-07-15 Kris Becker

Constructor & Destructor Documentation

◆ FxBinder()

Isis::FxBinder::FxBinder ( const QString &  name)

Constructs a function binder given a name.

Parameters
nameA string containing a name for this function.

◆ ~FxBinder()

Isis::FxBinder::~FxBinder ( )
virtual

Destroys the FxBinder object.

Member Function Documentation

◆ args()

QVariant Isis::FxBinder::args ( )
virtual

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()

virtual void Isis::FxBinder::dispatch ( )
pure virtual

This method defines how to execute this function.

This class does not define an implementation for this pure virtual method.

Implemented in Isis::VoidFx, Isis::ParameterFx, and Isis::InlineVoidFx.

Referenced by execute(), and operator()().

◆ execute()

void Isis::FxBinder::execute ( )

Executes the function.

This method is a wrapper for the virtual dispatch method.

References dispatch().

◆ name()

QString Isis::FxBinder::name ( ) const

The name assigned to this function binder.

Returns
QString A string containing the name of this function.

◆ operator()()

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

Executes the function.

This method is a wrapper for the virtual dispatch method.

References dispatch().


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