Class: TaskJuggler::Limits

Inherits:
Object show all
Defined in:
lib/taskjuggler/Limits.rb

Overview

This class holds a set of limits. Each limit can be created individually and must have unique name. The Limit objects are created when an upper or lower limit is set. All upper or lower limits can be tested with a single function call.

Defined Under Namespace

Classes: Limit

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(limits = nil) ⇒ Limits

Create a new Limits object. If an argument is passed, it acts as a copy contructor.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/taskjuggler/Limits.rb', line 147

def initialize(limits = nil)
  if limits.nil?
    # Normal initialization
    @limits = []
    @project = nil
  else
    # Deep copy content from other instance.
    @limits = []
    limits.limits.each do |name, limit|
      @limits << limit.copy
    end
    @project = limits.project
  end
end

Instance Attribute Details

#limits ⇒ Object (readonly)

Returns the value of attribute limits.



143
144
145
 
# File 'lib/taskjuggler/Limits.rb', line 143

def limits
  @limits
end

#project ⇒ Object (readonly)

Returns the value of attribute project.



143
144
145
 
# File 'lib/taskjuggler/Limits.rb', line 143

def project
  @project
end

Instance Method Details

#dec(index, resource = nil) ⇒ Object

This function decreases the counters for all limits for a specific interval identified by index.



256
257
258
259
260
 
# File 'lib/taskjuggler/Limits.rb', line 256

def dec(index, resource = nil)
  @limits.each do |limit|
    limit.dec(index, resource)
  end
end

#inc(index, resource = nil) ⇒ Object

This function increases the counters for all limits for a specific interval identified by index.



248
249
250
251
252
 
# File 'lib/taskjuggler/Limits.rb', line 248

def inc(index, resource = nil)
  @limits.each do |limit|
    limit.inc(index, resource)
  end
end

#ok?(index = nil, upper = true, resource = nil) ⇒ Boolean

Check all upper limits and return true if none is exceeded. If an index is specified only the counters for that specific period are tested. Otherwise all periods are tested. If resource is nil, only non-resource-specific counters are checked, otherwise only the ones that match the resource.

Returns:

  • (Boolean) 


267
268
269
270
271
272
 
# File 'lib/taskjuggler/Limits.rb', line 267

def ok?(index = nil, upper = true, resource = nil)
  @limits.each do |limit|
    return false unless limit.ok?(index, upper, resource)
  end
  true
end

#reset ⇒ Object

Reset all counter for all limits.



172
173
174
 
# File 'lib/taskjuggler/Limits.rb', line 172

def reset
  @limits.each { |limit| limit.reset }
end

#setLimit(name, value, interval = nil, resource = nil) ⇒ Object

Call this function to create or change a limit. The limit is uniquely identified by the combination of name, interval and resource. value is the new limit value (in time slots). In case the interval is nil, the complete project time frame is used.



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/taskjuggler/Limits.rb', line 180

def setLimit(name, value, interval = nil, resource = nil)
  iv = interval || ScoreboardInterval.new(@project['start'],
                                          @project['scheduleGranularity'],
                                          @project['start'], @project['end'])
  unless iv.is_a?(ScoreboardInterval)
    raise ArgumentError, "interval must be of class ScoreboardInterval"
  end

  # The known ivs are aligned to start at their respective start.
  iv.start = iv.startDate.midnight
  iv.end = iv.endDate.midnight
  case name
  when 'dailymax'
    period = 60 * 60 * 24
    upper = true
  when 'dailymin'
    period = 60 * 60 * 24
    upper = false
  when 'weeklymax'
    iv.start = iv.startDate.beginOfWeek(
      @project['weekStartsMonday'])
    iv.end = iv.endDate.beginOfWeek(@project['weekStartsMonday'])
    period = 60 * 60 * 24 * 7
    upper = true
  when 'weeklymin'
    iv.start = iv.startDate.beginOfWeek(
      @project['weekStartsMonday'])
    iv.end = iv.endDate.beginOfWeek(@project['weekStartsMonday'])
    period = 60 * 60 * 24 * 7
    upper = false
  when 'monthlymax'
    iv.start = iv.startDate.beginOfMonth
    iv.end = iv.endDate.beginOfMonth
    # We use 30 days ivs here. This will cause the iv to drift
    # away from calendar months. But it's better than using 30.4167 which
    # does not align with day boundaries.
    period = 60 * 60 * 24 * 30
    upper = true
  when 'monthlymin'
    iv.start = iv.startDate.beginOfMonth
    iv.end = iv.endDate.beginOfMonth
    # We use 30 days ivs here. This will cause the iv to drift
    # away from calendar months. But it's better than using 30.4167 which
    # does not align with day boundaries.
    period = 60 * 60 * 24 * 30
    upper = false
  when 'maximum'
    period = iv.duration
    upper = true
  when 'minimum'
    period = iv.duration
    upper = false
  else
    raise "Limit period undefined"
  end

  # If we have already a limit for the name + interval + resource
  # combination, we delete it first.
  @limits.delete_if do |l|
    l.name == name && l.interval.startDate == iv.startDate &&
    l.interval.endDate == iv.endDate && l.resource == resource
  end

  @limits << Limit.new(name, iv, period, value, upper, resource)
end

#setProject(project) ⇒ Object

The objects need access to some project specific data like the project period.



164
165
166
167
168
169
 
# File 'lib/taskjuggler/Limits.rb', line 164

def setProject(project)
  unless @limits.empty?
    raise "Cannot change project after limits have been set!"
  end
  @project = project
end