org.optaplanner.examples.batchscheduling.domain.Allocation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of optaplanner-examples
OptaPlanner solves planning problems. This lightweight, embeddable planning engine implements powerful and scalable algorithms to optimize business resource scheduling and planning. This module contains the examples which demonstrate how to use it in a normal Java application.
There is a newer version: 9.44.0.Final
Show newest version
/*
 * Copyright 2021 Red Hat, Inc. and/or its affiliates.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.optaplanner.examples.batchscheduling.domain;

import org.optaplanner.core.api.domain.entity.PlanningEntity;
import org.optaplanner.core.api.domain.valuerange.CountableValueRange;
import org.optaplanner.core.api.domain.valuerange.ValueRangeFactory;
import org.optaplanner.core.api.domain.valuerange.ValueRangeProvider;
import org.optaplanner.core.api.domain.variable.CustomShadowVariable;
import org.optaplanner.core.api.domain.variable.PlanningVariable;
import org.optaplanner.core.api.domain.variable.PlanningVariableReference;
import org.optaplanner.examples.batchscheduling.app.BatchSchedulingApp;
import org.optaplanner.examples.batchscheduling.domain.solver.PredecessorsDoneDateUpdatingVariableListener;
import org.optaplanner.examples.common.domain.AbstractPersistable;

import com.thoughtworks.xstream.annotations.XStreamAlias;

@PlanningEntity
@XStreamAlias("PipeAllocation")
public class Allocation extends AbstractPersistable {

    private Batch batch;
    private RoutePath routePath;
    private Segment segment;
    private Allocation predecessorAllocation;
    private Allocation successorAllocation;

    // Planning variables, changes during planning, between score calculation
    private Long delay;

    // Shadow variables
    private Long predecessorsDoneDate;

    public Batch getBatch() {
        return batch;
    }

    public void setBatch(Batch batch) {
        this.batch = batch;
    }

    public RoutePath getRoutePath() {
        return routePath;
    }

    public void setRoutePath(RoutePath routePath) {
        this.routePath = routePath;
    }

    public Segment getSegment() {
        return segment;
    }

    public void setSegment(Segment segment) {
        this.segment = segment;
    }

    public Allocation getPredecessorAllocation() {
        return predecessorAllocation;
    }

    public void setPredecessorAllocation(Allocation predecessorAllocation) {
        this.predecessorAllocation = predecessorAllocation;
    }

    public Allocation getSuccessorAllocation() {
        return successorAllocation;
    }

    public void setSuccessorAllocation(Allocation successorAllocation) {
        this.successorAllocation = successorAllocation;
    }

    public void setDelay(Long delay) {
        this.delay = delay;
    }

    public void setPredecessorsDoneDate(Long predecessorsDoneDate) {
        this.predecessorsDoneDate = predecessorsDoneDate;
    }

    // Start of Injection is start of injection time of Batch Head
    public Long getStartInjectionTime() {
        if (delay == null) {
            return null;
        }

        if ((predecessorAllocation != null) && (predecessorsDoneDate != null)) {
            return (delay + predecessorsDoneDate);
        } else {
            return delay;
        }

    }

    // End of Injection is end of injection time of Batch Tail
    public Long getEndInjectionTime() {
        if (getStartInjectionTime() == null) {
            return null;
        }

        // Injection Time
        Double tempInjectionDouble =
                (getBatch().getVolume() / (getSegment().getFlowRate() * BatchSchedulingApp.PERIODINTERVAL_IN_MINUTES));

        Long tempInjectionLong = tempInjectionDouble.longValue();
        int fractionalInjectionInt = (int) Math.round((tempInjectionDouble - tempInjectionLong) * 100);

        if (fractionalInjectionInt >= BatchSchedulingApp.FRACTIONAL_VOLUME_PERCENTAGE) {
            return getStartInjectionTime() + tempInjectionLong + 1;
        } else {
            return getStartInjectionTime() + tempInjectionLong;
        }
    }

    // Start of Delivery is Start of Injection Time + Travel Time through Pipeline
    // of Batch Head
    public Long getStartDeliveryTime() {
        if (getStartInjectionTime() == null) {
            return null;
        }

        // Travel Time
        Double tempTravelDouble = (double) ((getSegment().getLength() * getSegment().getCrossSectionArea())
                / (getSegment().getFlowRate() * BatchSchedulingApp.PERIODINTERVAL_IN_MINUTES));
        Long tempTravelLong = tempTravelDouble.longValue();
        int fractionalTravelInt = (int) Math.round((tempTravelDouble - tempTravelLong) * 100);

        if (fractionalTravelInt >= BatchSchedulingApp.FRACTIONAL_VOLUME_PERCENTAGE) {
            return getStartInjectionTime() + tempTravelLong + 1;
        } else {
            return getStartInjectionTime() + tempTravelLong;
        }
    }

    // End of Delivery is End of Injection Time + Travel Time through Pipeline of
    // Batch Tail
    public Long getEndDeliveryTime() {

        if (getStartInjectionTime() == null) {
            return null;
        }

        // Travel Time
        Double tempTravelDouble = (double) ((getSegment().getLength() * getSegment().getCrossSectionArea())
                / (getSegment().getFlowRate() * BatchSchedulingApp.PERIODINTERVAL_IN_MINUTES));
        Long tempTravelLong = tempTravelDouble.longValue();

        int fractionalTravelInt = (int) Math.round((tempTravelDouble - tempTravelLong) * 100);

        if (fractionalTravelInt >= BatchSchedulingApp.FRACTIONAL_VOLUME_PERCENTAGE) {
            tempTravelLong = getStartInjectionTime() + tempTravelLong + 1;
        } else {
            tempTravelLong = getStartInjectionTime() + tempTravelLong;
        }

        // Injection Time
        Double tempDeliveryDouble =
                (getBatch().getVolume() / (getSegment().getFlowRate() * BatchSchedulingApp.PERIODINTERVAL_IN_MINUTES));
        Long tempDeliveryLong = tempDeliveryDouble.longValue();
        int fractionalDeliveryInt = (int) Math.round((tempDeliveryDouble - tempDeliveryLong) * 100);

        if (fractionalDeliveryInt >= BatchSchedulingApp.FRACTIONAL_VOLUME_PERCENTAGE) {
            return tempTravelLong + tempDeliveryLong + 1;
        } else {
            return tempTravelLong + tempDeliveryLong;
        }
    }

    public String getLabel() {
        return "Label:: " + batch.getName() + " " + routePath.getPath() + " " + segment.getName();
    }

    public Boolean isFirst() {
        if (predecessorAllocation != null) {
            return Boolean.FALSE;
        } else {
            return Boolean.TRUE;
        }
    }

    @PlanningVariable(nullable = true, valueRangeProviderRefs = { "delayRange" })
    public Long getDelay() {
        return delay;
    }

    @CustomShadowVariable(variableListenerClass = PredecessorsDoneDateUpdatingVariableListener.class, sources = {
            @PlanningVariableReference(variableName = "delay") })
    public Long getPredecessorsDoneDate() {
        return predecessorsDoneDate;
    }

    @ValueRangeProvider(id = "delayRange")
    public CountableValueRange getDelayRange() {
        // Delay Range
        if (getBatch().getDelayRangeValue() != null) {
            return ValueRangeFactory.createLongValueRange(0, getBatch().getDelayRangeValue());
        } else {
            return ValueRangeFactory.createLongValueRange(0, 2000);
        }
    }

}