QAlgorithm
 All Classes Files Functions Typedefs Properties Macros
Macros
qa_macros.h File Reference

Go to the source code of this file.

Macros

#define QA_IN   "algin_"
 Prefix for input properties. More...
 
#define QA_OUT   "algout_"
 Prefix for output properties. More...
 
#define QA_PAR   "par_"
 Prefix for parameters. More...
 
#define QA_INPUT(Type, Name)
 Defines an input property for the algorithm. More...
 
#define QA_INPUT_LIST(Type, Name)
 Defines a list of input properties for the algorithm. More...
 
#define QA_INPUT_VEC(Type, Name)
 Defines a vector of input properties for the algorithm. More...
 
#define QA_OUTPUT(Type, Name)
 Defines an output property for the algorithm. More...
 
#define QA_PARAMETER(Type, Name, Default)
 Defines a parameter of the algorithm. More...
 
#define QA_CTOR_INHERIT
 Make a subclass inherit QAlgorithm's default constructor. More...
 
#define QA_IMPL_CREATE(ClassName)
 Define the create static method in a subclass. More...
 

Detailed Description

Convenience macros that improves usability.

Definition in file qa_macros.h.

Macro Definition Documentation

#define QA_CTOR_INHERIT
Value:
public: \
using QAlgorithm::QAlgorithm; \
protected: \
using QAlgorithm::setup;
QAlgorithm::setup
virtual void setup()
Set of instructions to set up the algorithm.
Definition: QAlgorithm.cpp:144
QAlgorithm::QAlgorithm
QAlgorithm(QObject *parent=Q_NULLPTR)
Constructor.
Definition: QAlgorithm.cpp:113

Make a subclass inherit QAlgorithm's default constructor.

This macro is to be used in each direct subclass of QAlgoritm to make it inherit the default constructor and the QAlgorithm::setup method.
This is useful if no further customization is needed, and mandatory is no other constructor is defined.

See Also
QAlgorithm, setup

Definition at line 245 of file qa_macros.h.

#define QA_IMPL_CREATE (   ClassName)
Value:
public: \
static inline QSharedPointer<ClassName> create(QAPropertyMap parameters = QAPropertyMap(), \
QObject* parent = Q_NULLPTR){ \
auto ptr = QSharedPointer<ClassName>(new ClassName(parent), &QObject::deleteLater); \
ptr->setup(); \
if(!parameters.isEmpty()){ \
ptr->setParameters(parameters); \
} \
ptr->init(); \
return ptr; \
}
QAPropertyMap
QMap< QString, QVariant > QAPropertyMap
Definition: QAlgorithm.h:34

Define the create static method in a subclass.

This macro is meant to be used in a subclass of QAlgorithm, but it's not mandatory. It defines a predefined create static method, that allocates a new instance of that subclass and returns a QSharedPointer to it. It also allows to directly pass the parameters and the inputs on creation, saving several lines of code.

The create method is a wrapper around a set of operations:

Note: this macro cannot be used in abstract subclass.

Parameters
[in]ClassNameName of the subclass which inherit from QAlgorithm.

Definition at line 273 of file qa_macros.h.

#define QA_IN   "algin_"

Prefix for input properties.

Definition at line 29 of file qa_macros.h.

Referenced by QAlgorithm::getInput(), operator<<(), QAlgorithm::propagateExecution(), and QAlgorithm::setParameters().

#define QA_INPUT (   Type,
  Name 
)
Value:
Q_PROPERTY(Type algin_##Name MEMBER m_algin_##Name READ getIn##Name WRITE setIn##Name) \
private: \
Type m_algin_##Name; \
public: \
void setIn##Name (Type value){ \
this->m_algin_##Name = value; \
} \
Type getIn##Name () const{ \
return this->m_algin_##Name; \
} \
Type& getInRef##Name (){ \
return std::ref(this->m_algin_##Name); \
} \
Type&& getInMove##Name (){ \
return std::move(this->m_algin_##Name); \
}

Defines an input property for the algorithm.

The purpose of this macro is to be used in subclasses of the QAlgorithm class and allows to easily define an input to the algorithm. This macro registers a property of type Type called QA_IN<Name> in the Qt's MetaObject System (calling Q_PROPERTY). It automatically defines a member attribute for the subclass called m_QA_IN<Name> using the keyword MEMBER of Q_PROPERTY.
QA_INPUT generates setter and getter methods for the given property; the name convention used is:

  • setIn<Name> for the setter
  • getIn<Name> for the const getter
  • getInRef<Name> for the getter that returns a reference to the property
  • getInMove<Name> for the move getter, that returns an rvalue to the property
Parameters
[in]TypeType of the property; must be registered in the Qt's MetaObject System.
[in]NameName of the property.
See Also
QA_INPUT_LIST, QA_INPUT_VEC, QA_OUTPUT, QA_PARAMETER

Definition at line 64 of file qa_macros.h.

#define QA_INPUT_LIST (   Type,
  Name 
)
Value:
Q_PROPERTY(Type algin_##Name MEMBER m_algin_##Name WRITE setIn##Name) \
private: \
Type m_algin_##Name; \
QList<Type> m_listin_##Name; \
public: \
void setIn##Name (Type value){ \
this->m_algin_##Name = value; \
this->m_listin_##Name << value; \
} \
QList<Type> getIn##Name () const{ \
return this->m_listin_##Name; \
} \
QList<Type>& getInRef##Name (){ \
return std::ref(this->m_listin_##Name); \
} \
QList<Type>&& getInMove##Name (){ \
return std::move(this->m_listin_##Name); \
}

