ineighborhoodtopology.java

使用java编写的关于通讯及串口编程所必需的类库

/*
 * INeighborhood.java
 *
 * This is a required part of the com.adaptiveview.ospso package.
 *
 * Copyright (C) 2003 AdaptiveView.com
 * 
 * This library 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 2 of the License, or (at your option) any later version.
 * 
 * This library 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 this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * You may contact AdaptiveView.com via email at: [e-mail] 
 *
 */

package com.adaptiveview.ospso;


/** Defines the required methods for getting a particle's neighbors
 * according to the neighborhood topology.
 *
 * @author AdaptiveView.com
 */
public interface INeighborhoodTopology extends com.adaptiveview.ospso.dmi.DMI_GPL_License {
    /** The neighborhood topology is a circle.
     */
    public static final String CIRCLE = "Circle";
    
    /** The neighborhood topology is a star.
     */
    public static final String STAR = "Star";
    
    /** The neighborhood topology is global (all particles are neighbors).
     */
    public static final String GLOBAL = "Global";
    
    /** Returns an int array containing the IDs of a particle's neighbors.
     * @param particleID the ID of the particle (whose neighborhood)
     * @throws IllegalArgumentException if the arg1 particle ID is invalid.
     * @return an int array containing the IDs of a particle's neighbors.
     */
    public int[] getNeighborIDs(int particleID) throws IllegalArgumentException;
    
    /** Returns a String (static final field) identifying the neighborhood topology type.
     * @return a String field identifying the neighborhood topology type.
     */
    public String getTopology();
        
}