RandomAttractionGenerator.java

/*
 * Copyright (c) 2005-2010 KOM – Multimedia Communications Lab
 *
 * This file is part of PeerfactSim.KOM.
 * 
 * PeerfactSim.KOM is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 * 
 * PeerfactSim.KOM 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 Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with PeerfactSim.KOM.  If not, see <http://www.gnu.org/licenses/>.
 *
 */

package de.tud.kom.p2psim.impl.topology.movement.modularosm.attraction;

import java.util.LinkedList;
import java.util.List;
import java.util.Random;

import de.tud.kom.p2psim.api.scenario.ConfigurationException;
import de.tud.kom.p2psim.api.topology.Topology;
import de.tud.kom.p2psim.impl.topology.util.PositionVector;
import de.tudarmstadt.maki.simonstrator.api.Binder;
import de.tudarmstadt.maki.simonstrator.api.Randoms;
import de.tudarmstadt.maki.simonstrator.api.component.sensor.location.AttractionPoint;
import de.tudarmstadt.maki.simonstrator.api.util.XMLConfigurableConstructor;

/**
 * Implementation of the interface {@link AttractionGenerator}.
 * 
 * Generates the given number of {@link AttractionPoint}s and sets the
 * position randomly within the world dimensions.
 * 
 * @author Christoph Muenker, Julian Zobel
 * @version 1.1, 09 2018
 */
public class RandomAttractionGenerator implements IAttractionGenerator {

	private Random rand;

	private PositionVector worldDimension;

	private int numberOfAttractionPoints;

	private boolean numberOfAPsSet = false;
	
	private List<AttractionPoint> attractionPoints;

	@XMLConfigurableConstructor({"numberOfAttractionPoints"})
	public RandomAttractionGenerator(int numberOfAttractionPoints) {
		this.rand = Randoms.getRandom(RandomAttractionGenerator.class);
		this.worldDimension = Binder.getComponentOrNull(Topology.class)
				.getWorldDimensions();
		if (numberOfAttractionPoints <= 0) {
			throw new ConfigurationException(
					"NumberOfAttractionPoints should be at least 1!");
		}
		this.numberOfAPsSet = true;
		this.numberOfAttractionPoints = numberOfAttractionPoints;
		this.attractionPoints = new LinkedList<AttractionPoint>();
		createAttractionPoints();
	}

	@Override
	public List<AttractionPoint> getAttractionPoints() {
		if (!numberOfAPsSet) {
			throw new ConfigurationException(
					"Number of Attraction Points is not set in RandomAttractionGenerator!");
		}

		if(attractionPoints.isEmpty())
			createAttractionPoints();
		
		return attractionPoints;
	}
	
	private void createAttractionPoints() {
		List<AttractionPoint> result = new LinkedList<AttractionPoint>();
		for (int i = 0; i < numberOfAttractionPoints; i++) {
			PositionVector posVec = createPosVec();
			AttractionPoint aPoint = new AttractionPointImpl("AP"+i, posVec);
			result.add(aPoint);
		}
		
		attractionPoints.clear();
		attractionPoints.addAll(result);
	}

	private PositionVector createPosVec() {
		double x = rand.nextDouble() * worldDimension.getX();
		double y = rand.nextDouble() * worldDimension.getY();
		return new PositionVector(x, y);
	}

}