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 ()=0
	~IWorkflowComponent destructor for IWorkflowComponent class. More...
virtual IWorkflowComponentInfo *	componentInfo () const =0
	componentInfo More...
virtual void	initialize ()=0
	initialize More...
virtual void	update ()=0
	update More...
virtual void	finish ()=0
	finish More...
virtual WorkflowStatus	status () const =0
	status More...
virtual list< IModelComponent * >	modelComponents () const =0
	modelComponents More...
virtual void	addModelComponent (IModelComponent *component)=0
	addModelComponent More...
virtual void	removeModelComponent (IModelComponent *component)=0
	removeModelComponent More...
virtual void	registerComponentStatusChangedListener (const function< void(const IWorkflowComponent *, WorkflowStatus, const string &)> &workflowComponentStatusChangedListener)=0
	registerComponentStatusChanged registers a listener that is called when the status of the component changes. More...
virtual void	deRegisterComponentStatusChangedListener (const function< void(const IWorkflowComponent *, WorkflowStatus, const string &)> &workflowComponentStatusChangedListener)=0
	deRegisterComponentStatusChangedListener() method deregisters a listener that is called when the status of the component changes. More...
Public Member Functions inherited from HydroCouple::IIdentity
virtual	~IIdentity ()=0
	IIdentity::~IIdentity is a virtual destructor. More...
virtual string	id () const =0
	Gets a unique identifier for the entity. More...
Public Member Functions inherited from HydroCouple::IDescription
virtual	~IDescription ()=0
	IDescription::~IDescription is a virtual destructor. More...
virtual string	caption () const =0
	Gets caption for the entity. More...
virtual void	setCaption (const string &caption)=0
	Sets caption for the entity. More...
virtual string	description () const =0
	Gets additional descriptive information for the entity. More...
virtual void	setDescription (const string &description)=0
	Gets additional descriptive information for the entity. More...
Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual	~IPropertyChanged ()=0
	IPropertyChanged::~IPropertyChanged is a virtual destructor. More...
virtual void	registerPropertyChangedListener (const function< void(const any &, const string &)> &propertyChangedListener)=0
	IPropertyChanged::registerPropertyChangedListener() registers a listener to be called when a property of an object changes. More...
virtual void	deRegisterPropertyChangedListener (const function< void(const any &, const string &propertyName)> &propertyChangedListener)=0
	IPropertyChanged::deRegisterPropertyChangedListener() deregisters a listener that is called when a property of an object changes. More...

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 ( )

pure virtual

~IWorkflowComponent destructor for IWorkflowComponent class.

Member Function Documentation

addModelComponent()

virtual void HydroCouple::IWorkflowComponent::addModelComponent ( IModelComponent *  component )

pure virtual

addModelComponent

Parameters

component

componentInfo()

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

pure virtual

componentInfo

Returns

deRegisterComponentStatusChangedListener()

virtual void HydroCouple::IWorkflowComponent::deRegisterComponentStatusChangedListener ( const function< void(const IWorkflowComponent *, WorkflowStatus, const string &)> &  workflowComponentStatusChangedListener )

pure virtual

deRegisterComponentStatusChangedListener() method deregisters a listener that is called when the status of the component changes.

See HydroCouple::ComponentStatus for the possible states.

finish()

virtual void HydroCouple::IWorkflowComponent::finish ( )

pure virtual

finish

initialize()

virtual void HydroCouple::IWorkflowComponent::initialize ( )

pure virtual

initialize

modelComponents()

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

pure virtual

modelComponents

Returns

registerComponentStatusChangedListener()

virtual void HydroCouple::IWorkflowComponent::registerComponentStatusChangedListener ( const function< void(const IWorkflowComponent *, WorkflowStatus, const string &)> &  workflowComponentStatusChangedListener )

pure virtual

registerComponentStatusChanged registers a listener that is called when the status of the component changes.

Parameters

status	status of the component. See HydroCouple::ComponentStatus for the possible states.
message	message returned from file read operation.

removeModelComponent()

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

pure virtual

removeModelComponent

Parameters

component

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