taskjuggler 0.1.1 → 0.2.0

data/doc/TaskJuggler/Limits/Limit.html

@@ -73,6 +73,8 @@
 					
 					<li><a href="#method-i-copy">#copy</a></li>
 					
+					<li><a href="#method-i-idxToSbIdx">#idxToSbIdx</a></li>
+					
 					<li><a href="#method-i-inc">#inc</a></li>
 					
 					<li><a href="#method-i-ok%3F">#ok?</a></li>
@@ -215,12 +217,24 @@
 				
 					<li><a href="../../TaskJuggler/HTMLGraphics.html">TaskJuggler::HTMLGraphics</a></li>
 				
+					<li><a href="../../TaskJuggler/ICalReport.html">TaskJuggler::ICalReport</a></li>
+				
+					<li><a href="../../TaskJuggler/ICalendar.html">TaskJuggler::ICalendar</a></li>
+				
+					<li><a href="../../TaskJuggler/ICalendar/Component.html">TaskJuggler::ICalendar::Component</a></li>
+				
+					<li><a href="../../TaskJuggler/ICalendar/Event.html">TaskJuggler::ICalendar::Event</a></li>
+				
+					<li><a href="../../TaskJuggler/ICalendar/Journal.html">TaskJuggler::ICalendar::Journal</a></li>
+				
+					<li><a href="../../TaskJuggler/ICalendar/Person.html">TaskJuggler::ICalendar::Person</a></li>
+				
+					<li><a href="../../TaskJuggler/ICalendar/Todo.html">TaskJuggler::ICalendar::Todo</a></li>
+				
 					<li><a href="../../TaskJuggler/Interval.html">TaskJuggler::Interval</a></li>
 				
 					<li><a href="../../TaskJuggler/IntervalList.html">TaskJuggler::IntervalList</a></li>
 				
-					<li><a href="../../TaskJuggler/IntervalListAttribute.html">TaskJuggler::IntervalListAttribute</a></li>
-				
 					<li><a href="../../TaskJuggler/JobInfo.html">TaskJuggler::JobInfo</a></li>
 				
 					<li><a href="../../TaskJuggler/Journal.html">TaskJuggler::Journal</a></li>
@@ -335,6 +349,8 @@
 				
 					<li><a href="../../TaskJuggler/ReportContext.html">TaskJuggler::ReportContext</a></li>
 				
+					<li><a href="../../TaskJuggler/ReportScenario.html">TaskJuggler::ReportScenario</a></li>
+				
 					<li><a href="../../TaskJuggler/ReportServer.html">TaskJuggler::ReportServer</a></li>
 				
 					<li><a href="../../TaskJuggler/ReportServerIface.html">TaskJuggler::ReportServerIface</a></li>
@@ -393,6 +409,8 @@
 				
 					<li><a href="../../TaskJuggler/Scoreboard.html">TaskJuggler::Scoreboard</a></li>
 				
+					<li><a href="../../TaskJuggler/ScoreboardInterval.html">TaskJuggler::ScoreboardInterval</a></li>
+				
 					<li><a href="../../TaskJuggler/SheetHandlerBase.html">TaskJuggler::SheetHandlerBase</a></li>
 				
 					<li><a href="../../TaskJuggler/SheetReceiver.html">TaskJuggler::SheetReceiver</a></li>
@@ -439,6 +457,10 @@
 				
 					<li><a href="../../TaskJuggler/TableReport.html">TaskJuggler::TableReport</a></li>
 				
+					<li><a href="../../TaskJuggler/TagFile.html">TaskJuggler::TagFile</a></li>
+				
+					<li><a href="../../TaskJuggler/TagFile/TagFileEntry.html">TaskJuggler::TagFile::TagFileEntry</a></li>
+				
 					<li><a href="../../TaskJuggler/Task.html">TaskJuggler::Task</a></li>
 				
 					<li><a href="../../TaskJuggler/TaskDepListAttribute.html">TaskJuggler::TaskDepListAttribute</a></li>
@@ -489,6 +511,10 @@
 				
 					<li><a href="../../TaskJuggler/TextReport.html">TaskJuggler::TextReport</a></li>
 				
