Net.java

/*
 *  Copyright (C) 2014  Alfons Wirtz  
 *   website www.freerouting.net
 *
 *   This program 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.
 *
 *   This program 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 at <http://www.gnu.org/licenses/> 
 *   for more details.
 *
 * Net.java
 *
 * Created on 19. Mai 2004, 08:58
 */

package designformats.specctra;

import java.util.Collection;
import java.util.Set;
import java.util.TreeSet;
import java.util.Iterator;

import datastructures.IndentFileWriter;
import datastructures.IdentifierType;


/**
 * Class for reading and writing net scopes from dsn-files.
 *
 * @author  alfons
 */
public class Net
{
    
    /** Creates a new instance of Net */
    public Net(Id p_net_id)
    {
        id = p_net_id;
    }
    
    public static void write_scope(WriteScopeParameter p_par, rules.Net p_net, Collection<board.Pin> p_pin_list) throws java.io.IOException
    {
        p_par.file.start_scope();
        write_net_id(p_net, p_par.file, p_par.identifier_type);
        // write the pins scope
        p_par.file.start_scope();
        p_par.file.write("pins");
        Iterator<board.Pin> it = p_pin_list.iterator();
        while (it.hasNext())
        {
            board.Pin curr_pin = it.next();
            if (curr_pin.contains_net(p_net.net_number))
            {
                write_pin(p_par, curr_pin);
            }
        }
        p_par.file.end_scope();
        p_par.file.end_scope();
    }
    
    public static void write_net_id( rules.Net p_net, IndentFileWriter p_file, IdentifierType p_identifier_type) throws java.io.IOException
    {
        p_file.write("net ");
        p_identifier_type.write(p_net.name, p_file);
        p_file.write(" ");
        Integer subnet_number = p_net.subnet_number;
        p_file.write(subnet_number.toString());
    }
    
    public static void write_pin(WriteScopeParameter p_par, board.Pin p_pin) throws java.io.IOException
    {
        board.Component curr_component = p_par.board.components.get(p_pin.get_component_no());
        if (curr_component == null)
        {
            System.out.println("Net.write_scope: component not found");
            return;
        }
        library.Package.Pin lib_pin = curr_component.get_package().get_pin(p_pin.get_index_in_package());
        if (lib_pin == null)
        {
            System.out.println("Net.write_scope:  pin number out of range");
            return;
        }
        p_par.file.new_line();
        p_par.identifier_type.write(curr_component.name, p_par.file);
        p_par.file.write("-");
        p_par.identifier_type.write(lib_pin.name, p_par.file);
        
    }
    
    public void set_pins(Collection<Pin> p_pin_list)
    {
        pin_list = new TreeSet<Pin>();
        for (Pin curr_pin : p_pin_list)
        {
            pin_list.add(curr_pin);
        }
    }
    
    public Set<Pin> get_pins()
    {
        return pin_list;
    }
    
    public final Id id;
    
    /** List of elements of type Pin. */
    private Set<Pin> pin_list = null;
    
    public static class Id implements Comparable<Id>
    {
        public Id(String p_name, int p_subnet_number)
        {
            name = p_name;
            subnet_number = p_subnet_number;
        }
        
        public int compareTo(Id p_other)
        {
            int result = this.name.compareTo(p_other.name);
            if (result == 0)
            {
                result = this.subnet_number - p_other.subnet_number;
            }
            return result;
        }
        
        public final String name;
        public final int subnet_number;
    }
    
    
    /**
     * Sorted tuple of component name and pin name.
     */
    public static class Pin implements Comparable<Pin>
    {
        public Pin(String p_component_name, String p_pin_name)
        {
            component_name = p_component_name;
            pin_name = p_pin_name;
        }
        
        public int compareTo(Pin p_other)
        {
            int result = this.component_name.compareTo(p_other.component_name);
            if (result == 0)
            {
                result = this.pin_name.compareTo(p_other.pin_name);
            }
            return result;
        }
        
        public final String component_name;
        public final String pin_name;
    }
}