Allows an input to variable directly to the output. More...

#include <Workspace/DataExecution/Operations/Builtin/variable.h>

Inheritance diagram for Variable:

Public Member Functions
	Variable ()

	~Variable () override

bool	canChangeDataFactory (const DataFactory &factory) const override

bool	canChangeDataName (const QString &name) const override

bool	execute () override

InputScalar &	getMainInput ()

const InputScalar &	getMainInput () const

Output &	getMainOutput ()

const Output &	getMainOutput () const

Public Member Functions inherited from PolymorphicDataOperation
	PolymorphicDataOperation (const OperationFactory &opFactory, const QString &opName, const DataFactory &dataFactory, const QString &dataName=QString(), bool isNameable=true)

	~PolymorphicDataOperation () override

virtual bool	canChangeDataFactory (const DataFactory &factory) const =0

virtual bool	canChangeDataName (const QString &name) const =0

Presentation::CustomOperationProperties *	createCustomPropertiesHandler () override

virtual QString	getAcceptableDataName (const QString &proposedName) const

const DataFactory &	getDataFactory () const

const QString &	getDataName () const

DataObject &	getDataObject ()

template<typename T >
bool	isDataType () const

bool	isDataType (const DataFactory &type) const

bool	isNameable () const

bool	isPolymorphicType () const override

bool	isUserConfigurable () override

bool	matchesDataType (const DataObject &otherObject) const

bool	setDataFactory (const DataFactory &factory)

bool	setDataName (const QString &name)

Public Member Functions inherited from Operation
	~Operation () override

bool	addInput (Input &input, bool modifiedInPlace=false)

bool	addOutput (Output &output)

template<typename T >
bool	assignInput (const QString &inputName, const T &value)

bool	canSerialize () const override

bool	connectProgressEvents (QProgressBar *progressBar)

virtual Presentation::CustomOperationProperties *	createCustomPropertiesHandler ()

virtual void	ensureHasData ()

bool	getBroadcastUpdateEvents () const

QColor	getColor () const

virtual QString	getDefaultIconPath () const

QString	getDefaultUiPath () const

QString	getDeprecationMessage () const

const QString &	getDescription () const

SerializedItem	getExtras ()

const OperationFactory &	getFactory () const

Operation *	getFromPath (const QString &path, Workspace &relativeTo, QStringList &errors) const override

virtual GraphicsSize	getGraphicsSize () const

virtual QString	getHelpPage () const

QString	getIconPath () const

const QUuid &	getId () const

QString	getIdPath (bool scoped=true) const override

QString	getIdPath (const Workspace &relativeTo) const

difference_type	getIndex (const Input &input, IndexCountingOptions options=SkipNone) const

difference_type	getIndex (const Output &output, IndexCountingOptions options=SkipNone) const

void	getIndexPair (InputScalar &input, difference_type &mainIndex, difference_type &arrayIndex)

Input *	getInput (const QString &name)

const Input *	getInput (const QString &name) const

Input *	getInput (size_type index)

const Input *	getInput (size_type index) const

InputArray *	getInputArray (const QString &name)

const InputArray *	getInputArray (const QString &name) const

IOBaseIteratorRange< Input, false >	getInputs ()

IOBaseIteratorRange< Input, true >	getInputs () const

InputScalar *	getInputScalar (const QString &name)

const InputScalar *	getInputScalar (const QString &name) const

template<typename T >
T &	getInputValue (const QString &inputName)

template<typename T >
const T &	getInputValue (const QString &inputName) const

const QString &	getLabel () const

QString	getLabelRelativeToRoot () const

Output *	getOutput (const QString &name)

const Output *	getOutput (const QString &name) const

Output *	getOutput (size_type index)

const Output *	getOutput (size_type index) const

IOBaseIteratorRange< Output, false >	getOutputs ()

IOBaseIteratorRange< Output, true >	getOutputs () const

template<typename T >
T &	getOutputValue (const QString &outputName)

template<typename T >
const T &	getOutputValue (const QString &outputName) const

bool	getProfilingEnabled () const

int	getProgress () const

int	getProgressContribution () const

bool	getProgressResetByNotUpToDate () const

virtual SchedulerFeatures	getRequiredSchedulerFeatures () const

InputScalar *	getScalarInput (size_type mainIndex, difference_type arrayIndex)