+					<li><a href="../../TaskJuggler/TimeInterval.html">TaskJuggler::TimeInterval</a></li>
+				
+					<li><a href="../../TaskJuggler/TimeIntervalListAttribute.html">TaskJuggler::TimeIntervalListAttribute</a></li>
+				
 					<li><a href="../../TaskJuggler/TimeSheet.html">TaskJuggler::TimeSheet</a></li>
 				
 					<li><a href="../../TaskJuggler/TimeSheetReceiver.html">TaskJuggler::TimeSheetReceiver</a></li>
@@ -778,7 +804,7 @@ Returns a deep copy of the class instance.
 				<div class="method-heading">
 				
 					<span class="method-name">inc</span><span
-						class="method-args">(date, resource)</span>
+						class="method-args">(index, resource)</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
 				</div>
@@ -786,7 +812,7 @@ Returns a deep copy of the class instance.
 				<div class="method-description">
 					
 					<p>
-Increase the counter if the <em>date</em> matches the @interval. The
+Increase the counter if the <em>index</em> matches the @interval. The
 relationship between @resource and <em>resource</em> is described below. @r
 \ <em>r</em>  nil    y nil       inc   inc
 </p>
@@ -798,15 +824,15 @@ relationship between @resource and <em>resource</em> is described below. @r
 					<div class="method-source-code"
 						id="inc-source">
 <pre>
