/ 
Lab-Measurement-3.730
River stage zero No dependents
/ Lab::XPRESS::Sweep::Repeater

NAME

Lab::XPRESS::Sweep::Repeater - Simple repeater

VERSION

version 3.730

SYNOPSIS

use Lab::XPRESS::hub;
my $hub = new Lab::XPRESS::hub();



my $repeater = $hub->Sweep('Repeater',
	{
	repetitions => 5
	});

DESCRIPTION

Parent: Lab::XPRESS::Sweep

The Lab::XPRESS::Sweep::Repeater class implements a simple repeater module in the Lab::XPRESS::Sweep framework.

CONSTRUCTOR

my $repeater = $hub->Sweep('Repeater',
	{
	repetitions => 5
	});

Instantiates a new repeater with 5 repetitions. Alternatively

my $repeater_array = $hub->Sweep('Repeater',
	{
	repetitions => [10, 20, 30, 40, 50]
	});

Instantiates also a repeater with 5 repetitions. However, the function

$repeater->get_value(); # <-- returns 1,2,3,4,5 depending on the repetition,
$repeater->get_array(); # <-- returns 10,20,30,40,50 depending on the repetition.  
.

PARAMETERS

repetitions [int / array] (default = 1)

number of repetitions. default value is 1, negative values indicate a infinit number of repetitions. When an array is given, the number of reetitions corresponds to the length of the array.

id [string] (default = 'Repeater')

Just an ID.

filename_extention [string] (default = '#=')

Defines a postfix, that will be appended to the filenames if necessary.

delay_before_loop [float] (default = 0)

defines the time in seconds to wait after the starting point has been reached.

delay_in_loop [float] (default = 0)

This parameter is relevant only if mode = 'step' or 'list' has been selected. Defines the time in seconds to wait after the value for the next step has been reached.

delay_after_loop [float] (default = 0)

Defines the time in seconds to wait after the sweep has been finished. This delay will be executed before an optional backsweep or optional repetitions of the sweep.

METHODS

get_value()

Returns an integer number n corresponding to the nth repetition or if an array @a was given for the parameter 'repetitions' it returns @a[n].

CAVEATS/BUGS

probably none

SEE ALSO

Lab::XPRESS::Sweep

COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by the Lab::Measurement team; in detail:

Copyright 2012       Stefan Geissler
          2013       Andreas K. Huettel, Christian Butschkow, Stefan Geissler
          2015       Christian Butschkow
          2016       Simon Reinhardt
          2017       Andreas K. Huettel
          2020       Andreas K. Huettel

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.