view release on metacpan or  search on metacpan

docs/Acme-FishFarm-WaterLevelMaintainer-1.01.html  view on Meta::CPAN

<p>Acme::FishFarm::WaterLevelMaintainer - Water Level Maintainer for Acme::FishFarm</p>

<h1 id="VERSION">VERSION</h1>

<p>Version 1.01</p>

<h1 id="SYNOPSIS">SYNOPSIS</h1>

<pre><code>    use 5.010;

    use Acme::FishFarm qw( reduce_precision );
    use Acme::FishFarm::WaterFiltration;

    my $water_level = Acme::FishFarm::WaterLevelMaintainer-&gt;install;

    say &quot;Water level maintainer installed and switched on!\n&quot;;

    my $height_increase;
    my $water_level_threshold;
    my $current_reading;

    while ( &quot;Fish are living under the water...&quot; ) {

        $current_reading = reduce_precision( rand(10) );
        $height_increase = $water_level-&gt;water_level_increase_height;
        $water_level_threshold = $water_level-&gt;low_water_level_threshold;
        
        $water_level-&gt;current_water_level( $current_reading ); # input by user
        print &quot;Current Water Level: &quot;, $current_reading, &quot; m (low: &lt; &quot;, $water_level_threshold, &quot; m)\n&quot;;

        if ( $water_level-&gt;is_low_water_level ) {
            print &quot;  !! Water level is low!\n&quot;;
            $water_level-&gt;pump_water_in;
            print &quot;  Pumping in &quot;, $height_increase, &quot; m of water...\n&quot;;
            print &quot;Current Water Level: &quot;, $water_level-&gt;current_water_level, &quot;\n&quot;;
        } else {
            print &quot;  Water level is still normal.\n&quot;;
        }
        
        sleep(1);
        say &quot;&quot;;
    }</code></pre>

<h1 id="EXPORT">EXPORT</h1>

<p>None</p>

<h1 id="CREATION-RELATED-MEHODS">CREATION RELATED MEHODS</h1>

<h2 id="install-options">install ( %options )</h2>

<p>Installs a water level maintainer system. This system only pumps water in if the water level is lower than the threshold value.</p>

<p>The supported <code>%options</code> are:</p>

<dl>

<dt id="current_water_level">current_water_level</dt>
<dd>

<p>The default water level is to <code>5 unit</code>.</p>

</dd>
<dt id="low_water_level_threshold">low_water_level_threshold</dt>
<dd>

<p>The default threshold is <code>2 unit</code>.</p>

<p>If the current water level is lower than this threshold, then you need to pump water into the tank.</p>

</dd>
<dt id="increase_water_level_by">increase_water_level_by</dt>
<dd>

<p>This is the height of the water level to increase when the water is pumped in.</p>

<p>The default value is <code>0.5 unit</code>.</p>

</dd>
</dl>

<h1 id="WATER-LEVEL-DETECTION-RELATED-METHODS">WATER LEVEL DETECTION RELATED METHODS</h1>

<h2 id="current_water_level-new_water_level">current_water_level ( $new_water_level )</h2>

<p>Sets / returns the current water level of the water.</p>

<p><code>$new_water_level</code> is optional. If present, the current water level will be set to <code>$new_water_level</code>. Otherwise, returns the current water level (depth).</p>

<h2 id="low_water_level_threshold1">low_water_level_threshold</h2>

<p>Returns the low water level threshold.</p>

<h2 id="set_low_water_level_threshold-new_threshold">set_low_water_level_threshold ( $new_threshold )</h2>

<p>Sets the low water level threshold.</p>

<h2 id="is_low_water_level">is_low_water_level</h2>

<p>Returns <code>1</code> if the DO level is less than the threshold value. Otherwise, returns <code>0</code>.</p>

<h1 id="PUMPS-RELATED-METHODS">PUMPS RELATED METHODS</h1>

<p>For the pumping mechanism, just assume that the pumps can actually pump in certain metres of water each time :)</p>

<h2 id="water_level_increase_height">water_level_increase_height</h2>

<p>Returns the height of water level to increase each water pumping action. See <code>pump_water_in</code> below.</p>

<h2 id="set_water_level_increase_height-new_height">set_water_level_increase_height ( $new_height )</h2>

<p>Sets the height of water level to increase to <code>$new_height</code>.</p>

<h2 id="pump_water_in">pump_water_in</h2>

<p>Pumps water into the tank to increase the height of the water level.</p>

<h1 id="AUTHOR">AUTHOR</h1>

<p>Raphael Jong Jun Jie, <code>&lt;ellednera at cpan.org&gt;</code></p>

<h1 id="BUGS">BUGS</h1>

<p>Please report any bugs or feature requests to <code>bug-. at rt.cpan.org</code>, or through the web interface at <a href="https://rt.cpan.org/NoAuth/ReportBug.html?Queue=.">https://rt.cpan.org/NoAuth/ReportBug.html?Queue=.</a>. I will be notified,...

<h1 id="SUPPORT">SUPPORT</h1>

<p>You can find documentation for this module with the perldoc command.</p>

<pre><code>    perldoc Acme::FishFarm::WaterLevelMaintainer</code></pre>

<p>You can also look for information at:</p>

<ul>

<li><p>RT: CPAN&#39;s request tracker (report bugs here)</p>