com.github.rinde.logistics.pdptw.mas.comm.AuctionTimeStatsLogger.java Source code

Introduction

Here is the source code for com.github.rinde.logistics.pdptw.mas.comm.AuctionTimeStatsLogger.java

Source

/*
 * Copyright (C) 2013-2016 Rinde van Lon, iMinds-DistriNet, KU Leuven
 *
 * 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 com.github.rinde.logistics.pdptw.mas.comm;

import java.util.ArrayList;
import java.util.List;

import com.github.rinde.logistics.pdptw.mas.comm.AuctionCommModel.AuctionEvent;
import com.github.rinde.rinsim.central.Measurable;
import com.github.rinde.rinsim.central.SolverTimeMeasurement;
import com.github.rinde.rinsim.core.model.DependencyProvider;
import com.github.rinde.rinsim.core.model.Model.AbstractModel;
import com.github.rinde.rinsim.core.model.ModelBuilder.AbstractModelBuilder;
import com.github.rinde.rinsim.event.Event;
import com.github.rinde.rinsim.event.Listener;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ArrayListMultimap;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableListMultimap;
import com.google.common.collect.ListMultimap;

/**
 * Utility for keeping track of auction related statistics. To use it, simply
 * add {@link #builder()} to a simulation configuration. The statistics that are
 * tracked are all finished {@link AuctionEvent}s and using
 * {@link #getTimeMeasurements()} all time measurements can be collected.
 * @author Rinde van Lon
 */
public class AuctionTimeStatsLogger extends AbstractModel<Bidder<DoubleBid>> {
    final List<AuctionEvent> finishEvents;
    private final List<Bidder<DoubleBid>> bidders;

    AuctionTimeStatsLogger(AuctionCommModel<?> model) {
        finishEvents = new ArrayList<>();
        bidders = new ArrayList<>();

        model.getEventAPI().addListener(new Listener() {
            @Override
            public void handleEvent(Event e) {
                finishEvents.add((AuctionEvent) e);
            }
        }, AuctionCommModel.EventType.FINISH_AUCTION);
    }

    /**
     * @return A multimap of {@link Bidder}s to {@link SolverTimeMeasurement}s.
     */
    public ImmutableListMultimap<Bidder<?>, SolverTimeMeasurement> getTimeMeasurements() {
        final ListMultimap<Bidder<?>, SolverTimeMeasurement> map = ArrayListMultimap.create();
        for (final Bidder<DoubleBid> b : bidders) {
            if (b instanceof Measurable) {
                map.putAll(b, ((Measurable) b).getTimeMeasurements());
            }
        }
        return ImmutableListMultimap.copyOf(map);
    }

    /**
     * @return All auction finish events that have occured so far.
     */
    public ImmutableList<AuctionEvent> getAuctionFinishEvents() {
        return ImmutableList.copyOf(finishEvents);
    }

    @Override
    public boolean register(Bidder<DoubleBid> element) {
        bidders.add(element);
        return true;
    }

    @Override
    public boolean unregister(Bidder<DoubleBid> element) {
        return false;
    }

    /**
     * @return {@link Builder} for {@link AuctionTimeStatsLogger}.
     */
    public static Builder builder() {
        return new AutoValue_AuctionTimeStatsLogger_Builder();
    }

    /**
     * Builder for {@link AuctionTimeStatsLogger}.
     * @author Rinde van Lon
     */
    @AutoValue
    public abstract static class Builder extends AbstractModelBuilder<AuctionTimeStatsLogger, Bidder<DoubleBid>> {

        private static final long serialVersionUID = 5417079781123182630L;

        Builder() {
            setDependencies(AuctionCommModel.class);
        }

        @Override
        public AuctionTimeStatsLogger build(DependencyProvider dependencyProvider) {
            return new AuctionTimeStatsLogger(dependencyProvider.get(AuctionCommModel.class));
        }
    }

}