Developer documentation | Axl-2.5.1

axlFieldSpatialPointDistanceCreator Class Reference

#include <axlFieldSpatialPointDistanceCreator.h>

Inheritance diagram for axlFieldSpatialPointDistanceCreator:
axlAbstractFieldGenerator axlAbstractProcess

Public Slots

void setInput (dtkAbstractData *data, int channel=0)
void setParameter (double data, int channel=0)
int update (void)
int channelCount (void)
- Public Slots inherited from axlAbstractFieldGenerator
virtual void setInput (dtkAbstractData *data, int channel=0)
virtual int update (void)

Public Member Functions

 axlFieldSpatialPointDistanceCreator (void)
 ~axlFieldSpatialPointDistanceCreator (void)
QString description (void) const
QString identifier (void) const
QString form (void) const
 Description of the form for the dialog with the process. More...
- Public Member Functions inherited from axlAbstractFieldGenerator
 axlAbstractFieldGenerator (void)
virtual ~axlAbstractFieldGenerator (void)
- Public Member Functions inherited from axlAbstractProcess
 axlAbstractProcess (void)
virtual ~axlAbstractProcess (void)
virtual void copyProcess (axlAbstractProcess *process)
virtual bool hasParameters (void)
virtual void setDescription (QString description)
virtual void setIdentifier (QString identifier)

Static Public Member Functions

static bool registered (void)

Additional Inherited Members

- Signals inherited from axlAbstractFieldGenerator
void dataSetFieldsChanged (QList< axlAbstractData * > dataSet, QString fieldName)

Detailed Description

Definition at line 33 of file axlFieldSpatialPointDistanceCreator.h.

Constructor & Destructor Documentation

axlFieldSpatialPointDistanceCreator::axlFieldSpatialPointDistanceCreator ( void  )

Definition at line 37 of file axlFieldSpatialPointDistanceCreator.cpp.

axlFieldSpatialPointDistanceCreator::~axlFieldSpatialPointDistanceCreator ( void  )

Definition at line 46 of file axlFieldSpatialPointDistanceCreator.cpp.

Member Function Documentation

int axlFieldSpatialPointDistanceCreator::channelCount ( void  )

Definition at line 114 of file axlFieldSpatialPointDistanceCreator.cpp.

QString axlFieldSpatialPointDistanceCreator::description ( void  ) const

Reimplemented from axlAbstractFieldGenerator.

Definition at line 120 of file axlFieldSpatialPointDistanceCreator.cpp.

QString axlFieldSpatialPointDistanceCreator::form ( void  ) const

Description of the form for the dialog with the process.

The string use to describe the form is formatted as follows:



  • CHANNEL is a number identifying the rank of an input, see dtkAbstractProcess. Write this value only if the process method setInput uses a channel in its parameters !
  • TYPE is either int, double or data.
  • LABEL is the input's name.

Here is an example of such a declaration:

QString form(void) const
return QString(
" INPUT:0 data StartPoint \n"
" INPUT:1 data EndPoint \n"
" PARAMETER:0 double Radius \n"
" OUTPUT Cylinder ");

Reimplemented from axlAbstractProcess.

Definition at line 54 of file axlFieldSpatialPointDistanceCreator.h.

QString axlFieldSpatialPointDistanceCreator::identifier ( void  ) const

Reimplemented from axlAbstractProcess.

Definition at line 125 of file axlFieldSpatialPointDistanceCreator.cpp.

static bool axlFieldSpatialPointDistanceCreator::registered ( void  )
void axlFieldSpatialPointDistanceCreator::setInput ( dtkAbstractData *  data,
int  channel = 0 

Definition at line 54 of file axlFieldSpatialPointDistanceCreator.cpp.

void axlFieldSpatialPointDistanceCreator::setParameter ( double  data,
int  channel = 0 

Definition at line 66 of file axlFieldSpatialPointDistanceCreator.cpp.

int axlFieldSpatialPointDistanceCreator::update ( void  )

Definition at line 79 of file axlFieldSpatialPointDistanceCreator.cpp.

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