sim.portrayal.network.SpatialNetwork2D Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mason Show documentation

MASON is a fast discrete-event multiagent simulation library core in Java, designed to be the foundation for large custom-purpose Java simulations, and also to provide more than enough functionality for many lightweight simulation needs. MASON contains both a model library and an optional suite of visualization tools in 2D and 3D.

The newest version!

/*
  Copyright 2006 by Sean Luke and George Mason University
  Licensed under the Academic Free License version 3.0
  See the file "LICENSE" for more information
*/

package sim.portrayal.network;

import sim.field.*;
import sim.field.grid.*;
import sim.field.continuous.*;
import sim.field.network.*;
import sim.util.*;

/** A wrapper used by NetworkPortrayal2D to hold a Network and EITHER a Continuous2D OR a SparseGrid2D.
    The Continuous2D/SparseGrid2D specifies the spatial location of the nodes; the Network specifies the
    edges connecting those nodes. 
    
    SpatialNetwork2D can also hold an additional location (another Continuous2D/SparseGrid2D) which might
    hold the nodes if the first location does not.  This allows you to (for example) have the FROM nodes
    in one field and the TO nodes in another field.  You can set this location with setAuxillaryField.
    Note that this will only work properly if the fields have exactly the same dimensions with respect to
    how their field portrayals draw them onscreen.  As a sanity check: you shouldn't have one field be a Continuous2D
    and the other be a SparseGrid2D.  */

public class SpatialNetwork2D
    {
    public SparseField field;
    public SparseField field2;
    public Network network;

    public SpatialNetwork2D( final Continuous2D field, final Network network )
        {
        this.field = field;
        if (field == null)
            throw new RuntimeException("Null Continuous2D.");
        this.network = network;
        if (network == null)
            throw new RuntimeException("Null Network.");
        }
    
    public SpatialNetwork2D( final SparseGrid2D grid, final Network network )
        {
        this.field = grid;
        if (field == null)
            throw new RuntimeException("Null SparseGrid2D.");
        this.network = network;
        if (network == null)
            throw new RuntimeException("Null Network.");
        }
    
    public void setAuxillaryField( final Continuous2D f)
        {
        field2 = f;
        if (field2 != null && field instanceof SparseGrid2D)
            throw new RuntimeException("The auxillary field of a SpatialNetwork2D should be the same type as the primary field.");
        }

    public void setAuxillaryField( final SparseGrid2D f)
        {
        field2 = f;
        if (field2 != null && field instanceof Continuous2D)
            throw new RuntimeException("The auxillary field of a SpatialNetwork2D should be the same type as the primary field.");
        }

    public Double2D getObjectLocation(Object node)
        {
        Double2D loc = null;
        if (field instanceof Continuous2D) loc = ((Continuous2D)field).getObjectLocation(node);
        else loc = ((SparseGrid2D)field).getObjectLocationAsDouble2D(node);
        if (loc == null && field2 != null)
            {
            if (field2 instanceof Continuous2D) loc = ((Continuous2D)field2).getObjectLocation(node);
            else loc = ((SparseGrid2D)field2).getObjectLocationAsDouble2D(node);
            }
        return loc;
        }

    public double getWidth()
        {
        if (field instanceof Continuous2D) return ((Continuous2D)field).getWidth();
        else return ((SparseGrid2D)field).getWidth();
        }
        
    public double getHeight()
        {
        if (field instanceof Continuous2D) return ((Continuous2D)field).getHeight();
        else return ((SparseGrid2D)field).getHeight();
        }
    }