001: /*
002: The contents of this file are subject to the Common Public Attribution License
003: Version 1.0 (the "License"); you may not use this file except in compliance with
004: the License. You may obtain a copy of the License at
005: http://www.projity.com/license . The License is based on the Mozilla Public
006: License Version 1.1 but Sections 14 and 15 have been added to cover use of
007: software over a computer network and provide for limited attribution for the
008: Original Developer. In addition, Exhibit A has been modified to be consistent
009: with Exhibit B.
010:
011: Software distributed under the License is distributed on an "AS IS" basis,
012: WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the
013: specific language governing rights and limitations under the License. The
014: Original Code is OpenProj. The Original Developer is the Initial Developer and
015: is Projity, Inc. All portions of the code written by Projity are Copyright (c)
016: 2006, 2007. All Rights Reserved. Contributors Projity, Inc.
017:
018: Alternatively, the contents of this file may be used under the terms of the
019: Projity End-User License Agreeement (the Projity License), in which case the
020: provisions of the Projity License are applicable instead of those above. If you
021: wish to allow use of your version of this file only under the terms of the
022: Projity License and not to allow others to use your version of this file under
023: the CPAL, indicate your decision by deleting the provisions above and replace
024: them with the notice and other provisions required by the Projity License. If
025: you do not delete the provisions above, a recipient may use your version of this
026: file under either the CPAL or the Projity License.
027:
028: [NOTE: The text of this license may differ slightly from the text of the notices
029: in Exhibits A and B of the license at http://www.projity.com/license. You should
030: use the latest text at http://www.projity.com/license for your modifications.
031: You may not remove this license text from the source files.]
032:
033: Attribution Information: Attribution Copyright Notice: Copyright © 2006, 2007
034: Projity, Inc. Attribution Phrase (not exceeding 10 words): Powered by OpenProj,
035: an open source solution from Projity. Attribution URL: http://www.projity.com
036: Graphic Image as provided in the Covered Code as file: openproj_logo.png with
037: alternatives listed on http://www.projity.com/logo
038:
039: Display of Attribution Information is required in Larger Works which are defined
040: in the CPAL as a work which combines Covered Code or portions thereof with code
041: not governed by the terms of the CPAL. However, in addition to the other notice
042: obligations, all copies of the Covered Code in Executable and Source Code form
043: distributed must, as a form of attribution of the original author, include on
044: each user interface screen the "OpenProj" logo visible to all users. The
045: OpenProj logo should be located horizontally aligned with the menu bar and left
046: justified on the top left of the screen adjacent to the File menu. The logo
047: must be at least 100 x 25 pixels. When users click on the "OpenProj" logo it
048: must direct them back to http://www.projity.com.
049: */
050: package com.projity.pm.assignment.functor;
051:
052: import com.projity.algorithm.CollectionIntervalGenerator;
053: import com.projity.pm.assignment.Assignment;
054: import com.projity.pm.assignment.contour.AbstractContourBucket;
055: import com.projity.pm.assignment.contour.ContourBucketIntervalGenerator;
056: import com.projity.pm.calendar.WorkCalendar;
057: import com.projity.pm.costing.CostRate;
058: import com.projity.pm.time.HasStartAndEnd;
059:
060: /**
061: * A functor which calculates cost (regular, overtime, fixed, total)
062: */
063: public class CostFunctor extends AssignmentFieldOvertimeFunctor {
064: CollectionIntervalGenerator costRateGenerator;
065: long fixedCostDate;
066: boolean proratedCost;
067: double fixedValue = 0.0D;
068: double regularWork = 0.0D;
069: double overtimeWork = 0.0D;
070: double work = 0.0D;
071:
072: public static CostFunctor getInstance(
073: Assignment assignment,
074: WorkCalendar workCalendar,
075: ContourBucketIntervalGenerator contourBucketIntervalGenerator,
076: double overtimeUnits,
077: com.projity.algorithm.CollectionIntervalGenerator costRateGenerator,
078: long fixedCostDate, boolean proratedCost) {
079: return new CostFunctor(assignment, workCalendar,
080: contourBucketIntervalGenerator, overtimeUnits,
081: costRateGenerator, fixedCostDate, proratedCost);
082: }
083:
084: private CostFunctor(
085: Assignment assignment,
086: WorkCalendar workCalendar,
087: ContourBucketIntervalGenerator contourBucketIntervalGenerator,
088: double overtimeUnits,
089: CollectionIntervalGenerator costRateGenerator,
090: long fixedCostDate, boolean proratedCost) {
091: super (assignment, workCalendar, contourBucketIntervalGenerator,
092: overtimeUnits);
093: this .costRateGenerator = costRateGenerator;
094: this .fixedCostDate = fixedCostDate;
095: this .proratedCost = proratedCost;
096: }
097:
098: public void execute(Object object) {
099: HasStartAndEnd interval = (HasStartAndEnd) object;
100: AbstractContourBucket bucket = (AbstractContourBucket) contourBucketIntervalGenerator
101: .current();
102:
103: if (bucket != null) {
104: CostRate costRate = (CostRate) costRateGenerator.current();
105: double bucketUnits = bucket.getEffectiveUnits(assignment
106: .getUnits());
107: if (bucketUnits != 0.0) { // there are never values if there is no normal cost. This is how MS project works
108: // calculate regular and overtime
109: long bucketDuration = workCalendar.compare(interval
110: .getEnd(), interval.getStart(), false);
111:
112: //When we handle overhead, we need to have another interval generator which keeps overhead in sorted order
113: // The bucket duration should be multiplied by 1 - overhead. Code also needs to exist in workFunctor. maybe others too
114: // double overhead = overheadIntervalGenerator.current();
115: // bucketDuration *= (1.0 - overhead);
116:
117: // might as well calculate work too
118: regularWork += bucketUnits * bucketDuration;
119: overtimeWork += overtimeUnits * bucketDuration;
120: work = regularWork + overtimeWork;
121:
122: double bucketOvertime = costRate.getOvertimeRate()
123: .getValue()
124: * overtimeUnits;
125: double bucketRegular = costRate.getStandardRate()
126: .getValue()
127: * bucketUnits;
128: if (assignment.isTemporal()) { // for work resources or time based material
129: bucketRegular *= bucketDuration;
130: bucketOvertime *= bucketDuration;
131: }
132: overtimeValue += bucketOvertime;
133: regularValue += bucketRegular;
134: value += (bucketOvertime + bucketRegular);
135:
136: // Below is fixed cost processing.
137: double costPerUse = costRate.getCostPerUse();
138: if (costPerUse != 0.0D) {
139: double fraction = 1.0D; // fraction of fixed cost to use - only relevant if prorated
140: if (proratedCost) { // prorated across duration
141: long assignmentDuration = assignment
142: .getDuration();
143: if (assignmentDuration != 0) {
144: fraction = ((double) bucketDuration)
145: / assignment.getDuration();
146: }
147: } else { // at a certain date - start or end
148: // make sure that the start or end date falls within the interval
149: if (interval.getStart() > fixedCostDate
150: || interval.getEnd() < fixedCostDate)
151: return; // not in range
152: }
153: // Notice how the cost per use is multiplied by the assignment units, which itself is the peak units used. This is MS Project's way of doing things
154: double bucketFixed = fraction * costPerUse
155: * assignment.getUnits();
156: fixedValue += bucketFixed;
157: value += bucketFixed;
158: }
159: }
160: }
161: }
162:
163: /* (non-Javadoc)
164: * @see com.projity.algorithm.CalculationVisitor#reset()
165: */
166: public void initialize() {
167: super .initialize();
168: fixedValue = 0.0D;
169: regularWork = 0.0D;
170: overtimeWork = 0.0D;
171: work = 0.0D;
172: }
173:
174: /**
175: * @return Returns the fixedValue.
176: */
177: public double getFixedValue() {
178: return fixedValue;
179: }
180:
181: public String toString() {
182: return " total " + value + " regular " + regularValue
183: + " overtime " + overtimeValue + " fixed "
184: + fixedValue;
185: }
186:
187: public final double getOvertimeWork() {
188: return overtimeWork;
189: }
190:
191: public final double getRegularWork() {
192: return regularWork;
193: }
194:
195: public final double getWork() {
196: return work;
197: }
198:
199: }
|