HydroCouple::IWorkflowComponent Class Reference

The IDataExchangeWorkflowComponent class. More...

#include <hydrocouple.h>

Inheritance diagram for HydroCouple::IWorkflowComponent:

Collaboration diagram for HydroCouple::IWorkflowComponent:

Public Types
enum	WorkflowStatus {   Created ,   Initializing ,   Initialized ,   Updating ,   Updated ,   Done ,   Finishing ,   Finished ,   Failed }
	The WorkflowStatus enum. More...

Public Member Functions
virtual	~IWorkflowComponent ()=default
	~IWorkflowComponent destructor for IWorkflowComponent class.
virtual IWorkflowComponentInfo *	componentInfo () const =0
	componentInfo
virtual vector< IIdentity * >	modelComponentLabels () const =0
	requiredModelComponentIdentifiers returns the vector of IModelComponent identifiers that are required by this component.
virtual bool	isRequiredModelComponent (const IIdentity *modelComponentLabel) const =0
	isRequiredModelComponent checks if the model component is required by this component.
virtual void	initialize ()=0
	initialize
virtual void	update ()=0
	update
virtual void	finish ()=0
	finish
virtual WorkflowStatus	status () const =0
	status
virtual vector< IModelComponent * >	modelComponents () const =0
	modelComponents
virtual bool	addModelComponent (IModelComponent *component, const IIdentity *modelRoleIdentifier=nullptr)=0
	addModelComponent Adds model component instance to workflow
virtual bool	removeModelComponent (IModelComponent *component)=0
	removeModelComponent Removes model component instance from workflow
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=default
	IIdentity::~IIdentity is a virtual destructor.
virtual string	id () const =0
	Gets a unique identifier for the entity.
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=default
	IDescription::~IDescription is a virtual destructor.
virtual string	caption () const =0
	Gets caption for the entity.
virtual void	setCaption (const string &caption)=0
	Sets caption for the entity.
virtual string	description () const =0
	Gets additional descriptive information for the entity.
virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity.
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=default
	IPropertyChanged::~IPropertyChanged is a virtual destructor.
Public Member Functions inherited from HydroCouple::ISignal< string >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.
virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.
Public Member Functions inherited from HydroCouple::ISignal< const shared_ptr< IWorkflowComponentStatusChangeEventArgs > & >
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.
virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Additional Inherited Members
Protected Member Functions inherited from HydroCouple::ISignal< string >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.
Protected Member Functions inherited from HydroCouple::ISignal< const shared_ptr< IWorkflowComponentStatusChangeEventArgs > & >
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

The IDataExchangeWorkflowComponent class.

Member Enumeration Documentation

WorkflowStatus

enum HydroCouple::IWorkflowComponent::WorkflowStatus

The WorkflowStatus enum.

Enumerator
Created
Initializing
Initialized
Updating
Updated
Done
Finishing
Finished
Failed

Constructor & Destructor Documentation

~IWorkflowComponent()

virtual HydroCouple::IWorkflowComponent::~IWorkflowComponent ( )

virtualdefault

~IWorkflowComponent destructor for IWorkflowComponent class.

Member Function Documentation

addModelComponent()

virtual bool HydroCouple::IWorkflowComponent::addModelComponent ( IModelComponent *  component, const IIdentity *  modelRoleIdentifier = nullptr  )

pure virtual

addModelComponent Adds model component instance to workflow

Parameters

component	is the IModelComponent to add to the workflow.
modelRoleIdentifier	is the IIdentity of the role of the model component. If null, the component is added as a standalone component. in which case the workflow likely does not require ordered or specific components for its operation.

Returns

True if the component was added successfully, otherwise false.

componentInfo()

virtual IWorkflowComponentInfo * HydroCouple::IWorkflowComponent::componentInfo ( ) const

pure virtual

componentInfo

Returns

finish()

virtual void HydroCouple::IWorkflowComponent::finish ( )

pure virtual

finish

initialize()

virtual void HydroCouple::IWorkflowComponent::initialize ( )

pure virtual

initialize

isRequiredModelComponent()

virtual bool HydroCouple::IWorkflowComponent::isRequiredModelComponent ( const IIdentity *  modelComponentLabel ) const

pure virtual

isRequiredModelComponent checks if the model component is required by this component.

Parameters

modelComponentLabel

is the IIdentity label specifying the model component.

Returns

boolean indicating whether the model component is required by this component.

modelComponentLabels()

virtual vector< IIdentity * > HydroCouple::IWorkflowComponent::modelComponentLabels ( ) const

pure virtual

requiredModelComponentIdentifiers returns the vector of IModelComponent identifiers that are required by this component.

Returns

A vector of IModelComponent identifiers that are required by this component.

modelComponents()

virtual vector< IModelComponent * > HydroCouple::IWorkflowComponent::modelComponents ( ) const

pure virtual

modelComponents

Returns

removeModelComponent()

virtual bool HydroCouple::IWorkflowComponent::removeModelComponent ( IModelComponent *  component )

pure virtual

removeModelComponent Removes model component instance from workflow

Parameters

component

is the IModelComponent to remove from the workflow.

Returns

True if the component was removed successfully, otherwise false.

status()

virtual WorkflowStatus HydroCouple::IWorkflowComponent::status ( ) const

pure virtual

status

Returns

update()

virtual void HydroCouple::IWorkflowComponent::update ( )

pure virtual

update

---

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

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouple.h