An Action that can be created on the fly from C++ code It must watch the source code and rebuild when necessary. More...

#include <CppHotPlugAction.h>

Inheritance diagram for camitk::CppHotPlugAction:

Collaboration diagram for camitk::CppHotPlugAction:

Public Slots
virtual Action::ApplyStatus	apply () override
	this method is automatically called when the action is triggered.

Public Slots inherited from camitk::HotPlugAction
virtual Action::ApplyStatus	apply () override=0
	this method is automatically called when the action is triggered.

Public Slots inherited from camitk::Action
virtual camitk::Action::ApplyStatus	apply ()=0
	This method is called when the action has to be applied on the target list (get the target lists using getTargets()) It calls the algorithm of your action on the target list of components.

camitk::Action::ApplyStatus	applyAndRegister ()
	This method is called whenever the action has to be applied on the target list (like the apply()) method AND registered within the application history of actions.

camitk::Action::ApplyStatus	trigger (QWidget *parent=nullptr)
	This method triggers the action.

Public Member Functions
	CppHotPlugAction (HotPlugActionExtension *actionExtension, const VariantDataModel &data)
	Default Constructor calls user-defined init()

virtual QWidget *	getWidget () override
	Calls user-defined targetDefined() and getUI()

virtual bool	init () override
	calls user-defined init() if found

virtual bool	needsUpdate () override
	returns true if and only if the user library has changed since the last update or update was not completed successfully

virtual bool	update () override
	update the library and returns true if the process method was found

virtual	~CppHotPlugAction ()=default
	Default Destructor.

Public Member Functions inherited from camitk::HotPlugAction
virtual bool	event (QEvent *e) override
	manage property change immediately

	HotPlugAction (HotPlugActionExtension *actionExtension, const VariantDataModel &data)
	Default Constructor.

virtual	~HotPlugAction ()=default
	Default Destructor.

Public Member Functions inherited from camitk::Action
	Action (ActionExtension *)
	Default Constructor: the ActionExtension is needed.

	~Action () override
	Destructor.

virtual QAction *	getQAction (Component *target=nullptr)
	Get the corresponding QAction.

QString	getName () const
	get the name of the action

QString	getDescription () const
	the description of the action

QString	getComponentClassName () const
	the name of the component class that can be used by this action

QString	getFamily () const
	the name of the family in which this action is associated

QString	getExtensionName () const
	the name of the extension in the family in which this action is associated

QStringList	getTag () const
	the name of the tag called this action

bool	getEmbedded () const
	argument use to know if the widget is embedded or not

void	setDefaultWidgetButtonVisibility (bool)
	if false then the apply/revert buttons are shown

void	setDefaultWidgetApplyButtonText (QString)
	modify the "Apply" button text

virtual QPixmap	getIcon ()
	the icon to personalize the action (no icon by default)

const ComponentList	getTargets () const
	the currently selected and valid (regarding the component property) components, for which this action is called

void	updateTargets ()
	update the target list using the currently selected components

bool	getAutoUpdateProperties () const

void	setAutoUpdateProperties (bool)
	are the properties to be updated every time the user makes a change in the widget (default is false)?

virtual Q_INVOKABLE camitk::Property *	getProperty (QString name)
	Get a Property given its name.

virtual QVariant	getParameterValue (const QString &name) const
	get the parameter QVariant (same as property(const char*)) but check if it exists first.

virtual bool	setParameterValue (const QString &name, QVariant newValue)
	set the parameter QVariant value (same as setProperty(const char*, newValue)) but check if it exists first.

virtual QString	getParameterValueAsString (const QString &name) const
	utility method to get the parameter value as a QString (useful to print the value to log for instance) This method uses Property class to translate the value to a QString

virtual bool	addParameter (Property *)
	Add a new parameter to the action, using the CamiTK property class.

virtual QVariant	toVariant () const override

virtual void	fromVariant (const QVariant &) override
	Load data from a QVariant to initialize the current object.

virtual QUuid	getUuid () const override
	Get the unique ID of the action.

virtual bool	setUuid (QUuid) override
	Set the unique ID of the action.

ApplyStatus	applyInPipeline ()
	This method encapsulates the apply() method.

void	setInputComponents (ComponentList inputs)
	Specify the input Component(s) Only applyInPipeline() should be called with this method (maybe apply), but not trigger() as its first intruction is to clear the target components list !!!

void	setInputComponent (Component *input)
	Specify the input Components in case of only one Component.

ComponentList	getOutputComponents ()
	Returns the output Component(s)

Component *	getOutputComponent ()
	Returns the output Components in case of only one Component.

Public Member Functions inherited from camitk::InterfacePersistence
virtual	~InterfacePersistence ()=default

Protected Member Functions
virtual void	parameterChangedEvent (QString parameterName) override
	Call the C++ symbol parameterChanged.

Protected Member Functions inherited from camitk::Action
const ActionExtension *	getExtension () const
	get the extension as const

void	refreshApplication ()
	convenient method to call from the user code to refresh all the application This is equivalent to call Application::refresh()

void	setName (QString name)

void	setDescription (QString description)
	the description of the action

void	setComponentClassName (QString componentClassName)
	set the name of the component class that can be used by this action

void	setFamily (QString family)
	the name of the family in which this action is associated

void	addTag (QString tag)
	add a tag to the tags list of this action

void	setEmbedded (bool isEmbedded)
	set the embedded property (an action is embedded by default, unless specified otherwise by explicitly calling this method with false)

void	setIcon (QPixmap)
	set the Pixmap

Additional Inherited Members
Public Types inherited from camitk::Action
enum	ApplyStatus { SUCCESS , ERROR , WARNING , ABORTED , TRIGGERED }
	describes what happened during the application of an algorithm (i.e. results of the apply method) More...

Static Public Member Functions inherited from camitk::Action
static QString	getStatusAsString (ApplyStatus)

Protected Attributes inherited from camitk::HotPlugAction
HotPlugActionExtension *	hotPlugExtension
	where the action is managed

Protected Attributes inherited from camitk::Action
QWidget *	actionWidget
	the action widget

Detailed Description

An Action that can be created on the fly from C++ code It must watch the source code and rebuild when necessary.

Note that the rebuild process itself is managed by HotPlugActionExtension, but watching if the source code has changed is managed by this class.

Constructor & Destructor Documentation

◆ CppHotPlugAction()

camitk::CppHotPlugAction::CppHotPlugAction	(	HotPlugActionExtension *	actionExtension,
		const VariantDataModel &	data
	)

Default Constructor calls user-defined init()

References VariantDataModel::getValue(), TransformEngine::transformToString(), and update().

Here is the call graph for this function:

◆ ~CppHotPlugAction()

virtual camitk::CppHotPlugAction::~CppHotPlugAction ( )

virtualdefault

Default Destructor.

Member Function Documentation

◆ apply

Action::ApplyStatus camitk::CppHotPlugAction::apply ( )

overridevirtualslot

this method is automatically called when the action is triggered.

Call getTargets() method to get the list of components to use.

Note: getTargets() is automatically filtered so that it only contains compatible components, i.e., instances of "$componentClass$" (or a subclass).

References camitk::Action::ERROR.