QString	getShortLabel () const

QString	getTagName () const

bool	getTerminateExecution () const

QString	getUiPath () const

bool	getUpToDate () const override

virtual bool	hasRequiredSchedulerFeatures () const

void	idPathChanged () override

virtual bool	inputRebuilt (InputScalar &input)

virtual bool	isAsynchronous () const

virtual bool	isAtomicUpdate () const

bool	isConnectedToAsynchronous () const override

bool	isDeprecated () const

bool	isEditable () const

bool	isIdPathCachingEnabled () const

virtual bool	isPolymorphicType () const

virtual bool	isRunningAsynchronously () const

virtual bool	isThreadSafe () const

template<typename T >
bool	isType () const

bool	isType (const OperationFactory &type) const

bool	isUpdating () const

virtual bool	isUserConfigurable ()

bool	isUsingDefaultColor () const

bool	isUsingDefaultIconPath () const

bool	isUsingDefaultUiPath () const

bool	isWaitingForAsynchronousUpdate () const override

bool	isWorkspaceType () const

bool	load (const SerializedItem &item) override

void	markUpToDateWhereSafe ()

bool	matchesType (const Operation &otherOperation) const

size_type	numInputs (IndexCountingOptions=SkipNone) const

size_type	numOutputs (IndexCountingOptions=SkipNone) const

bool	removeInput (const QString &name)

bool	removeInput (Input &input)

bool	removeOutput (const QString &name)

bool	removeOutput (Output &output)

virtual void	resetExecutionDependencies ()

bool	save (SerializedItem &item) const override

virtual bool	saveWithData (SerializedItem &item) const

virtual void	setAtomicUpdate (bool atomic)

void	setBroadcastUpdateEvents (bool enable)

void	setColor (const QColor &c)

void	setDescription (const QString &description)

void	setEditable (bool b)

void	setIconPath (const QString &path)

void	setId (const QUuid &id)

virtual void	setIdPathCachingEnabled (bool b)

virtual void	setInputNotUpToDate (InputScalar &input)

virtual void	setIsAsynchronous (bool asynchronous)

virtual void	setIsRunningAsynchronously (bool asynchronous)

void	setLabel (const QString &label)

virtual void	setOutputNotUpToDate (Output &output)

void	setProfilingEnabled (bool enable)

virtual void	setProgress (int percent)

void	setProgressContribution (int percent)

void	setProgressResetByNotUpToDate (bool b)

virtual void	setRequiredSchedulerFeatures (const SchedulerFeatures &)

void	setTerminateExecution (bool b)

void	setUiPath (const QString &path)

void	setUpToDate (bool b) override

bool	update (Updater *updater=nullptr) override

Public Member Functions inherited from WorkspaceElement
	~WorkspaceElement () override

const Workspace *	getWorkspace () const override

Workspace *	getWorkspace () override

virtual void	workspaceChanged (Workspace *oldWorkspace)

Public Member Functions inherited from Updatable
	~Updatable () override

virtual bool	comesFromExternal () const

QString	getEnclosingScope () const

virtual Updatable *	getFromPath (const QString &path, Workspace &relativeTo, QStringList &errors) const =0

const QString &	getGlobalName () const

virtual QString	getIdPath (bool scoped=true) const =0

virtual Workspace *	getRootWorkspace ()

virtual const Workspace *	getRootWorkspace () const

QString	getScopedGlobalName () const

virtual bool	getUpToDate () const =0

virtual const Workspace *	getWorkspace () const =0

virtual Workspace *	getWorkspace ()=0

virtual void	idPathChanged ()

virtual bool	isConnectedToAsynchronous () const =0

virtual bool	isWaitingForAsynchronousUpdate () const =0

void	setGlobalName (const QString &name)

virtual void	setUpToDate (bool b)=0

virtual bool	update (Updater *updater=nullptr)=0

Public Member Functions inherited from Observable
virtual	~Observable ()

void	attachObserver (Observer &observer)

void	destroy ()

void	detachObserver (Observer &observer)

void	notifyEvent (const ObservableEvent &event)

Public Member Functions inherited from Serialize
virtual	~Serialize ()=default

virtual bool	canSerialize () const =0

virtual bool	load (const SerializedItem &item)=0

virtual bool	save (SerializedItem &item) const =0

