Meta::Utils::Progress - progress reporter which will be enhanced later.


Meta documentation Contained in the Meta distribution.

Index


Code Index:

NAME

Top

Meta::Utils::Progress - progress reporter which will be enhanced later.

COPYRIGHT

Top

LICENSE

Top

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, USA.

DETAILS

Top

	MANIFEST: Progress.pm
	PROJECT: meta
	VERSION: 0.07

SYNOPSIS

Top

	package foo;
	use Meta::Utils::Progress qw();
	my($progress)=Meta::Utils::Progress->new();
	$progress->start();
	while(*foo*) {
		*bar*
		$progress->report();
	}
	$progress->finish();

DESCRIPTION

Top

This is basically an abstract API for a progress repoting device. Instantiations could be a GTK widget, a text console widget, text console running numbers or what ever.

FUNCTIONS

Top

	BEGIN()
	init($)
	start($)
	report($)
	finish($)
	TEST($)

FUNCTION DOCUMENTATION

Top

BEGIN()

This method sets up the get/set routines for the following attributes: index - current progress indicator value.

init($)

Initializes the object. Internal method.

start($)

Start the progress indication session.

report($)

Reports progress.

finish($)

Closes the object down.

TEST($)

Test suite for this module.

SUPER CLASSES

Top

None.

BUGS

Top

None.

AUTHOR

Top

	Name: Mark Veltzer
	Email: mailto:veltzer@cpan.org
	WWW: http://www.veltzer.org
	CPAN id: VELTZER

HISTORY

Top

	0.00 MV dbman package creation
	0.01 MV more thumbnail issues
	0.02 MV website construction
	0.03 MV web site development
	0.04 MV web site automation
	0.05 MV SEE ALSO section fix
	0.06 MV download scripts
	0.07 MV md5 issues

SEE ALSO

Top

Meta::Class::MethodMaker(3), strict(3)

TODO

Top

Nothing.


Meta documentation Contained in the Meta distribution.

#!/bin/echo This is a perl module and should not be run

package Meta::Utils::Progress;

use strict qw(vars refs subs);
use Meta::Class::MethodMaker qw();

our($VERSION,@ISA);
$VERSION="0.07";
@ISA=qw();

#sub BEGIN();
#sub init($);
#sub start($);
#sub report($);
#sub finish($);
#sub TEST($);

#__DATA__

sub BEGIN() {
	Meta::Class::MethodMaker->new_with_init("new");
	Meta::Class::MethodMaker->get_set(
		-java=>"_index",
	);
}

sub init($) {
	my($self)=@_;
	$self->set_index(0);
}

sub start($) {
	my($self)=@_;
}

sub report($) {
	my($self)=@_;
	#Meta::Utils::Output::print("index is [".$self->get_index()."]\n");
	$self->set_index($self->get_index()+1);
}

sub finish($) {
	my($self)=@_;
	$self->set_index(0);
}

sub TEST($) {
	my($context)=@_;
	return(1);
}

1;

__END__