Developer documentation | Axl-2.5.1

axlFieldSpatialCoordinatesCreator Class Reference

#include <axlFieldSpatialCoordinatesCreator.h>

Inheritance diagram for axlFieldSpatialCoordinatesCreator:
axlAbstractFieldGenerator axlAbstractProcess

Public Slots

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

Public Member Functions

 axlFieldSpatialCoordinatesCreator (void)
virtual ~axlFieldSpatialCoordinatesCreator (void)
virtual QString description (void) const
virtual 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 29 of file axlFieldSpatialCoordinatesCreator.h.

Constructor & Destructor Documentation

axlFieldSpatialCoordinatesCreator::axlFieldSpatialCoordinatesCreator ( void  )

Definition at line 35 of file axlFieldSpatialCoordinatesCreator.cpp.

axlFieldSpatialCoordinatesCreator::~axlFieldSpatialCoordinatesCreator ( void  )

Definition at line 45 of file axlFieldSpatialCoordinatesCreator.cpp.

Member Function Documentation

QString axlFieldSpatialCoordinatesCreator::description ( void  ) const

Reimplemented from axlAbstractFieldGenerator.

Definition at line 108 of file axlFieldSpatialCoordinatesCreator.cpp.

QString axlFieldSpatialCoordinatesCreator::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 axlFieldSpatialCoordinatesCreator.h.

QString axlFieldSpatialCoordinatesCreator::identifier ( void  ) const

Reimplemented from axlAbstractProcess.

Definition at line 113 of file axlFieldSpatialCoordinatesCreator.cpp.

static bool axlFieldSpatialCoordinatesCreator::registered ( void  )
void axlFieldSpatialCoordinatesCreator::setInput ( dtkAbstractData *  data,
int  channel 

Definition at line 51 of file axlFieldSpatialCoordinatesCreator.cpp.

void axlFieldSpatialCoordinatesCreator::setParameter ( double  value,
int  channel 

Definition at line 62 of file axlFieldSpatialCoordinatesCreator.cpp.

int axlFieldSpatialCoordinatesCreator::update ( void  )

Definition at line 76 of file axlFieldSpatialCoordinatesCreator.cpp.

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