Public Member Functions inherited from TextLogger
	TextLogger ()

	TextLogger (const DataExecution::IOBase &io)

	TextLogger (const DataExecution::Operation &operation)

	TextLogger (const TextLogger &logger)

	TextLogger (TextLogger &&logger)

virtual	~TextLogger ()

void	logLine (const Application::LogManager::MessageCategory &category, const QString &msg) const

void	logLine (const QString &msg) const

void	logText (const Application::LogManager::MessageCategory &category, const QString &msg) const

void	logText (const QString &msg) const

TextLogger &	operator= (TextLogger)

Protected Member Functions
void	dataNameChanged (const QString &name) override

void	dataObjectChanged (DataObject &oldDataObject) override

bool	prepareInputsOutputsForLoad (const SerializedItem &item) override

Protected Member Functions inherited from PolymorphicDataOperation
virtual void	dataNameChanged (const QString &name)

virtual void	dataObjectAboutToChange ()

virtual void	dataObjectChanged (DataObject &oldDataObject)

bool	loadPolyPart (const QString &dataPlugin, const QString &dataType, const QString &dataName)

bool	postSave (SerializedItem &item) const override

bool	prepareInputsOutputsForLoad (const SerializedItem &item) override

Protected Member Functions inherited from Operation
	Operation (const OperationFactory &factory, const QString &label)

bool	bringArrayOfInputsUpToDate (Input *&array, size_type arraySize)

bool	bringArrayOfInputsUpToDate (std::vector< Input * > &array)

virtual bool	bringInputsUpToDate ()

bool	bringInputUpToDate (Input &input)

virtual void	cancelExecution (bool b)

virtual bool	execute ()=0

virtual bool	finishInputsOutputsAfterLoad (const SerializedItem &item)

Updater *	getCurrentUpdater ()

virtual const Input *	getRenamedInput (const QString &name) const

virtual const Output *	getRenamedOutput (const QString &name) const

virtual bool	inputsAreUpToDate () const

virtual bool	makeOutputsValid ()

virtual void	markOutputsUpToDate ()

void	pauseUpdate ()

virtual bool	postSave (SerializedItem &item) const

virtual bool	prepareInputsOutputsForLoad (const SerializedItem &item)

void	saveExtras (SerializedItem &item) const

virtual bool	shouldPutInExtras (const QString &tagName) const

Protected Member Functions inherited from WorkspaceElement
	WorkspaceElement ()

Protected Member Functions inherited from Updatable
	Updatable ()

	Updatable (const Updatable &up)

void	notifyUpdated ()

Updatable &	operator= (const Updatable &up)

Protected Member Functions inherited from Observable
	Observable ()

	Observable (const Observable &)

Additional Inherited Members
Public Types inherited from Operation
enum	ConfigStatus { GoodConfig = 0x00 , UnknownConfig = 0x01 , InvalidConfig = 0x02 }

using	difference_type = ptrdiff_t

enum	GraphicsSize { Default = 100 , Small = 65 }
	Options for the graphical size of an operation, able to be changed by derived classes. Values are percentages. More...

enum	IndexCountingOption { SkipNone = 0x0 , SkipInvisible = 0x1 , SkipDependencies = 0x2 }

using	size_type = size_t

Static Public Member Functions inherited from Updatable
static InputScalar *	findInputScalarGlobalName (const QString &scopedGlobalName, Workspace &relativeTo)

static IOBase *	findIOBaseGlobalName (const QString &scopedGlobalName, Workspace &relativeTo)

static Operation *	findOperationGlobalName (const QString &scopedGlobalName, Workspace &relativeTo)

Detailed Description

This operation may seem fairly useless, but it does make possible some useful techniques. For example, the operation can be used as a data source without having to expose it to parent workspaces, thus centralizing where a data object is defined but still keeping it private to the current workspace. Another useful scenario is to use the variable operation as a place to insert some more complicated dependency relationship between two other operations.

Constructor & Destructor Documentation

◆ Variable()

Variable ( )

Constructs as a data source for an integer by default.

◆ ~Variable()

~Variable ( )

override

Ensures the source's input in any parent workspace is handled safely during the destruction sequence.

Member Function Documentation

◆ canChangeDataFactory()

bool canChangeDataFactory ( const DataFactory & factory ) const