-    <span class="ruby-comment cmt"># File lib/taskjuggler/Limits.rb, line 76</span>
-76:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inc</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">resource</span>)
-77:         <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">&amp;&amp;</span>
-78:            (<span class="ruby-ivar">@resource</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@resource</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">resource</span>)
-79:           <span class="ruby-comment cmt"># The condition is met, increment the counter for the interval.</span>
-80:           <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">true</span>
-81:           <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">date</span>, <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">+</span> <span class="ruby-value">1</span>)
-82:         <span class="ruby-keyword kw">end</span>
-83:       <span class="ruby-keyword kw">end</span></pre>
+    <span class="ruby-comment cmt"># File lib/taskjuggler/Limits.rb, line 77</span>
+77:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">inc</span>(<span class="ruby-identifier">index</span>, <span class="ruby-identifier">resource</span>)
+78:         <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">index</span>) <span class="ruby-operator">&amp;&amp;</span>
+79:            (<span class="ruby-ivar">@resource</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@resource</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">resource</span>)
+80:           <span class="ruby-comment cmt"># The condition is met, increment the counter for the interval.</span>
+81:           <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">true</span>
+82:           <span class="ruby-ivar">@scoreboard</span>[<span class="ruby-identifier">idxToSbIdx</span>(<span class="ruby-identifier">index</span>)] <span class="ruby-operator">+=</span> <span class="ruby-value">1</span>
+83:         <span class="ruby-keyword kw">end</span>
+84:       <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -823,7 +849,7 @@ relationship between @resource and <em>resource</em> is described below. @r
 				<div class="method-heading">
 				
 					<span class="method-name">ok?</span><span
-						class="method-args">(date, upper, resource)</span>
+						class="method-args">(index, upper, resource)</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
 				</div>
@@ -831,8 +857,8 @@ relationship between @resource and <em>resource</em> is described below. @r
 				<div class="method-description">
 					
 					<p>
-Returns true if the counter for the time slot specified by <tt>date</tt> or
-all counters are within the limit. If <tt>upper</tt> is true, only upper
+Returns true if the counter for the time slot specified by <tt>index</tt>
+or all counters are within the limit. If <tt>upper</tt> is true, only upper
 limits are checked. If not, only lower limits are checked. The dependency
 between <em>resource</em> and @resource is described in the matrix below:
 @r \ <em>r</em>  nil   y nil       test  true
@@ -845,29 +871,29 @@ between <em>resource</em> and @resource is described in the matrix below:
 					<div class="method-source-code"
 						id="ok--source">
 <pre>
-     <span class="ruby-comment cmt"># File lib/taskjuggler/Limits.rb, line 93</span>
- 93:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ok?</span>(<span class="ruby-identifier">date</span>, <span class="ruby-identifier">upper</span>, <span class="ruby-identifier">resource</span>)
- 94:         <span class="ruby-comment cmt"># if @upper does not match or the provided resource does not match,</span>
- 95:         <span class="ruby-comment cmt"># we can ignore this limit.</span>
- 96:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@upper</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">upper</span> <span class="ruby-operator">||</span>
- 97:                        (<span class="ruby-operator">!</span><span class="ruby-ivar">@resource</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">^</span> <span class="ruby-operator">!</span><span class="ruby-identifier">resource</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">||</span>
- 98:                        (<span class="ruby-ivar">@resource</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">resource</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@resource</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">resource</span>)
- 99: 
-100:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">nil?</span>
-101:           <span class="ruby-comment cmt"># No date given. We need to check all counters.</span>
-102:           <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
-103:             <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@upper</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@value</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">&lt;</span> <span class="ruby-ivar">@value</span>
-104:           <span class="ruby-keyword kw">end</span>
-105:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
-106:         <span class="ruby-keyword kw">else</span>
-107:           <span class="ruby-comment cmt"># If the date is outside the interval we don't have to check</span>
-108:           <span class="ruby-comment cmt"># anything. Everything is ok.</span>
-109:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">date</span>)
-110: 
-111:           <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@upper</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">&lt;</span> <span class="ruby-ivar">@value</span> <span class="ruby-operator">:</span>
-112:                           <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">date</span>) <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@value</span>
-113:         <span class="ruby-keyword kw">end</span>
-114:       <span class="ruby-keyword kw">end</span></pre>
+     <span class="ruby-comment cmt"># File lib/taskjuggler/Limits.rb, line 94</span>
+ 94:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ok?</span>(<span class="ruby-identifier">index</span>, <span class="ruby-identifier">upper</span>, <span class="ruby-identifier">resource</span>)
+ 95:         <span class="ruby-comment cmt"># if @upper does not match or the provided resource does not match,</span>
+ 96:         <span class="ruby-comment cmt"># we can ignore this limit.</span>
+ 97:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@upper</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">upper</span> <span class="ruby-operator">||</span>
+ 98:                        (<span class="ruby-operator">!</span><span class="ruby-ivar">@resource</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">^</span> <span class="ruby-operator">!</span><span class="ruby-identifier">resource</span>.<span class="ruby-identifier">nil?</span>) <span class="ruby-operator">||</span>
+ 99:                        (<span class="ruby-ivar">@resource</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">resource</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@resource</span> <span class="ruby-operator">!=</span> <span class="ruby-identifier">resource</span>)
+100: 
+101:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">index</span>.<span class="ruby-identifier">nil?</span>
+102:           <span class="ruby-comment cmt"># No index given. We need to check all counters.</span>
+103:           <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
+104:             <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@upper</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@value</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">i</span> <span class="ruby-operator">&lt;</span> <span class="ruby-ivar">@value</span>
+105:           <span class="ruby-keyword kw">end</span>
+106:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+107:         <span class="ruby-keyword kw">else</span>
+108:           <span class="ruby-comment cmt"># If the index is outside the interval we don't have to check</span>
+109:           <span class="ruby-comment cmt"># anything. Everything is ok.</span>
+110:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> <span class="ruby-keyword kw">if</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">index</span>)
+111: 
+112:           <span class="ruby-keyword kw">return</span> <span class="ruby-ivar">@upper</span> <span class="ruby-operator">?</span> <span class="ruby-ivar">@scoreboard</span>[<span class="ruby-identifier">idxToSbIdx</span>(<span class="ruby-identifier">index</span>)] <span class="ruby-operator">&lt;</span> <span class="ruby-ivar">@value</span> <span class="ruby-operator">:</span>
+113:                           <span class="ruby-ivar">@scoreboard</span>[<span class="ruby-identifier">idxToSbIdx</span>(<span class="ruby-identifier">index</span>)] <span class="ruby-operator">&gt;=</span> <span class="ruby-ivar">@value</span>
+114:         <span class="ruby-keyword kw">end</span>
+115:       <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>
@@ -884,7 +910,7 @@ between <em>resource</em> and @resource is described in the matrix below:
 				<div class="method-heading">
 				
 					<span class="method-name">reset</span><span
-						class="method-args">(date = nil)</span>
+						class="method-args">(index = nil)</span>
 					<span class="method-click-advice">click to toggle source</span>
 				
 				</div>
@@ -893,7 +919,7 @@ between <em>resource</em> and @resource is described in the matrix below:
 					
 					<p>
 This function can be used to reset the counter for a specific period
-specified by <tt>date</tt> or to reset all counters.
+specified by <tt>index</tt> or to reset all counters.
 </p>
 					
 
@@ -902,18 +928,67 @@ specified by <tt>date</tt> or to reset all counters.
 						id="reset-source">
 <pre>
     <span class="ruby-comment cmt"># File lib/taskjuggler/Limits.rb, line 58</span>
-58:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>(<span class="ruby-identifier">date</span> = <span class="ruby-keyword kw">nil</span>)
+58:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">reset</span>(<span class="ruby-identifier">index</span> = <span class="ruby-keyword kw">nil</span>)
 59:         <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@dirty</span>
 60: 
-61:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">date</span>.<span class="ruby-identifier">nil?</span>
-62:           <span class="ruby-ivar">@scoreboard</span> = <span class="ruby-constant">Scoreboard</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">start</span>, <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">end</span>,
+61:         <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">index</span>.<span class="ruby-identifier">nil?</span>
+62:           <span class="ruby-ivar">@scoreboard</span> = <span class="ruby-constant">Scoreboard</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">startDate</span>, <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">endDate</span>,
 63:                                        <span class="ruby-ivar">@period</span>, <span class="ruby-value">0</span>)
 64:         <span class="ruby-keyword kw">else</span>
-65:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">date</span>)
-66:           <span class="ruby-ivar">@scoreboard</span>.<span class="ruby-identifier">set</span>(<span class="ruby-identifier">date</span>, <span class="ruby-value">0</span>)
-67:         <span class="ruby-keyword kw">end</span>
-68:         <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">false</span>
-69:       <span class="ruby-keyword kw">end</span></pre>
+65:           <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">contains?</span>(<span class="ruby-identifier">index</span>)
+66:           <span class="ruby-comment cmt"># The scoreboard may be just a subset of the @interval period.</span>
+67:           <span class="ruby-ivar">@scoreboard</span>[<span class="ruby-identifier">idxToSbIdx</span>(<span class="ruby-identifier">index</span>)] = <span class="ruby-value">0</span>
+68:         <span class="ruby-keyword kw">end</span>
+69:         <span class="ruby-ivar">@dirty</span> = <span class="ruby-keyword kw">false</span>
+70:       <span class="ruby-keyword kw">end</span></pre>
+					</div>
+					
+				</div>
+
+				
+
+				
+			</div>
+
+		
+		</div>
+	
+		<div id="private-instance-method-details" class="method-section section">
+			<h3 class="section-header">Private Instance Methods</h3>
+
+		
+			<div id="idx-o-b-dx-method" class="method-detail ">
+				<a name="method-i-idxToSbIdx"></a>
+
+				<div class="method-heading">
+				
+					<span class="method-name">idxToSbIdx</span><span
+						class="method-args">(index)</span>
+					<span class="method-click-advice">click to toggle source</span>
+				
+				</div>
+
+				<div class="method-description">
+					
+					<p>
+The project scoreboard and the <a href="Limit.html">Limit</a> scoreboard
+differ from each other. The <a href="Limit.html">Limit</a> scoreboard may
+only be a subset of the project scoreboard interval. And the <a
+href="Limit.html">Limit</a> scoreboard has a larger slot duration that
+depends on what kind of limit it is (daily, weekly, etc.). Therefor, we
+have to use this method to translate project scoreboard indexes to <a
+href="Limit.html">Limit</a> scoreboard indexes.
+</p>
+					
+
+					
+					<div class="method-source-code"
+						id="idx-o-b-dx-source">
+<pre>
+     <span class="ruby-comment cmt"># File lib/taskjuggler/Limits.rb, line 125</span>
+125:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">idxToSbIdx</span>(<span class="ruby-identifier">index</span>)
+126:         (<span class="ruby-identifier">index</span> <span class="ruby-operator">-</span> <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">start</span>) * <span class="ruby-ivar">@interval</span>.<span class="ruby-identifier">slotDuration</span> <span class="ruby-operator">/</span> <span class="ruby-ivar">@period</span>
+127:       <span class="ruby-keyword kw">end</span></pre>
 					</div>
 					
 				</div>