Node.java

/**
 * ****************************************************************************
 * Copyright (c) 2010-2016 by Min Cai (min.cai.china@gmail.com).
 * <p>
 * This file is part of the Archimulator multicore architectural simulator.
 * <p>
 * Archimulator 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
 * (at your option) any later version.
 * <p>
 * Archimulator 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.
 * <p>
 * You should have received a copy of the GNU General Public License
 * along with Archimulator. If not, see <http://www.gnu.org/licenses/>.
 * ****************************************************************************
 */
package archimulator.util.ai.aco;

import java.util.Set;

/**
 * Node.
 *
 * @author Min Cai
 */
public class Node {
    private ACOHelper acoHelper;
    private String name;

    private double x;
    private double y;

    /**
     * Create a node.
     *
     * @param acoHelper the ACO helper
     * @param name      the name
     * @param x         the x coordinate
     * @param y         the y coordinate
     */
    public Node(ACOHelper acoHelper, String name, double x, double y) {
        this.acoHelper = acoHelper;
        this.name = name;
        this.x = x;
        this.y = y;
    }

    /**
     * Get the ACO helper.
     *
     * @return the ACO helper
     */
    public ACOHelper getAcoHelper() {
        return acoHelper;
    }

    /**
     * Get the name.
     *
     * @return the name
     */
    public String getName() {
        return name;
    }

    /**
     * Get the x coordinate.
     *
     * @return the x coordinate
     */
    public double getX() {
        return x;
    }

    /**
     * Get the y coordinate.
     *
     * @return the y coordinate
     */
    public double getY() {
        return y;
    }

    /**
     * Get the set of edges.
     *
     * @return the set of edges
     */
    public Set<Edge> getEdges() {
        return this.getAcoHelper().getGraph().edgesOf(this);
    }

    @Override
    public String toString() {
        return String.format("%s", this.getName());
    }
}