001: /*
002: * <copyright>
003: *
004: * Copyright 1997-2004 BBNT Solutions, LLC
005: * under sponsorship of the Defense Advanced Research Projects
006: * Agency (DARPA).
007: *
008: * You can redistribute this software and/or modify it under the
009: * terms of the Cougaar Open Source License as published on the
010: * Cougaar Open Source Website (www.cougaar.org).
011: *
012: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
013: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
014: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
015: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
016: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
017: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
018: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
019: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
020: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
021: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
022: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
023: *
024: * </copyright>
025: */
026: /* Implementation of SettableConstraintEvent. New
027: API to be used as utility functions for resolving
028: constraints
029: */
030:
031: package org.cougaar.planning.ldm.plan;
032:
033: public abstract class TaskConstraintEvent implements
034: SettableConstraintEvent {
035: public static class Constrained extends TaskConstraintEvent {
036: public Constrained(NewTask t, int aspect) {
037: super (t, aspect, NOVALUE);
038: }
039:
040: public boolean isConstraining() {
041: return false;
042: }
043: }
044:
045: public static class Constraining extends TaskConstraintEvent {
046: public Constraining(NewTask t, int aspect) {
047: super (t, aspect, NOVALUE);
048: }
049:
050: public boolean isConstraining() {
051: return true;
052: }
053: }
054:
055: private NewTask task; /* constrained or constraining task */
056: private int event; /* constrained or constraining aspect */
057: private double value = NOVALUE; /* A value to use if a constraining task has NOVALUE */
058:
059: protected TaskConstraintEvent(NewTask t, int aspect, double value) {
060: task = t;
061: event = aspect;
062: this .value = value;
063: }
064:
065: public int getAspectType() {
066: return event;
067: }
068:
069: public Task getTask() {
070: return task;
071: }
072:
073: public abstract boolean isConstraining();
074:
075: /**
076: * getValue()
077: * @return the allocation result of particular aspect if
078: * isConstraining else returns the preference on that aspect.
079: * @note The value may be Double.NaN if the task has an undefined preferred value.
080: **/
081: public double getValue() {
082: if (isConstraining()) {
083: return getResultValue();
084: } else {
085: return task.getPreferredValue(event);
086: }
087: }
088:
089: /**
090: * getResultValue()
091: * @return the allocation result of particular aspect
092: **/
093: public double getResultValue() {
094: PlanElement pe = task.getPlanElement();
095: if (pe == null)
096: return value;
097: AllocationResult ar = pe.getEstimatedResult();
098: if (ar == null)
099: return value;
100: return ar.getValue(event);
101: }
102:
103: /**
104: * setValue sets the aspect value. To be used on a Constrained task
105: * to set the aspect value to a value that will satisfy constraints
106: **/
107: public void setValue(double value, int constraintOrder, double slope) {
108: this .value = value; // local copy
109: if (isConstraining()) {
110: throw new RuntimeException(
111: "setValue only applies to a constrained event");
112: }
113: // set preference on the constrained task
114: ScoringFunction sf;
115: switch (constraintOrder) {
116: case Constraint.BEFORE: // Same as LESSTHAN
117: sf = ScoringFunction.createNearOrBelow(AspectValue
118: .newAspectValue(event, value), slope);
119: break;
120: case Constraint.AFTER: // Same as GREATERTHAN
121: sf = ScoringFunction.createNearOrAbove(AspectValue
122: .newAspectValue(event, value), slope);
123: break;
124: case Constraint.COINCIDENT: // Same as EQUALTO
125: sf = ScoringFunction.createStrictlyAtValue(AspectValue
126: .newAspectValue(event, value));
127: break;
128: default:
129: return;
130: }
131: Preference pref = new PreferenceImpl(event, sf);
132: task.setPreference(pref);
133: }
134:
135: /**
136: * setValue sets the aspect value. To be used on a Constrained task
137: * to set the aspect value to a value that will satisfy constraints
138: **/
139: public void setValue(double value) {
140: setValue(value, Constraint.COINCIDENT, 0.0);
141: }
142:
143: }
|