overridevirtual

Parameters

factory The new factory that will be set.

This function is called by setDataFactory to determine if the data factory can indeed be changed. The old factory is still available by calling getDataFactory, since nothing has actually been changed at the point where canChangeDataFactory is called. It may also be called by other clients who are interested in knowing if a particular data factory change will be allowed before actually requesting the factory change.

Returns: True if the subclass is happy for the data factory to be set to factory. The subclass can return false to indicate that the data factory cannot be changed to factory, or indeed that it cannot be changed at all (ie to anything).

Implements PolymorphicDataOperation.

◆ canChangeDataName()

bool canChangeDataName ( const QString & name ) const

overridevirtual

Parameters

name	The new data name that will be set.

This function is called by setDataName to determine if the data name can indeed be changed. The old name is still available by calling getDataName, since nothing has actually been changed at the point where canChangeDataName is called. It may also be called by other clients who are interested in knowing if a particular name change will be allowed before actually requesting the name change.

Returns: True if the subclass is happy for the data name to be set to name. The subclass can return false to indicate that the data name cannot be changed to name, or indeed that it cannot be changed at all (ie to anything).

Implements PolymorphicDataOperation.

◆ dataNameChanged()

void dataNameChanged ( const QString & name )

overrideprotectedvirtual

Parameters

name	The new data name. This is the same as the return value from getDataName(). It is provided as a parameter merely for convenience and consistency.

This function is called by setDataName() once the data name has been changed. We reimplement the function here so that the output from the operation also has its name changed to name.

Reimplemented from PolymorphicDataOperation.

◆ dataObjectChanged()

void dataObjectChanged ( DataObject & oldDataObject )

overrideprotectedvirtual

Parameters

oldDataObject The old data object, which will be destroyed immediately after dataObjectChanged() returns. The new data object can be obtained by calling getDataObject().

Precondition: The up to date status of the operation will not yet have been reset. This will be done immediately after dataObjectChanged() returns.

This function is called by setDataFactory once the data object has been changed. It allows the subclass to take additional action to update itself before the process of changing the data factory is completed. After exit, the only thing setDataFactory will subsequently do is call setUpToDate(false) on the operation.

The default implementation does nothing.

Note: This function cannot do anything which might fail.

See also: dataObjectAboutToChange()

Reimplemented from PolymorphicDataOperation.

◆ execute()

bool execute ( )

overridevirtual

Subclasses need to implement this function to do the actual processing of the operation. Clients should not call this function directly, but should instead call the update() function, since it ensures all inputs are updated first and all outputs have setUpToDate called on each one.

Precondition: When called, this function can assume that all of its required inputs have already been brought up to date.

Postcondition: When this function exits, all of the operation's outputs need to have had their values set. It is not required that setUpToDate be called for each output, since this is done by the update() function after execute() returns.

Returns: True if the operation was able to execute successfully.

Implements Operation.

◆ getMainInput() [1/2]

InputScalar & getMainInput ( )

Returns: Returns the main input that supplies data to this Variable operation.

◆ getMainInput() [2/2]

const InputScalar & getMainInput ( ) const

Returns: Returns the main input that supplies data to this Variable operation.

◆ getMainOutput() [1/2]

Output & getMainOutput ( )

Returns: Returns the main output that this Variable operation supplies data to.

◆ getMainOutput() [2/2]

const Output & getMainOutput ( ) const

Returns: Returns the main output that this Variable operation supplies data to.

◆ prepareInputsOutputsForLoad()

bool prepareInputsOutputsForLoad ( const SerializedItem & item )

overrideprotectedvirtual

Loads the details of the data type this operation will be associated with. If subclasses override prepareInputsOutputsForLoad() for themselves, they would normally call PolymorphicDataOperation::prepareInputsOutputsForLoad() as their first step before performing any processing specific to the subclass.

Reimplemented from PolymorphicDataOperation.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Variable()

◆ ~Variable()

Member Function Documentation

◆ canChangeDataFactory()

◆ canChangeDataName()

◆ dataNameChanged()

◆ dataObjectChanged()

◆ execute()

◆ getMainInput() [1/2]

◆ getMainInput() [2/2]

◆ getMainOutput() [1/2]

◆ getMainOutput() [2/2]

◆ prepareInputsOutputsForLoad()