HydroCouple  1.0.0
Description of the HydroCouple Component-Based Model Coupling Interface Definitions
HydroCouple::IWorkflowComponent Class Referenceabstract

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...
 

Signals

virtual void componentStatusChanged (WorkflowStatus status, const QString &message)=0
 
- Signals inherited from HydroCouple::IPropertyChanged
virtual void propertyChanged (const QString &propertyName)=0
 IPropertyChanged::propertyChanged() is called to emit signal/event when property of child class changes. More...
 

Public Member Functions

virtual ~IWorkflowComponent ()
 ~IWorkflowComponent More...
 
virtual IWorkflowComponentInfocomponentInfo () 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 QList< IModelComponent * > modelComponents () const =0
 modelComponents More...
 
virtual void addModelComponent (IModelComponent *component)=0
 addModelComponent More...
 
virtual void removeModelComponent (IModelComponent *component)=0
 removeModelComponent More...
 
- Public Member Functions inherited from HydroCouple::IIdentity
virtual ~IIdentity ()
 
virtual QString id () const =0
 Gets a unique identifier for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IDescription
virtual ~IDescription ()
 
virtual QString caption () const =0
 Gets caption for the entity. More...
 
virtual void setCaption (const QString &caption)=0
 Sets caption for the entity. More...
 
virtual QString description () const =0
 Gets additional descriptive information for the entity. More...
 
virtual void setDescription (const QString &description)=0
 Gets additional descriptive information for the entity. More...
 
- Public Member Functions inherited from HydroCouple::IPropertyChanged
virtual ~IPropertyChanged ()
 

Detailed Description

The IDataExchangeWorkflowComponent class.

Member Enumeration Documentation

The WorkflowStatus enum.

Enumerator
Created 
Initializing 
Initialized 
Updating 
Updated 
Done 
Finishing 
Finished 
Failed 

Constructor & Destructor Documentation

virtual HydroCouple::IWorkflowComponent::~IWorkflowComponent ( )
inlinevirtual

~IWorkflowComponent

Member Function Documentation

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

addModelComponent

Parameters
component
virtual IWorkflowComponentInfo* HydroCouple::IWorkflowComponent::componentInfo ( ) const
pure virtual

componentInfo

Returns
virtual void HydroCouple::IWorkflowComponent::componentStatusChanged ( WorkflowStatus  status,
const QString &  message 
)
pure virtualsignal
virtual void HydroCouple::IWorkflowComponent::finish ( )
pure virtual

finish

virtual void HydroCouple::IWorkflowComponent::initialize ( )
pure virtual

initialize

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

modelComponents

Returns
virtual void HydroCouple::IWorkflowComponent::removeModelComponent ( IModelComponent component)
pure virtual

removeModelComponent

Parameters
component
virtual WorkflowStatus HydroCouple::IWorkflowComponent::status ( ) const
pure virtual

status

Returns
virtual void HydroCouple::IWorkflowComponent::update ( )
pure virtual

update


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