##========================================================================
## POD DOCUMENTATION, auto-generated by podextract.perl

##========================================================================
## NAME
=pod

=head1 NAME

DiaColloDB::Timer - diachronic collocation db, timer

=cut

##========================================================================
## SYNOPSIS
=pod

=head1 SYNOPSIS

 ##========================================================================
 ## PRELIMINARIES
 
 use DiaColloDB::Timer;
 
 ##========================================================================
 ## Constructors etc.
 
 $timer = $CLASS_OR_OBJECT->new(%args);
 
 ##========================================================================
 ## Timing
 
 $timer = $CLASS_OR_OBJECT->start();
 $timer = $timer->stop();
 $timer = $timer->reset();
 $elapsed = $timer->elapsed();
 $hms     = $timer->hms($sfmt?);
 $timestr = $timer->timestr($sfmt?);
 

=cut

##========================================================================
## DESCRIPTION
=pod

=head1 DESCRIPTION

DiaColloDB::Timer
provides a simple object-oriented high resolution timer
used e.g. for measuring query processing time in the command-line
utilities.

=cut


##----------------------------------------------------------------
## DESCRIPTION: DiaColloDB::Timer: Constructors etc.
=pod

=head2 Constructors etc.

=over 4

=item new

 $timer = CLASS_OR_OBJECT->new(%args);

%args, object structure:

 started => $t0,      ##-- time last operation started
 elapsed => $elapsed, ##-- elapsed time (after stop())

=back

=cut

##----------------------------------------------------------------
## DESCRIPTION: DiaColloDB::Timer: Timing
=pod

=head2 Timing

=over 4

=item start

 $timer = CLASS_OR_OBJECT->start();

(re-)starts timer

=item stop

 $timer = $timer->stop();

stops timer and adds current interval to {elapsed}

=item reset

 $timer = $timer->reset();

stops and re-sets timer

=item elapsed

 $elapsed = $timer->elapsed();

get total elapsed time for this timer

=item hms

 $hms = $timer->hms($sfmt?);
 ($h,$m,$s) = $timer->hms($sfmt?);

parses and optionally formats elapsed time as HH:MM:SS.SSS

=item timestr

 $timestr = $timer->timestr($sfmt?);

parses and formats elapsed time as Hh?Mm?Ss

=back

=cut

##========================================================================
## END POD DOCUMENTATION, auto-generated by podextract.perl

##======================================================================
## Footer
##======================================================================
=pod

=head1 AUTHOR

Bryan Jurish E<lt>moocow@cpan.orgE<gt>

=head1 COPYRIGHT AND LICENSE

Copyright (C) 2015-2016 by Bryan Jurish

This package is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.2 or,
at your option, any later version of Perl 5 you may have available.

=head1 SEE ALSO

L<DiaColloDB(3pm)|DiaColloDB>,
L<perl(1)|perl>,
...



=cut
