ProcessIndicator: A simple class that indicates process either via waitbar or text output. More...

Detailed Description

ProcessIndicator: A simple class that indicates process either via waitbar or text output.

The flag UseWaitbar determines if a waitbar is used or text output is produced. The text output restrains itself to only report progress at about each 10% to keep verbosity at an acceptable level.

Author: Daniel Wirtz

Date: 2012-03-20

Change in 0.6:: (Daniel Wirtz, 2012-05-07) The constructor takes varargin arguments that are forwarded to a sprintf of the title string, if given.

Change in 0.6:: (Daniel Wirtz, 2012-04-16) Fixed misinterpreted use of "step" method. Now have a step method which takes an increase value and a set method which takes the new absolute progress to show

New in 0.6:: (Daniel Wirtz, 2012-03-20) Added this class.

Todo:: process indicator for arbitrary (percentage/integer) values!

This class is part of the framework

KerMor - Model Order Reduction using Kernels

Homepage http://www.morepas.org/software/index.html
Documentation http://www.morepas.org/software/kermor/index.html
License KerMor license conditions

Definition at line 17 of file ProcessIndicator.m.

Public Member Functions
	ProcessIndicator (char title,double total,logical wb, varargin)
	Creates a new ProcessIndicator. More...

function	start (double total)
	Starts the process indicator with the given total process amount. More...

function	set (value)
	Directly sets the current process value. More...

function	step (double value)
	Reports process to the indicator and triggers waitbar or text output. More...

function	stop ()
	Stops the process indication and closes the waitbar, if any. More...

Public Attributes
logical	UseWaitbar = false
	Flag that indicates if a waitbar should be used. More...

Public Attributes inherited from handle
	addlistener
	Creates a listener for the specified event and assigns a callback function to execute when the event occurs. More...

	notify
	Broadcast a notice that a specific event is occurring on a specified handle object or array of handle objects. More...

	delete
	Handle object destructor method that is called when the object's lifecycle ends. More...

	disp
	Handle object disp method which is called by the display method. See the MATLAB disp function. More...

	display
	Handle object display method called when MATLAB software interprets an expression returning a handle object that is not terminated by a semicolon. See the MATLAB display function. More...

	findobj
	Finds objects matching the specified conditions from the input array of handle objects. More...

	findprop
	Returns a meta.property objects associated with the specified property name. More...

	fields
	Returns a cell array of string containing the names of public properties. More...

	fieldnames
	Returns a cell array of string containing the names of public properties. See the MATLAB fieldnames function. More...

	isvalid
	Returns a logical array in which elements are true if the corresponding elements in the input array are valid handles. This method is Sealed so you cannot override it in a handle subclass. More...

	eq
	Relational functions example. See details for more information. More...

	transpose
	Transposes the elements of the handle object array. More...

	permute
	Rearranges the dimensions of the handle object array. See the MATLAB permute function. More...

	reshape
	hanges the dimensions of the handle object array to the specified dimensions. See the MATLAB reshape function. More...

	sort
	ort the handle objects in any array in ascending or descending order. More...

Constructor & Destructor Documentation

ProcessIndicator.ProcessIndicator	(	char	title,
		double	total,
		logical	wb,
			varargin
	)

Creates a new ProcessIndicator.

If a total argument is given, the indicator is initialized via

start(total)

directly.

Parameters

title	A title Default: `Process running`
total	The total process amount. Must be positive. Default: []
wb	Flag that indicates how to initialize the UseWaitbar flag. Default: false
varargin	Any further parameters are passed to a sprintf call for the title string.

Definition at line 76 of file ProcessIndicator.m.

References start(), and UseWaitbar.

Here is the call graph for this function:

Member Function Documentation

function ProcessIndicator.set ( value )

Directly sets the current process value.

Value is always restricted to \([0, total]\), and if no argument is given, value=1 is assumed.

Definition at line 136 of file ProcessIndicator.m.

Referenced by start().

Here is the caller graph for this function:

function ProcessIndicator.start ( double total )

Starts the process indicator with the given total process amount.

Parameters

total The total process amount. Must be positive.

Definition at line 107 of file ProcessIndicator.m.

References set(), and UseWaitbar.

Referenced by ProcessIndicator().

Here is the call graph for this function:

Here is the caller graph for this function:

function ProcessIndicator.step ( double value )

Reports process to the indicator and triggers waitbar or text output.

Increases the current process by the given value. If no value is specified, one is assumed.

Parameters

value The process value. Default: 1

Definition at line 158 of file ProcessIndicator.m.

function ProcessIndicator.stop ( )

Stops the process indication and closes the waitbar, if any.

Definition at line 182 of file ProcessIndicator.m.

References UseWaitbar.

Member Data Documentation

ProcessIndicator.UseWaitbar = false

Flag that indicates if a waitbar should be used.

Default: false

Note: This property has custom functionality when its value is changed.

Definition at line 51 of file ProcessIndicator.m.

Referenced by ProcessIndicator(), start(), and stop().

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

matlabtools/ProcessIndicator.m

Detailed Description

Public Member Functions

Public Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation