io.github.agentsoz.bdimatsim.MATSimPerceptHandler Maven / Gradle / Ivy

Go to download
package io.github.agentsoz.bdimatsim;

/*
 * #%L
 * BDI-ABM Integration Package
 * %%
 * Copyright (C) 2014 - 2017 by its authors. See AUTHORS file.
 * %%
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Lesser Public License for more details.
 * 
 * You should have received a copy of the GNU General Lesser Public
 * License along with this program.  If not, see
 * .
 * #L%
 */

import org.matsim.api.core.v01.Id;
import org.matsim.api.core.v01.network.Link;
import org.matsim.api.core.v01.population.Person;
import io.github.agentsoz.bdimatsim.AgentActivityEventHandler.MonitoredEventType;
import io.github.agentsoz.bdimatsim.app.BDIPerceptHandler;

/**
 * @author Edmund Kemsley, Dhirendra Singh
 */

public final class MATSimPerceptHandler {

	private final AgentActivityEventHandler eventHandler;

	/**
	 * Constructor
	 * 
	 * @param matSimModel
	 */
	protected MATSimPerceptHandler(final MATSimModel matSimModel) {
		this.eventHandler = matSimModel.getEventHandler();
	}

	/**
	 * For a given agent, registers a {@link BDIPerceptHandler} to be called 
	 * whenever an event of type {@link MonitoredEventType} is triggered
	 * for {@code linkId}. 
	 * @param agentId
	 * @param linkId
	 * @param event
	 * @param handler
	 * @return
	 */
	public int registerBDIPerceptHandler(Id agentId, MonitoredEventType event,Id linkId, BDIPerceptHandler handler) {
		return eventHandler.registerMonitor(agentId, event, linkId, handler);
	}

	/**
	 * Process percepts
	 * 
	 * @param agentIDg
	 *            ID of the agent
	 * @param perceptID
	 *            Percept IDs are defined in {@link MATSimPerceptList}. eg:
	 *            ARRIVED, REQUESTLOCATION.
	 * @return The response
	 */
	@Deprecated
	final Object[] processPercept(String agentID, String perceptID) {
		System.err.println("processPercept(String agentID, String perceptID) should never be called (deprecated)!");
		return null;
	}
	
}