org.cloudbus.cloudsim.network.topologies.TopologicalNode Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudsim-plus Show documentation

CloudSim Plus: A modern, highly extensible and easier-to-use Java 8+ Framework for Modeling and Simulation of Cloud Computing Infrastructures and Services

There is a newer version: 8.0.0

Show newest version

/*
 * Title:        CloudSim Toolkit
 * Description:  CloudSim (Cloud Simulation) Toolkit for Modeling and Simulation of Clouds
 * Licence:      GPL - http://www.gnu.org/copyleft/gpl.html
 *
 * Copyright (c) 2009-2012, The University of Melbourne, Australia
 */

package org.cloudbus.cloudsim.network.topologies;

import java.util.Objects;

/**
 * Represents a topological network node that retrieves its information from a
 * topological-generated file (e.g. topology-generator)
 *
 * @author Thomas Hohnstein
 * @since CloudSim Toolkit 1.0
 */
public class TopologicalNode {
    private int id;
    private String nodeName;
    private Point2D worldCoordinates;

    /**
     * Creates a network topology node with ID equals to zero.
     */
    public TopologicalNode(){
        this(0);
    }

    /**
     * Creates a network topology node with a specific ID.
     *
     * @param id The BRITE id of the node inside the network
     */
    public TopologicalNode(final int id) {
        this(id, new Point2D());
    }

    /**
     * Creates a network topology node including world-coordinates.
     *
     * @param id The BRITE id of the node inside the network
     * @param worldCoordinates  the x,y world-coordinates of the Node
     */
    public TopologicalNode(final int id, final Point2D worldCoordinates) {
        this(id, String.valueOf(id), worldCoordinates);
    }

    /**
     * Creates a network topology node including world-coordinates and the nodeName.
     *
     * @param id   The BRITE id of the node inside the network
     * @param nodeName The name of the node inside the network
     * @param worldCoordinates    the x,y world-coordinates of the Node
     */
    public TopologicalNode(final int id, final String nodeName, final Point2D worldCoordinates) {
        this.worldCoordinates = Objects.requireNonNull(worldCoordinates);
        this.id = id;
        this.nodeName = nodeName;
    }

    /**
     * Gets the BRITE id of the node inside the network.
     *
     * @return the nodeId
     */
    public int getId() {
        return id;
    }

    public void setId(final int id) {
        this.id = id;
    }

    /**
     * Gets the name of the node
     *
     * @return name of the node
     */
    public String getNodeName() {
        return nodeName;
    }

    public void setNodeName(final String nodeName) {
        this.nodeName = nodeName;
    }
    /**
     * Gets the x,y world coordinates of this network-node.
     *
     * @return the x,y world coordinates
     */
    public Point2D getWorldCoordinates() {
        return worldCoordinates;
    }

    public void setWorldCoordinates(final Point2D worldCoordinates) {
        this.worldCoordinates = worldCoordinates;
    }

    @Override
    public boolean equals(final Object obj) {
        if (this == obj) return true;
        if (obj == null || getClass() != obj.getClass()) return false;
        final TopologicalNode other = (TopologicalNode) obj;
        return other.id == id;
    }

    @Override
    public int hashCode() {
        return 31 * Long.hashCode(id);
    }
}