Defines a list of input properties for the algorithm.

The purpose of this macro is to be used in subclasses of the QAlgorithm class and allows to easily define an input to the algorithm. This macro registers a property of type Type called QA_IN<Name> in the Qt's MetaObject System (calling Q_PROPERTY). It automatically defines two member attributes using the keyword MEMBER of Q_PROPERTY:

  • one called m_QA_IN<Name> and type Type
  • one called m_listin_<Name> and type QList<Type>

QA_INPUT_LIST generates setter and getter methods for the given property; the name convention used is:

  • setIn<Name> for the setter; it takes a value of type Type as input and appends it to the list of inputs.
  • getIn<Name> for the const getter, that returns the list of inputs.
  • getInRef<Name> for the getter that returns a reference to the list of inputs.
  • getInMove<Name> for the move getter, that returns an rvalue to the list of inputs.
Parameters
[in]TypeType of a single property of the list; must be registered in the Qt's MetaObject System.
[in]NameName of the property list.
See Also
QA_INPUT, QA_INPUT_VEC, QA_OUTPUT, QA_PARAMETER

Definition at line 108 of file qa_macros.h.

#define QA_INPUT_VEC (   Type,
  Name 
)
Value:
Q_PROPERTY(Type algin_##Name MEMBER m_algin_##Name WRITE setIn##Name) \
private: \
Type m_algin_##Name; \
QVector<Type> m_vecin_##Name; \
public: \
void setIn##Name (Type value){ \
this->m_algin_##Name = value; \
this->m_vecin_##Name << value; \
} \
QVector<Type> getIn##Name () const{ \
return this->m_vecin_##Name; \
} \
QVector<Type>& getInRef##Name (){ \
return std::ref(this->m_vecin_##Name); \
} \
QVector<Type>&& getInMove##Name (){ \
return std::move(this->m_vecin_##Name); \
}

Defines a vector of input properties for the algorithm.

The purpose of this macro is the same of QA_INPUT_LIST, but instead of appending to a QList, uses a QVector. Its intent is to be used whenever memory contiguity is of concern.

Parameters
[in]TypeType of a single property of the vector; must be registered in the Qt's MetaObject System.
[in]NameName of the property list.
See Also
QA_INPUT, QA_INPUT_LIST, QA_OUTPUT, QA_PARAMETER

Definition at line 142 of file qa_macros.h.

#define QA_OUT   "algout_"

Prefix for output properties.

Definition at line 34 of file qa_macros.h.

Referenced by QAlgorithm::getInput(), and operator<<().

#define QA_OUTPUT (   Type,
  Name 
)
Value:
Q_PROPERTY(Type algout_##Name MEMBER m_algout_##Name READ getOut##Name WRITE setOut##Name) \
private: \
Type m_algout_##Name; \
protected: \
void setOut##Name (Type value){ \
this->m_algout_##Name = value; \
} \
public: \
Type getOut##Name () const{ \
return this->m_algout_##Name; \
} \
Type& getOutRef##Name (){ \
return std::ref(this->m_algout_##Name); \
} \
Type&& getOutMove##Name (){ \
return std::move(this->m_algout_##Name); \
}

Defines an output property for the algorithm.

The purpose of this macro is to be used in subclasses of the QAlgorithm class and allows to easily define an output to the algorithm. This macro registers a property of type Type called QA_OUT<Name> in the Qt's MetaObject System (calling Q_PROPERTY). It automatically defines a member attribute for the subclass called m_QA_OUT<Name> using the keyword MEMBER of Q_PROPERTY.
QA_OUTPUT generates setter and getter methods for the given property; the name convention used is the same as in QA_INPUT.

Parameters
[in]TypeType of the property; must be registered in the Qt's MetaObject System.
[in]NameName of the property.
See Also
QA_INPUT, QA_INPUT_LIST, QA_INPUT_VEC, QA_PARAMETER

Definition at line 181 of file qa_macros.h.

#define QA_PAR   "par_"

Prefix for parameters.

Definition at line 39 of file qa_macros.h.

Referenced by QAlgorithm::getInput(), operator<<(), and QAlgorithm::setParameters().

#define QA_PARAMETER (   Type,
  Name,
  Default 
)
Value:
Q_PROPERTY(Type par_##Name READ get##Name WRITE set##Name) \
private: \
Type par_##Name = Default; \
public: \
void set##Name (Type value){ \
this->par_##Name = value; \
} \
Type get##Name (){ \
return this->par_##Name; \
}

Defines a parameter of the algorithm.

The purpose of this macro is to be used in subclasses of the QAlgorithm class and allows to easily define a parameter to the algorithm. This macro registers a property of type Type called QA_PAR<Name> in the Qt's MetaObject System (calling Q_PROPERTY). It automatically defines a member attribute for the subclass called QA_PAR<Name>.
QA_PARAMETER generates setter and getter methods for the given property; the name convention used is:

  • setIn<Name> for the setter
  • getIn<Name> for the getter
Parameters
[in]TypeType of the property; must be registered in the Qt's MetaObject System.
[in]NameName of the property.
[in]DefaultValue of type Type to be used as default for the parameter.
See Also
QA_INPUT, QA_INPUT_LIST, QA_INPUT_VEC, QA_OUTPUT

Definition at line 221 of file qa_macros.h.