HydroCouple::IComponentStatusChangeEventArgs Class Reference

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

#include <hydrocouple.h>

Collaboration diagram for HydroCouple::IComponentStatusChangeEventArgs:

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

Detailed Description

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

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

Constructor & Destructor Documentation

~IComponentStatusChangeEventArgs()

virtual HydroCouple::IComponentStatusChangeEventArgs::~IComponentStatusChangeEventArgs ( )

virtualdefault

~IComponentStatusChangeEventArgs destructor

Member Function Documentation

component()

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

pure virtual

Gets the IModelComponent that fired the event.

Returns

The IModelComponent that threw the event.

hasProgressMonitor()

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.

message()

virtual string HydroCouple::IComponentStatusChangeEventArgs::message ( ) const

pure virtual

Gets additional information about the status change.

percentProgress()

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.

previousStatus()

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

status()

virtual 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:

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