/*
* 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.
*
* Package.java
*
* Created on 27. Mai 2004, 06:53
*/
package library;
import geometry.planar.Vector;
import geometry.planar.Shape;
import geometry.planar.Area;
/**
* Component package templates describing the padstacks and
* relative locations of the packege pins,
* and optional other stuff like an outline package keepouts.
*
* @author alfons
*/
public class Package implements Comparable<Package>, board.ObjectInfoPanel.Printable, java.io.Serializable
{
/**
* Creates a new instance of Package.
* p_package_list is the list of packages containing this package.
*/
public Package(String p_name, int p_no, Pin[] p_pin_arr, Shape[] p_outline, Keepout[] p_keepout_arr,
Keepout[] p_via_keepout_arr, Keepout[] p_place_keepout_arr, boolean p_is_front, Packages p_package_list)
{
name = p_name;
no = p_no;
pin_arr = p_pin_arr;
outline = p_outline;
keepout_arr = p_keepout_arr;
via_keepout_arr = p_via_keepout_arr;
place_keepout_arr = p_place_keepout_arr;
is_front = p_is_front;
package_list = p_package_list;
}
/**
* Compares 2 packages by name.
* Useful for example to display packages in alphabetic order.
*/
public int compareTo(Package p_other)
{
return this.name.compareToIgnoreCase(p_other.name);
}
/**
* Returns the pin with the input number from this package.
*/
public Pin get_pin(int p_no)
{
if (p_no < 0 || p_no >= pin_arr.length)
{
System.out.println("Package.get_pin: p_no out of range");
return null;
}
return pin_arr[p_no];
}
/**
* Returns the pin number of the pin with the input name from this package, or -1, if no such pin exists
* Pin numbers are from 0 to pin_count - 1.
*/
public int get_pin_no(String p_name)
{
for (int i = 0; i < pin_arr.length; ++i)
{
if (pin_arr[i].name.equals(p_name))
{
return i;
}
}
return -1;
}
/**
* Returns the pin count of this package.
*/
public int pin_count()
{
return pin_arr.length;
}
public String toString()
{
return this.name;
}
public void print_info(board.ObjectInfoPanel p_window, java.util.Locale p_locale)
{
java.util.ResourceBundle resources =
java.util.ResourceBundle.getBundle("board.resources.ObjectInfoPanel", p_locale);
p_window.append_bold(resources.getString("package") + " ");
p_window.append_bold(this.name);
for (int i = 0; i < this.pin_arr.length; ++i)
{
Pin curr_pin = this.pin_arr[i];
p_window.newline();
p_window.indent();
p_window.append(resources.getString("pin") + " ");
p_window.append(curr_pin.name);
p_window.append(", " + resources.getString("padstack") + " ");
Padstack curr_padstack = this.package_list.padstack_list.get(curr_pin.padstack_no);
p_window.append(curr_padstack.name, resources.getString("padstack_info"), curr_padstack);
p_window.append(" " + resources.getString("at") + " ");
p_window.append(curr_pin.relative_location.to_float());
p_window.append(", " + resources.getString("rotation") + " ");
p_window.append_without_transforming(curr_pin.rotation_in_degree);
}
p_window.newline();
}
/** The name of the package. */
public final String name;
/** Internallly generated package number. */
public final int no;
/** The array of pins of this padstack. */
private final Pin [] pin_arr;
/** The outline of the component, which may be null. */
public final Shape[] outline;
public final Keepout[] keepout_arr;
public final Keepout[] via_keepout_arr;
public final Keepout[] place_keepout_arr;
/** If false, the package is placed on the back side of the board */
public final boolean is_front;
private final Packages package_list;
/**
* Describes a pin padstack of a package.
*/
public static class Pin implements java.io.Serializable
{
/**
* Creates a new package pin with the input coordinates relative
* to the package location.
*/
public Pin(String p_name, int p_padstack_no, Vector p_relative_location, double p_rotation_in_degree)
{
name = p_name;
padstack_no = p_padstack_no;
relative_location = p_relative_location;
rotation_in_degree = p_rotation_in_degree;
}
/** The name of the pin. */
public final String name;
/** The number of the padstack mask of the pin. */
public final int padstack_no;
/** The location of the pin relative to its package. */
public final Vector relative_location;
/** the rotation of the pin padstack */
public final double rotation_in_degree;
}
/** Deescribes a named keepout belonging to a package, */
public static class Keepout implements java.io.Serializable
{
public Keepout(String p_name, Area p_area, int p_layer)
{
name = p_name;
area = p_area;
layer = p_layer;
}
public final String name;
public final Area area;
public final int layer;
}
}