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

The IComponentStatusChangeEventArgs contains the information that will be passed when the IModelComponent fires the IModelComponent::statusChanged signal. More...

#include <hydrocouple.h>

Collaboration diagram for HydroCouple::IComponentStatusChangeEventArgs:

Public Member Functions

virtual ~IComponentStatusChangeEventArgs ()
 
virtual IModelComponentcomponent () const =0
 Gets the IModelComponent that fired the event. More...
 
virtual HydroCouple::IModelComponent::ComponentStatus previousStatus () const =0
 Gets the IModelComponent's status before the status change. More...
 
virtual HydroCouple::IModelComponent::ComponentStatus status () const =0
 Gets the IModelComponent's status after the status change. More...
 
virtual QString message () const =0
 Gets additional information about the status change. More...
 
virtual bool hasProgressMonitor () const =0
 A bool indicating whether this event has a progresss monitor. More...
 
virtual float percentProgress () const =0
 Number between 0 and 100 indicating the progress made by a component in its simulation. More...
 

Detailed Description

The IComponentStatusChangeEventArgs contains the information that will be passed when the IModelComponent fires the IModelComponent::statusChanged signal.

Sending exchange item events is optional, so it should not be used as a mechanism to build critical functionality upon.

Constructor & Destructor Documentation

virtual HydroCouple::IComponentStatusChangeEventArgs::~IComponentStatusChangeEventArgs ( )
inlinevirtual

Member Function Documentation

virtual IModelComponent* HydroCouple::IComponentStatusChangeEventArgs::component ( ) const
pure virtual

Gets the IModelComponent that fired the event.

Returns
The IModelComponent that threw the event.
virtual bool HydroCouple::IComponentStatusChangeEventArgs::hasProgressMonitor ( ) const
pure virtual

A bool indicating whether this event has a progresss monitor.

Returns
True if status has a percent progress otherwise false and the progress bar shows busy.
virtual QString HydroCouple::IComponentStatusChangeEventArgs::message ( ) const
pure virtual

Gets additional information about the status change.

virtual float HydroCouple::IComponentStatusChangeEventArgs::percentProgress ( ) const
pure virtual

Number between 0 and 100 indicating the progress made by a component in its simulation.

Returns
A number between 0 and 100 indicating the progress made by a component.
virtual HydroCouple::IModelComponent::ComponentStatus HydroCouple::IComponentStatusChangeEventArgs::previousStatus ( ) const
pure virtual

Gets the IModelComponent's status before the status change.

Returns
The previous ComponentStatus of the component that threw the event.
virtual HydroCouple::IModelComponent::ComponentStatus HydroCouple::IComponentStatusChangeEventArgs::status ( ) const
pure virtual

Gets the IModelComponent's status after the status change.

Returns
The new ComponentStatus of the component that threw the event.

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