rusefi
/
freerouting
mirror of https://github.com/rusefi/freerouting.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Removed the "eu.mihosoft.freerouting." string from the comment sections 

When the package "eu.mihosoft.freerouting"was introduced that was probably done with a search and replace function. This messed up some of the documentation section of the code. This commit fixes that.
This commit is contained in:
Andras Fuchs 2020-02-06 19:09:59 +01:00
parent 6c5262083d
commit ae07f577a4
138 changed files with 514 additions and 514 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/main/java/eu/mihosoft/freerouting/autoroute/AutorouteControl.java
View File

@ -30,7 +30,7 @@ import eu.mihosoft.freerouting.rules.ViaRule;
import eu.mihosoft.freerouting.board.RoutingBoard;
/**
* Structure for controlling the eu.mihosoft.freerouting.autoroute algorithm.
* Structure for controlling the autoroute algorithm.
*
* @author Alfons Wirtz
*/
@ -176,18 +176,18 @@ public class AutorouteControl
public final ExpansionCostFactor[] trace_costs;
/** Defines for each layer, if it may used for routing. */
final boolean[] layer_active;
/** The currently used net number in the eu.mihosoft.freerouting.autoroute algorithm */
/** The currently used net number in the autoroute algorithm */
int net_no;
/** The currently used trace half widths in the eu.mihosoft.freerouting.autoroute algorithm on each layer */
/** The currently used trace half widths in the autoroute algorithm on each layer */
final int[] trace_half_width;
/**
* The currently used compensated trace half widths in the eu.mihosoft.freerouting.autoroute algorithm on each layer.
* The currently used compensated trace half widths in the autoroute algorithm on each layer.
* Equal to trace_half_width if no clearance compensation is used.
*/
final int[] compensated_trace_half_width;
/** The currently used clearance class for traces in the eu.mihosoft.freerouting.autoroute algorithm */
/** The currently used clearance class for traces in the autoroute algorithm */
public int trace_clearance_class_no;
/** The currently used clearance class for vias in the eu.mihosoft.freerouting.autoroute algorithm */
/** The currently used clearance class for vias in the autoroute algorithm */
int via_clearance_class;
/** The possible (partial) vias, which can be used by the autorouter */
ViaRule via_rule;
@ -223,14 +223,14 @@ public class AutorouteControl
public int ripup_costs;
public int ripup_pass_no;
public final boolean with_neckdown;
/** If true, the eu.mihosoft.freerouting.autoroute algorithm completes after the first drill */
/** If true, the autoroute algorithm completes after the first drill */
public boolean is_fanout;
/**
* Normally true, if the autorouter contains no fanout pass
*/
public boolean remove_unconnected_vias;
/** horizontal and vertical costs for traces on a eu.mihosoft.freerouting.board layer */
/** horizontal and vertical costs for traces on a board layer */
public static class ExpansionCostFactor
{
@ -239,9 +239,9 @@ public class AutorouteControl
horizontal = p_horizontal;
vertical = p_vertical;
}
/** The horizontal expansion cost factor on a layer of the eu.mihosoft.freerouting.board */
/** The horizontal expansion cost factor on a layer of the board */
public final double horizontal;
/** The verical expansion cost factor on a layer of the eu.mihosoft.freerouting.board */
/** The verical expansion cost factor on a layer of the board */
public final double vertical;
}

14
src/main/java/eu/mihosoft/freerouting/autoroute/AutorouteEngine.java
View File

@ -47,7 +47,7 @@ import eu.mihosoft.freerouting.board.TestLevel;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Temporary eu.mihosoft.freerouting.autoroute data stored on the RoutingBoard.
* Temporary autoroute data stored on the RoutingBoard.
*
* @author Alfons Wirtz
*/
@ -189,7 +189,7 @@ public class AutorouteEngine
changed_nets.add(curr_ripped_item.get_net_no(i));
}
}
// let the observers know the changes in the eu.mihosoft.freerouting.board database.
// let the observers know the changes in the board database.
boolean observers_activated = !this.board.observers_active();
if (observers_activated)
{
@ -642,7 +642,7 @@ public class AutorouteEngine
}
/**
* The current search tree used in autorouting.
* It depends on the trac clearance class used in the eu.mihosoft.freerouting.autoroute algorithm.
* It depends on the trac clearance class used in the autoroute algorithm.
*/
public final ShapeSearchTree autoroute_search_tree;
/** If maintain_database, the autorouter database is maintained after a connection is
@ -651,7 +651,7 @@ public class AutorouteEngine
public final boolean maintain_database;
static final int TRACE_WIDTH_TOLERANCE = 2;
/**
* The net number used for routing in this eu.mihosoft.freerouting.autoroute algorithm.
* The net number used for routing in this autoroute algorithm.
*/
private int net_no;
/**
@ -666,11 +666,11 @@ public class AutorouteEngine
* To stop the expansion algorithm after a time limit is exceeded.
*/
private TimeLimit time_limit;
/** The PCB-eu.mihosoft.freerouting.board of this eu.mihosoft.freerouting.autoroute algorithm. */
/** The PCB-board of this autoroute algorithm. */
final RoutingBoard board;
/** The list of incomplete expansion rooms on the routing eu.mihosoft.freerouting.board */
/** The list of incomplete expansion rooms on the routing board */
private List<IncompleteFreeSpaceExpansionRoom> incomplete_expansion_rooms = null;
/** The list of complete expansion rooms on the routing eu.mihosoft.freerouting.board */
/** The list of complete expansion rooms on the routing board */
private List<CompleteFreeSpaceExpansionRoom> complete_expansion_rooms = null;
/** The count of expansion rooms created so far */
private int expansion_room_instance_count = 0;

16
src/main/java/eu/mihosoft/freerouting/autoroute/BatchAutorouter.java
View File

@ -36,7 +36,7 @@ import eu.mihosoft.freerouting.interactive.InteractiveActionThread;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Handles the sequencing of the batch eu.mihosoft.freerouting.autoroute passes.
* Handles the sequencing of the batch autoroute passes.
*
* @author Alfons Wirtz
*/
@ -45,10 +45,10 @@ public class BatchAutorouter
private HashSet<String> already_checked_board_hashes = new HashSet<String>();
/**
* Autoroutes ripup passes until the eu.mihosoft.freerouting.board is completed or the autorouter is stopped by the user,
* Autoroutes ripup passes until the board is completed or the autorouter is stopped by the user,
* or if p_max_pass_count is exceeded. Is currently used in the optimize via batch pass.
* Returns the number of oasses to complete the eu.mihosoft.freerouting.board or p_max_pass_count + 1,
* if the eu.mihosoft.freerouting.board is not completed.
* Returns the number of oasses to complete the board or p_max_pass_count + 1,
* if the board is not completed.
*/
public static int autoroute_passes_for_optimizing_item(InteractiveActionThread p_thread,
int p_max_pass_count, int p_ripup_costs, boolean p_with_prefered_directions)
@ -109,8 +109,8 @@ public class BatchAutorouter
private LinkedList<Integer> diffBetweenBoards = new LinkedList<Integer>();
/**
* Autoroutes ripup passes until the eu.mihosoft.freerouting.board is completed or the autorouter is stopped by the user.
* Returns true if the eu.mihosoft.freerouting.board is completed.
* Autoroutes ripup passes until the board is completed or the autorouter is stopped by the user.
* Returns true if the board is completed.
*/
public boolean autoroute_passes()
{
@ -185,8 +185,8 @@ public class BatchAutorouter
}
/**
* Autoroutes one ripup pass of all items of the eu.mihosoft.freerouting.board.
* Returns false, if the eu.mihosoft.freerouting.board is already completely routed.
* Autoroutes one ripup pass of all items of the board.
* Returns false, if the board is already completely routed.
*/
private boolean autoroute_pass(int p_pass_no, boolean p_with_screen_message)
{

16
src/main/java/eu/mihosoft/freerouting/autoroute/BatchOptRoute.java
View File

@ -37,7 +37,7 @@ import eu.mihosoft.freerouting.interactive.InteractiveActionThread;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* To optimize the vias and traces after the batch autorouter has completed the eu.mihosoft.freerouting.board.
* To optimize the vias and traces after the batch autorouter has completed the board.
*
* @author Alfons Wirtz
*/
@ -45,7 +45,7 @@ public class BatchOptRoute
{
/**
* To optimize the route on the eu.mihosoft.freerouting.board after the eu.mihosoft.freerouting.autoroute task is finished.
* To optimize the route on the board after the autoroute task is finished.
*/
public BatchOptRoute(InteractiveActionThread p_thread)
{
@ -55,7 +55,7 @@ public class BatchOptRoute
}
/**
* Optimize the route on the eu.mihosoft.freerouting.board.
* Optimize the route on the board.
*/
public void optimize_board()
{
@ -76,7 +76,7 @@ public class BatchOptRoute
}
/**
* Pass to reduce the number of vias an to shorten the trace lengthon a completely routed eu.mihosoft.freerouting.board.
* Pass to reduce the number of vias an to shorten the trace length a completely routed board.
* Returns true, if the route was improved.
*/
private boolean opt_route_pass(int p_pass_no, boolean p_with_prefered_directions)
@ -218,7 +218,7 @@ public class BatchOptRoute
/**
* Calculates the cumulative trace lengths multiplied by the trace radius of all traces
* on the eu.mihosoft.freerouting.board, which are not shove_fixed.
* on the board, which are not shove_fixed.
*/
private static double calc_weighted_trace_length(RoutingBoard p_board)
{
@ -271,9 +271,9 @@ public class BatchOptRoute
private static int ADDITIONAL_RIPUP_COST_FACTOR_AT_START = 10;
/**
* Reads the vias and traces on the eu.mihosoft.freerouting.board in ascending x order.
* Because the vias and traces on the eu.mihosoft.freerouting.board change while optimizing the item list
* of the eu.mihosoft.freerouting.board is read from scratch each time the next route item is returned.
* Reads the vias and traces on the board in ascending x order.
* Because the vias and traces on the board change while optimizing the item list
* of the board is read from scratch each time the next route item is returned.
*/
private class ReadSortedRouteItems
{

2
src/main/java/eu/mihosoft/freerouting/autoroute/CompleteFreeSpaceExpansionRoom.java
View File

@ -162,7 +162,7 @@ public class CompleteFreeSpaceExpansionRoom extends FreeSpaceExpansionRoom imple
}
/**
* Calculates the doors to the start and destination items of the eu.mihosoft.freerouting.autoroute algorithm.
* Calculates the doors to the start and destination items of the autoroute algorithm.
*/
public void calculate_target_doors(ShapeTree.TreeEntry p_own_net_object, int p_net_no, ShapeSearchTree p_autoroute_search_tree)
{

2
src/main/java/eu/mihosoft/freerouting/autoroute/DrillPageArray.java
View File

@ -34,7 +34,7 @@ import eu.mihosoft.freerouting.board.RoutingBoard;
/**
* Describes the 2 dimensional array of pages of ExpansionDrill`s used in the maze search algorithm.
* The pages are rectangles of about equal width and height covering covering the bounding box of the eu.mihosoft.freerouting.board area.
* The pages are rectangles of about equal width and height covering covering the bounding box of the board area.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/autoroute/InsertFoundConnectionAlgo.java
View File

@ -43,7 +43,7 @@ import eu.mihosoft.freerouting.board.ItemSelectionFilter;
import eu.mihosoft.freerouting.board.TestLevel;
/**
* Inserts the traces and vias of the connection found by the eu.mihosoft.freerouting.autoroute algorithm.
* Inserts the traces and vias of the connection found by the autoroute algorithm.
*
* @author Alfons Wirtz
*/

6
src/main/java/eu/mihosoft/freerouting/autoroute/ItemAutorouteInfo.java
View File

@ -30,7 +30,7 @@ import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Temporary data stored in eu.mihosoft.freerouting.board Items used in the eu.mihosoft.freerouting.autoroute algorithm
* Temporary data stored in board Items used in the autoroute algorithm
*
* @author Alfons Wirtz
*/
@ -42,7 +42,7 @@ public class ItemAutorouteInfo
this.item = p_item;
}
/**
* Looks, if the corresponding item belongs to the start or destination set of the eu.mihosoft.freerouting.autoroute algorithm.
* Looks, if the corresponding item belongs to the start or destination set of the autoroute algorithm.
* Only used, if the item belongs to the net, which will be currently routed.
*/
public boolean is_start_info()
@ -51,7 +51,7 @@ public class ItemAutorouteInfo
}
/**
* Sets, if the corresponding item belongs to the start or destination set of the eu.mihosoft.freerouting.autoroute algorithm.
* Sets, if the corresponding item belongs to the start or destination set of the autoroute algorithm.
* Only used, if the item belongs to the net, which will be currently routed.
*/
public void set_start_info(boolean p_value)

4
src/main/java/eu/mihosoft/freerouting/autoroute/MazeSearchAlgo.java
View File

@ -954,7 +954,7 @@ public class MazeSearchAlgo
if (this.autoroute_engine.maintain_database)
{
// add the completed start rooms carried over from the last eu.mihosoft.freerouting.autoroute to the start rooms.
// add the completed start rooms carried over from the last autoroute to the start rooms.
completed_start_rooms.addAll(this.autoroute_engine.get_rooms_with_target_items(p_start_items));
}
@ -1443,7 +1443,7 @@ public class MazeSearchAlgo
return enter_through_small_door(p_list_element, curr_item);
}
/**
* The eu.mihosoft.freerouting.autoroute engine of this expansion algorithm.
* The autoroute engine of this expansion algorithm.
*/
public final AutorouteEngine autoroute_engine;
final AutorouteControl ctrl;

4
src/main/java/eu/mihosoft/freerouting/autoroute/ObstacleExpansionRoom.java
View File

@ -36,7 +36,7 @@ import eu.mihosoft.freerouting.geometry.planar.TileShape;
import eu.mihosoft.freerouting.board.Item;
/**
* Expansion Room used for pushing and ripping obstacles in the eu.mihosoft.freerouting.autoroute algorithm.
* Expansion Room used for pushing and ripping obstacles in the autoroute algorithm.
*
* @author Alfons Wirtz
*/
@ -94,7 +94,7 @@ public class ObstacleExpansionRoom implements CompleteExpansionRoom
}
/**
* Creates a 2-dim door with the other obstacle room, if that is useful for the eu.mihosoft.freerouting.autoroute algorithm.
* Creates a 2-dim door with the other obstacle room, if that is useful for the autoroute algorithm.
* It is assumed that this room and p_other have a 2-dimensional overlap.
* Returns false, if no door was created.
*/

2
src/main/java/eu/mihosoft/freerouting/autoroute/TargetItemExpansionDoor.java
View File

@ -28,7 +28,7 @@ import eu.mihosoft.freerouting.board.Item;
import eu.mihosoft.freerouting.board.ShapeSearchTree;
/**
* An expansion door leading to a start or destination item of the eu.mihosoft.freerouting.autoroute algorithm.
* An expansion door leading to a start or destination item of the autoroute algorithm.
*
* @author Alfons Wirtz
*/

122
src/main/java/eu/mihosoft/freerouting/board/BasicBoard.java
View File

@ -49,10 +49,10 @@ import eu.mihosoft.freerouting.datastructures.UndoableObjects;
/**
*
* Provides basic functionality of a eu.mihosoft.freerouting.board with geometric items.
* Provides basic functionality of a board with geometric items.
* Contains functions such as inserting, deleting, modifying
* and picking items and elementary checking functions.
* A eu.mihosoft.freerouting.board may have 1 or several layers.
* A board may have 1 or several layers.
*
* @author Alfons Wirtz
*/
@ -60,11 +60,11 @@ public class BasicBoard implements java.io.Serializable
{
/**
* Creates a new instance of a routing Board with surrrounding box
* Creates a new instance of a routing Board with surrounding box
* p_bounding_box
* Rules contains the restrictions to obey when inserting items.
* Among other things it may contain a clearance matrix.
* p_observers is used for syncronisation, if the eu.mihosoft.freerouting.board is generated
* p_observers is used for synchronisation, if the board is generated
* by a host database. Otherwise it is null.
* If p_test_level != RELEASE_VERSION,, some features may be used, which are still in experimental state.
* Also warnings for debugging may be printed depending on the size of p_test_level.
@ -181,8 +181,8 @@ public class BasicBoard implements java.io.Serializable
/**
* Inserts a trace into the eu.mihosoft.freerouting.board, whose geometry is described by
* a Polyline. p_clearance_class is the index in the clearance_matix,
* Inserts a trace into the board, whose geometry is described by
* a Polyline. p_clearance_class is the index in the clearance_matrix,
* which describes the required clearance restrictions to other items.
* Because no internal cleaning of items is done, the new inserted
* item can be returned.
@ -213,8 +213,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a trace into the eu.mihosoft.freerouting.board, whose geometry is described by
* a Polyline. p_clearance_class is the index in the clearance_matix,
* Inserts a trace into the board, whose geometry is described by
* a Polyline. p_clearance_class is the index in the clearance_matrix,
* which describes the required clearance restrictions to other items.
*/
public void insert_trace(Polyline p_polyline, int p_layer,
@ -240,7 +240,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a trace into the eu.mihosoft.freerouting.board, whose geometry is described by
* Inserts a trace into the board, whose geometry is described by
* an array of points, and cleans up the net.
*/
public void insert_trace(Point[] p_points, int p_layer,
@ -258,7 +258,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a via into the eu.mihosoft.freerouting.board. p_attach_allowed indicates, if the via may overlap with smd pins
* Inserts a via into the board. p_attach_allowed indicates, if the via may overlap with smd pins
* of the same net.
*/
public Via insert_via(Padstack p_padstack, Point p_center, int[] p_net_no_arr, int p_clearance_class,
@ -280,8 +280,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a pin into the eu.mihosoft.freerouting.board.
* p_pin_no is the number of this pin in the eu.mihosoft.freerouting.library package of its component (starting with 0).
* Inserts a pin into the board.
* p_pin_no is the number of this pin in the library package of its component (starting with 0).
*/
public Pin insert_pin(int p_component_no, int p_pin_no, int[] p_net_no_arr, int p_clearance_class, FixedState p_fixed_state)
{
@ -291,8 +291,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts an obstacle into the eu.mihosoft.freerouting.board , whose geometry is described
* by a polygonyal shape, which may have holes.
* Inserts an obstacle into the board , whose geometry is described
* by a polygonal shape, which may have holes.
* If p_component_no != 0, the obstacle belongs to a component.
*/
public ObstacleArea insert_obstacle(Area p_area, int p_layer, int p_clearance_class, FixedState p_fixed_state)
@ -308,8 +308,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts an obstacle belonging to a component into the eu.mihosoft.freerouting.board
* p_name is to identify the corresponding ObstacstacleArea in the component package.
* Inserts an obstacle belonging to a component into the board
* p_name is to identify the corresponding ObstacleArea in the component package.
*/
public ObstacleArea insert_obstacle(Area p_area, int p_layer, Vector p_translation, double p_rotation_in_degree,
boolean p_side_changed, int p_clearance_class, int p_component_no, String p_name, FixedState p_fixed_state)
@ -326,8 +326,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts an via obstacle area into the eu.mihosoft.freerouting.board , whose geometry is described
* by a polygonyal shape, which may have holes.
* Inserts an via obstacle area into the board , whose geometry is described
* by a polygonal shape, which may have holes.
*/
public ViaObstacleArea insert_via_obstacle(Area p_area, int p_layer, int p_clearance_class,
FixedState p_fixed_state)
@ -344,8 +344,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts an via obstacle belonging to a component into the eu.mihosoft.freerouting.board
* p_name is to identify the corresponding ObstacstacleArea in the component package.
* Inserts an via obstacle belonging to a component into the board
* p_name is to identify the corresponding ObstacleArea in the component package.
*/
public ViaObstacleArea insert_via_obstacle(Area p_area, int p_layer, Vector p_translation, double p_rotation_in_degree,
boolean p_side_changed, int p_clearance_class, int p_component_no, String p_name,
@ -363,8 +363,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a component obstacle area into the eu.mihosoft.freerouting.board , whose geometry is described
* by a polygonyal shape, which may have holes.
* Inserts a component obstacle area into the board , whose geometry is described
* by a polygonal shape, which may have holes.
*/
public ComponentObstacleArea insert_component_obstacle(Area p_area, int p_layer,
int p_clearance_class, FixedState p_fixed_state)
@ -381,8 +381,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a component obstacle belonging to a component into the eu.mihosoft.freerouting.board.
* p_name is to identify the corresponding ObstacstacleArea in the component package.
* Inserts a component obstacle belonging to a component into the board.
* p_name is to identify the corresponding ObstacleArea in the component package.
*/
public ComponentObstacleArea insert_component_obstacle(Area p_area, int p_layer, Vector p_translation, double p_rotation_in_degree,
boolean p_side_changed, int p_clearance_class, int p_component_no, String p_name, FixedState p_fixed_state)
@ -399,7 +399,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a component ouline into the eu.mihosoft.freerouting.board.
* Inserts a component outline into the board.
*/
public ComponentOutline insert_component_outline(Area p_area, boolean p_is_front, Vector p_translation, double p_rotation_in_degree,
int p_component_no, FixedState p_fixed_state)
@ -421,8 +421,8 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts a condution area into the eu.mihosoft.freerouting.board , whose geometry is described
* by a polygonyal shape, which may have holes.
* Inserts a conduction area into the board , whose geometry is described
* by a polygonal shape, which may have holes.
* If p_is_obstacle is false, it is possible to route through the conduction area
* with traces and vias of foreign nets.
*/
@ -441,7 +441,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts an Outline into the eu.mihosoft.freerouting.board.
* Inserts an Outline into the board.
*/
public BoardOutline insert_outline(PolylineShape[] p_outline_shapes, int p_clearance_class_no)
{
@ -451,7 +451,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the outline of the eu.mihosoft.freerouting.board.
* Returns the outline of the board.
*/
public BoardOutline get_outline()
{
@ -472,7 +472,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Removes an item from the eu.mihosoft.freerouting.board
* Removes an item from the board
*/
public void remove_item(Item p_item)
{
@ -489,7 +489,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* looks, if an item with id_no p_id_no is on the eu.mihosoft.freerouting.board.
* looks, if an item with id_no p_id_no is on the board.
* Returns the found item or null, if no such item is found.
*/
public Item get_item(int p_id_no)
@ -511,7 +511,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of all items on the eu.mihosoft.freerouting.board
* Returns the list of all items on the board
*/
public Collection<Item> get_items()
{
@ -530,7 +530,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns all connectable items on the eu.mihosoft.freerouting.board containing p_net_no
* Returns all connectable items on the board containing p_net_no
*/
public Collection<Item> get_connectable_items(int p_net_no)
{
@ -666,7 +666,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of all conduction areas on the eu.mihosoft.freerouting.board
* Returns the list of all conduction areas on the board
*/
public Collection<ConductionArea> get_conduction_areas()
{
@ -688,7 +688,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of all pins on the eu.mihosoft.freerouting.board
* Returns the list of all pins on the board
*/
public Collection<Pin> get_pins()
{
@ -710,7 +710,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of all pins on the eu.mihosoft.freerouting.board with only 1 layer
* Returns the list of all pins on the board with only 1 layer
*/
public Collection<Pin> get_smd_pins()
{
@ -736,7 +736,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of all vias on the eu.mihosoft.freerouting.board
* Returns the list of all vias on the board
*/
public Collection<Via> get_vias()
{
@ -758,7 +758,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of all traces on the eu.mihosoft.freerouting.board
* Returns the list of all traces on the board
*/
public Collection<Trace> get_traces()
{
@ -780,7 +780,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the cumulative length of all traces on the eu.mihosoft.freerouting.board
* Returns the cumulative length of all traces on the board
*/
public double cumulative_trace_length()
{
@ -1133,7 +1133,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the layer count of this eu.mihosoft.freerouting.board.
* Returns the layer count of this board.
*/
public int get_layer_count()
{
@ -1141,7 +1141,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Draws all items of the eu.mihosoft.freerouting.board on their visible layers. Called in the overwritten
* Draws all items of the board on their visible layers. Called in the overwritten
* paintComponent method of a class derived from JPanel.
* The value of p_layer_visibility is expected between 0 and 1 for each layer.
*/
@ -1152,7 +1152,7 @@ public class BasicBoard implements java.io.Serializable
return;
}
// draw all items on the eu.mihosoft.freerouting.board
// draw all items on the board
for (int curr_priority = Drawable.MIN_DRAW_PRIORITY; curr_priority <= Drawable.MIDDLE_DRAW_PRIORITY; ++curr_priority)
{
Iterator<UndoableObjects.UndoableObjectNode> it = item_list.start_read_object();
@ -1180,7 +1180,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns the list of items on the eu.mihosoft.freerouting.board, whose shape on layer p_layer contains the point at p_location.
* Returns the list of items on the board, whose shape on layer p_layer contains the point at p_location.
* If p_layer {@literal <} 0, the layer is ignored.
* If p_item_selection_filter != null, only items of types selected by the filter are picked.
*/
@ -1204,7 +1204,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* checks, if p_point is contained in the bounding box of this eu.mihosoft.freerouting.board.
* checks, if p_point is contained in the bounding box of this board.
*/
public boolean contains(Point p_point)
{
@ -1226,7 +1226,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* returns the biggest half width of all traces on the eu.mihosoft.freerouting.board.
* returns the biggest half width of all traces on the board.
*/
public int get_max_trace_half_width()
{
@ -1234,7 +1234,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* returns the smallest half width of all traces on the eu.mihosoft.freerouting.board.
* returns the smallest half width of all traces on the board.
*/
public int get_min_trace_half_width()
{
@ -1242,7 +1242,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns a surrounding box of the geometry of this eu.mihosoft.freerouting.board
* Returns a surrounding box of the geometry of this board
*/
public IntBox get_bounding_box()
{
@ -1313,7 +1313,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Returns, if the observer of the eu.mihosoft.freerouting.board items is activated.
* Returns, if the observer of the board items is activated.
*/
public boolean observers_active()
{
@ -1353,7 +1353,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Inserts an item into the eu.mihosoft.freerouting.board data base
* Inserts an item into the board data base
*/
public void insert_item(Item p_item)
{
@ -1478,7 +1478,7 @@ public class BasicBoard implements java.io.Serializable
}
/**
* Makes the current eu.mihosoft.freerouting.board situation restorable by undo.
* Makes the current board situation restorable by undo.
*/
public void generate_snapshot()
{
@ -1606,7 +1606,7 @@ public class BasicBoard implements java.io.Serializable
throws java.io.IOException, java.lang.ClassNotFoundException
{
p_stream.defaultReadObject();
// insert the items on the eu.mihosoft.freerouting.board into the search trees
// insert the items on the board into the search trees
search_tree_manager = new SearchTreeManager(this);
Iterator<Item> it = this.get_items().iterator();
while (it.hasNext())
@ -1617,27 +1617,27 @@ public class BasicBoard implements java.io.Serializable
}
}
/**
* List of items inserted into this eu.mihosoft.freerouting.board
* List of items inserted into this board
*/
public final UndoableObjects item_list;
/** List of placed components on the eu.mihosoft.freerouting.board. */
/** List of placed components on the board. */
public final Components components;
/**
* Class defining the eu.mihosoft.freerouting.rules for items to be inserted into this eu.mihosoft.freerouting.board.
* Class defining the rules for items to be inserted into this board.
* Contains for example the clearance matrix.
*/
public final BoardRules rules;
/**
* The eu.mihosoft.freerouting.library containing pastack masks, packagages and other
* templates used on the eu.mihosoft.freerouting.board.
* The library containing padstack masks, packages and other
* templates used on the board.
*/
public final BoardLibrary library;
/**
* The layer structure of this eu.mihosoft.freerouting.board.
* The layer structure of this board.
*/
public final LayerStructure layer_structure;
/**
* Handels the search trees pointing into the items of this eu.mihosoft.freerouting.board
* Handels the search trees pointing into the items of this board
*/
public transient SearchTreeManager search_tree_manager;
/**
@ -1645,7 +1645,7 @@ public class BasicBoard implements java.io.Serializable
*/
public final Communication communication;
/**
* bounding orthogonal rectangle of this eu.mihosoft.freerouting.board
* bounding orthogonal rectangle of this board
*/
public final IntBox bounding_box;
/**
@ -1656,11 +1656,11 @@ public class BasicBoard implements java.io.Serializable
/** the rectangle, where the graphics may be not uptodate */
transient private IntBox update_box = IntBox.EMPTY;
/**
* the biggest half width of all traces on the eu.mihosoft.freerouting.board
* the biggest half width of all traces on the board
*/
private int max_trace_half_width = 1000;
/**
* the smallest half width of all traces on the eu.mihosoft.freerouting.board
* the smallest half width of all traces on the board
*/
private int min_trace_half_width = 10000;
/**

10
src/main/java/eu/mihosoft/freerouting/board/BoardOutline.java
View File

@ -35,7 +35,7 @@ import eu.mihosoft.freerouting.boardgraphics.GraphicsContext;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Class describing a eu.mihosoft.freerouting.board outline.
* Class describing a board outline.
*
* @author alfons
*/
@ -221,7 +221,7 @@ public class BoardOutline extends Item implements java.io.Serializable
}
/**
* The eu.mihosoft.freerouting.board shape outside the outline curves, where a keepout will be generated
* The board shape outside the outline curves, where a keepout will be generated
* The outline curves are holes of the keepout_area.
*/
Area get_keepout_area()
@ -290,7 +290,7 @@ public class BoardOutline extends Item implements java.io.Serializable
}
/**
* Returns, if keepout is generated outside the eu.mihosoft.freerouting.board outline.
* Returns, if keepout is generated outside the board outline.
* Otherwise only the line shapes of the outlines are inserted as keepout.
*/
public boolean keepout_outside_outline_generated()
@ -343,10 +343,10 @@ public class BoardOutline extends Item implements java.io.Serializable
{
return p_search_tree.calculate_tree_shapes(this);
}
/** The eu.mihosoft.freerouting.board shapes inside the outline curves. */
/** The board shapes inside the outline curves. */
private PolylineShape[] shapes;
/**
* The eu.mihosoft.freerouting.board shape outside the outline curves, where a keepout will be generated
* The board shape outside the outline curves, where a keepout will be generated
* The outline curves are holes of the keepout_area.
*/
private Area keepout_area = null;

4
src/main/java/eu/mihosoft/freerouting/board/ChangedArea.java
View File

@ -24,7 +24,7 @@ import eu.mihosoft.freerouting.geometry.planar.IntOctagon;
/**
*
* Used internally for marking changed areas on the eu.mihosoft.freerouting.board
* Used internally for marking changed areas on the board
* after shoving and optimizing items.
*
@ -124,7 +124,7 @@ class ChangedArea
MutableOctagon [] arr;
/**
* mutable octagon with double coordinates (see eu.mihosoft.freerouting.geometry.planar.IntOctagon)
* mutable octagon with double coordinates (see geometry.planar.IntOctagon)
*/
private static class MutableOctagon
{

18
src/main/java/eu/mihosoft/freerouting/board/Component.java
View File

@ -34,7 +34,7 @@ import eu.mihosoft.freerouting.library.Package;
/**
* Describes eu.mihosoft.freerouting.board components consisting of an array of pins
* Describes board components consisting of an array of pins
* und other stuff like component keepouts.
*
* @author Alfons Wirtz
@ -88,7 +88,7 @@ public class Component implements UndoableObjects.Storable, ObjectInfoPanel.Prin
}
/**
* If false, the component will be placed on the back side of the eu.mihosoft.freerouting.board.
* If false, the component will be placed on the back side of the board.
*/
public boolean placed_on_front()
{
@ -97,7 +97,7 @@ public class Component implements UndoableObjects.Storable, ObjectInfoPanel.Prin
/**
* Translates the location of this Component by p_p_vector.
* The Pins in the eu.mihosoft.freerouting.board must be moved seperately.
* The Pins in the board must be moved separately.
*/
public void translate_by(Vector p_vector)
{
@ -142,7 +142,7 @@ public class Component implements UndoableObjects.Storable, ObjectInfoPanel.Prin
double turn_angle = p_angle_in_degree;
if (p_flip_style_rotate_first && !this.placed_on_front())
{
// take care of the order of mirroring and rotating on the back side of the eu.mihosoft.freerouting.board
// take care of the order of mirroring and rotating on the back side of the board
turn_angle = 360 - p_angle_in_degree;
}
this.rotation_in_degree = this.rotation_in_degree + turn_angle;
@ -254,7 +254,7 @@ public class Component implements UndoableObjects.Storable, ObjectInfoPanel.Prin
}
/**
* Returns the eu.mihosoft.freerouting.library package of this component.
* Returns the library package of this component.
*/
public Package get_package()
{
@ -276,19 +276,19 @@ public class Component implements UndoableObjects.Storable, ObjectInfoPanel.Prin
/** The location of the component. */
private Point location;
/** The rotation of the eu.mihosoft.freerouting.library package of the component in degree */
/** The rotation of the library package of the component in degree */
private double rotation_in_degree;
/** Contains information for gate swapping and pin swapping, if != null */
private eu.mihosoft.freerouting.library.LogicalPart logical_part = null;
/** If false, the component will be placed on the back side of the eu.mihosoft.freerouting.board. */
/** If false, the component will be placed on the back side of the board. */
private boolean on_front;
/** The eu.mihosoft.freerouting.library package of the component if it is placed on the component side. */
/** The library package of the component if it is placed on the component side. */
private final Package lib_package_front;
/** The eu.mihosoft.freerouting.library package of the component if it is placed on the solder side. */
/** The library package of the component if it is placed on the solder side. */
private final Package lib_package_back;
/** Internal generated unique identification number. */

2
src/main/java/eu/mihosoft/freerouting/board/ComponentObstacleArea.java
View File

@ -28,7 +28,7 @@ import eu.mihosoft.freerouting.geometry.planar.Area;
import eu.mihosoft.freerouting.geometry.planar.Vector;
/**
* Describes areas of the eu.mihosoft.freerouting.board, where components arre not allowed.
* Describes areas of the board, where components are not allowed.
*
* @author alfons
*/

18
src/main/java/eu/mihosoft/freerouting/board/Components.java
View File

@ -37,7 +37,7 @@ import eu.mihosoft.freerouting.library.Package;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Contains the lists of components on the eu.mihosoft.freerouting.board.
* Contains the lists of components on the board.
*
* @author Alfons Wirtz
*/
@ -45,7 +45,7 @@ public class Components implements java.io.Serializable
{
/**
* Inserts a component into the list.
* The items of the component have to be inserted seperately into the eu.mihosoft.freerouting.board.
* The items of the component have to be inserted separately into the board.
* If p_on_front is false, the component will be placed on the back side,
* and p_package_back is used instead of p_package_front.
*/
@ -63,7 +63,7 @@ public class Components implements java.io.Serializable
/**
* Adds a component to this object.
* The items of the component have to be inserted seperately into the eu.mihosoft.freerouting.board.
* The items of the component have to be inserted separately into the board.
* If p_on_front is false, the component will be placed on the back side.
* The component name is generated internally.
*/
@ -107,7 +107,7 @@ public class Components implements java.io.Serializable
}
/**
* Returns the number of components on the eu.mihosoft.freerouting.board.
* Returns the number of components on the board.
*/
public int count()
{
@ -170,7 +170,7 @@ public class Components implements java.io.Serializable
/**
* Moves the component with number p_component_no.
* Works contrary to Component.translate_by with the undo algorithm of the eu.mihosoft.freerouting.board.
* Works contrary to Component.translate_by with the undo algorithm of the board.
*/
public void move(int p_component_no, eu.mihosoft.freerouting.geometry.planar.Vector p_vector )
{
@ -181,7 +181,7 @@ public class Components implements java.io.Serializable
/**
* Turns the component with number p_component_no by p_factor times 90 degree around p_pole.
* Works contrary to Component.turn_90_degree with the undo algorithm of the eu.mihosoft.freerouting.board.
* Works contrary to Component.turn_90_degree with the undo algorithm of the board.
*/
public void turn_90_degree(int p_component_no, int p_factor, IntPoint p_pole)
{
@ -192,7 +192,7 @@ public class Components implements java.io.Serializable
/**
* Rotates the component with number p_component_no by p_rotation_in_degree around p_pole.
* Works contrary to Component.rotate with the undo algorithm of the eu.mihosoft.freerouting.board.
* Works contrary to Component.rotate with the undo algorithm of the board.
*/
public void rotate (int p_component_no, double p_rotation_in_degree, IntPoint p_pole)
{
@ -202,9 +202,9 @@ public class Components implements java.io.Serializable
}
/**
* Changes the placement side of the component the component with numberp_component_no and
* Changes the placement side of the component the component with number p_component_no and
* mirrors it at the vertical line through p_pole.
* Works contrary to Component.change_side the undo algorithm of the eu.mihosoft.freerouting.board.
* Works contrary to Component.change_side the undo algorithm of the board.
*/
public void change_side(int p_component_no, IntPoint p_pole)
{

18
src/main/java/eu/mihosoft/freerouting/board/CoordinateTransform.java
View File

@ -27,7 +27,7 @@ import eu.mihosoft.freerouting.geometry.planar.FloatPoint;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Class for transforming objects between user coordinate space and eu.mihosoft.freerouting.board coordinate space.
* Class for transforming objects between user coordinate space and board coordinate space.
*
* @author Alfons Wirtz
*/
@ -46,7 +46,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Scale a value from the eu.mihosoft.freerouting.board to the user coordinate system.
* Scale a value from the board to the user coordinate system.
*/
public double board_to_user(double p_value)
{
@ -54,7 +54,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Scale a value from the user to the eu.mihosoft.freerouting.board coordinate system.
* Scale a value from the user to the board coordinate system.
*/
public double user_to_board(double p_value)
{
@ -63,7 +63,7 @@ public class CoordinateTransform implements java.io.Serializable
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.FloatPoint from the eu.mihosoft.freerouting.board coordinate space
* Transforms a geometry.planar.FloatPoint from the board coordinate space
* to the user coordinate space.
*/
public FloatPoint board_to_user(FloatPoint p_point)
@ -72,8 +72,8 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.FloatPoint from the user coordinate space.
* to the eu.mihosoft.freerouting.board coordinate space.
* Transforms a geometry.planar.FloatPoint from the user coordinate space.
* to the board coordinate space.
*/
public FloatPoint user_to_board(FloatPoint p_point)
{
@ -133,13 +133,13 @@ public class CoordinateTransform implements java.io.Serializable
/** The factor of the user unit */
public final double user_unit_factor;
/** The unit used for eu.mihosoft.freerouting.board coordinates */
/** The unit used for board coordinates */
public final Unit board_unit;
/** The factor of the eu.mihosoft.freerouting.board unit */
/** The factor of the board unit */
public final double board_unit_factor;
/** The factor used for transforming coordinates between user coordinate space and eu.mihosoft.freerouting.board coordinate space */
/** The factor used for transforming coordinates between user coordinate space and board coordinate space */
private final double scale_factor;
}

2
src/main/java/eu/mihosoft/freerouting/board/DrillItem.java
View File

@ -391,7 +391,7 @@ public abstract class DrillItem extends Item implements Connectable, java.io.Ser
return TileShape.get_instance(this.get_center());
}
/** False, if this drillitem is places on the back side of the eu.mihosoft.freerouting.board */
/** False, if this drillitem is places on the back side of the board */
public boolean is_placed_on_front()
{
return true;

2
src/main/java/eu/mihosoft/freerouting/board/FixedState.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.board;
/**
* Sorted fixed states of eu.mihosoft.freerouting.board items. The strongest fixed states came last.
* Sorted fixed states of board items. The strongest fixed states came last.
*
* @author alfons
*/

26
src/main/java/eu/mihosoft/freerouting/board/Item.java
View File

@ -45,7 +45,7 @@ import eu.mihosoft.freerouting.datastructures.ShapeTree;
import eu.mihosoft.freerouting.datastructures.ShapeTree.TreeEntry;
/**
* Basic class of the items on a eu.mihosoft.freerouting.board.
* Basic class of the items on a board.
*
* @author Alfons Wirtz
*/
@ -199,7 +199,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
/**
* Returns false, if this item is deleted oor not inserted into
* the eu.mihosoft.freerouting.board.
* the board.
*/
public boolean is_on_the_board()
{
@ -244,25 +244,25 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
/**
* Translates the shapes of this item by p_vector.
* Does not move the item in the eu.mihosoft.freerouting.board.
* Does not move the item in the board.
*/
public abstract void translate_by(Vector p_vector);
/**
* Turns this Item by p_factor times 90 degree around p_pole.
* Does not update the item in the eu.mihosoft.freerouting.board.
* Does not update the item in the board.
*/
public abstract void turn_90_degree(int p_factor, IntPoint p_pole);
/**
* Rotates this Item by p_angle_in_degree around p_pole.
* Does not update the item in the eu.mihosoft.freerouting.board.
* Does not update the item in the board.
*/
public abstract void rotate_approx(double p_angle_in_degree, FloatPoint p_pole);
/**
* Changes the placement side of this Item and mirrors it at the vertical line through p_pole.
* Does not update the item in the eu.mihosoft.freerouting.board.
* Does not update the item in the board.
*/
public abstract void change_placement_side(IntPoint p_pole);
@ -272,7 +272,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
public abstract IntBox bounding_box();
/**
* Translates this item by p_vector in the eu.mihosoft.freerouting.board.
* Translates this item by p_vector in the board.
*/
public void move_by(Vector p_vector)
{
@ -1213,7 +1213,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
}
/**
* Gets the information for the eu.mihosoft.freerouting.autoroute algorithm.
* Gets the information for the autoroute algorithm.
* Creates it, if it does not yet exist.
*/
public eu.mihosoft.freerouting.autoroute.ItemAutorouteInfo get_autoroute_info()
@ -1226,7 +1226,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
}
/**
* Gets the information for the eu.mihosoft.freerouting.autoroute algorithm.
* Gets the information for the autoroute algorithm.
*/
public eu.mihosoft.freerouting.autoroute.ItemAutorouteInfo get_autoroute_info_pur()
{
@ -1234,7 +1234,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
}
/**
* Clears the data allocated for the eu.mihosoft.freerouting.autoroute algorithm.
* Clears the data allocated for the autoroute algorithm.
*/
public void clear_autoroute_info()
{
@ -1454,7 +1454,7 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
* to other items
*/
private int clearance_class;
/** The eu.mihosoft.freerouting.board this Item is on */
/** The board this Item is on */
transient public BasicBoard board;
/** The nets, to which this item belongs */
int[] net_no_arr;
@ -1465,10 +1465,10 @@ public abstract class Item implements Drawable, SearchTreeObject, ObjectInfoPane
private int component_no = 0;
private final int id_no;
/**
* Folse, if the item is deleted or not inserted into the eu.mihosoft.freerouting.board
* False, if the item is deleted or not inserted into the board
*/
private boolean on_the_board = false;
/** Temporary data used in the eu.mihosoft.freerouting.autoroute algorithm. */
/** Temporary data used in the autoroute algorithm. */
transient private eu.mihosoft.freerouting.autoroute.ItemAutorouteInfo autoroute_info = null;
private static double PROTECT_FANOUT_LENGTH = 400;

2
src/main/java/eu/mihosoft/freerouting/board/ItemSearchTreesInfo.java
View File

@ -32,7 +32,7 @@ import eu.mihosoft.freerouting.datastructures.ShapeTree;
import eu.mihosoft.freerouting.geometry.planar.TileShape;
/**
* Stores information about the search trees of the eu.mihosoft.freerouting.board items,
* Stores information about the search trees of the board items,
* which is precalculated for performance reasons.
*
* @author Alfons Wirtz

2
src/main/java/eu/mihosoft/freerouting/board/ItemSelectionFilter.java
View File

@ -27,7 +27,7 @@ import java.util.Set;
import java.util.TreeSet;
/**
* Filter for selecting items on the eu.mihosoft.freerouting.board.
* Filter for selecting items on the board.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/board/Layer.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.board;
/**
* Describes the structure of a eu.mihosoft.freerouting.board layer.
* Describes the structure of a board layer.
*
* @author alfons
*/

2
src/main/java/eu/mihosoft/freerouting/board/LayerStructure.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.board;
/**
* Describes the layer structure of the eu.mihosoft.freerouting.board.
* Describes the layer structure of the board.
*
* @author alfons
*/

2
src/main/java/eu/mihosoft/freerouting/board/MoveComponent.java
View File

@ -36,7 +36,7 @@ import java.util.LinkedList;
import eu.mihosoft.freerouting.datastructures.Signum;
/**
* Class for moving a group of items on the eu.mihosoft.freerouting.board
* Class for moving a group of items on the board
* @author Alfons Wirtz
*/
public class MoveComponent

2
src/main/java/eu/mihosoft/freerouting/board/ObjectInfoPanel.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.board;
/**
* Output window for printing information about eu.mihosoft.freerouting.board objects.
* Output window for printing information about board objects.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/board/ObstacleArea.java
View File

@ -34,7 +34,7 @@ import eu.mihosoft.freerouting.logger.FRLogger;
/**
*
* An item on the eu.mihosoft.freerouting.board with an relative_area shape, for example keepout, conduction relative_area
* An item on the board with an relative_area shape, for example keepout, conduction relative_area
*
*
*

6
src/main/java/eu/mihosoft/freerouting/board/Pin.java
View File

@ -40,7 +40,7 @@ import eu.mihosoft.freerouting.library.Padstack;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Class describing the functionality of an electrical Item on the eu.mihosoft.freerouting.board
* Class describing the functionality of an electrical Item on the board
* with a shape on 1 or several layers.
*
* @author Alfons Wirtz
@ -171,7 +171,7 @@ public class Pin extends DrillItem implements java.io.Serializable
}
/**
* Gets index of this pin in the eu.mihosoft.freerouting.library package of the pins component.
* Gets index of this pin in the library package of the pins component.
*/
public int get_index_in_package()
{
@ -585,7 +585,7 @@ public class Pin extends DrillItem implements java.io.Serializable
}
/** False, if this drillitem is places on the back side of the eu.mihosoft.freerouting.board */
/** False, if this drillitem is places on the back side of the board */
public boolean is_placed_on_front()
{
boolean result = true;

2
src/main/java/eu/mihosoft/freerouting/board/PolylineTrace.java
View File

@ -581,7 +581,7 @@ public class PolylineTrace extends Trace implements java.io.Serializable
if (found_trace_split)
{
// reread the overlapping tree entries and reset the iterator,
// because the eu.mihosoft.freerouting.board has changed
// because the board has changed
default_tree.overlapping_tree_entries(curr_shape, get_layer(), overlapping_tree_entries);
it = overlapping_tree_entries.iterator();
break;

2
src/main/java/eu/mihosoft/freerouting/board/PrintableShape.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.board;
import eu.mihosoft.freerouting.geometry.planar.FloatPoint;
/**
* Shape class used for printing a eu.mihosoft.freerouting.geometry.planar.Shape after transforming it to user coordinates.
* Shape class used for printing a geometry.planar.Shape after transforming it to user coordinates.
*
* @author Alfons Wirtz
*/

22
src/main/java/eu/mihosoft/freerouting/board/RoutingBoard.java
View File

@ -51,7 +51,7 @@ import eu.mihosoft.freerouting.autoroute.CompleteFreeSpaceExpansionRoom;
/**
*
* Contains higher level functions of a eu.mihosoft.freerouting.board
* Contains higher level functions of a board
*
* @author Alfons Wirtz
*/
@ -187,7 +187,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
}
/**
* marks the whole eu.mihosoft.freerouting.board as changed
* marks the whole board as changed
*/
public void mark_all_changed_area()
{
@ -906,8 +906,8 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
}
/**
* Initialises the eu.mihosoft.freerouting.autoroute database for routing a connection.
* If p_retain_autoroute_database, the eu.mihosoft.freerouting.autoroute database is retained and maintained after
* Initialises the autoroute database for routing a connection.
* If p_retain_autoroute_database, the autoroute database is retained and maintained after
* the algorithm for performance reasons.
*/
public AutorouteEngine init_autoroute(int p_net_no, int p_trace_clearance_class_no,
@ -922,7 +922,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
}
/**
* Clears the eu.mihosoft.freerouting.autoroute database in case it was retained.
* Clears the autoroute database in case it was retained.
*/
public void finish_autoroute()
{
@ -1204,7 +1204,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
}
/**
* Sets, if all conduction areas on the eu.mihosoft.freerouting.board are obstacles for route of foreign nets.
* Sets, if all conduction areas on the board are obstacles for route of foreign nets.
*/
public void change_conduction_is_obstacle(boolean p_value)
{
@ -1213,7 +1213,7 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
return; // no muultiply
}
boolean something_changed = false;
// Change the is_obstacle property of all conduction areas of the eu.mihosoft.freerouting.board.
// Change the is_obstacle property of all conduction areas of the board.
Iterator<UndoableObjects.UndoableObjectNode> it = item_list.start_read_object();
for (;;)
{
@ -1371,8 +1371,8 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
}
/**
* Sets, if the eu.mihosoft.freerouting.autoroute database has to be maintained outside the outoroute algorithm
* while changing items on rhe eu.mihosoft.freerouting.board.
* Sets, if the autoroute database has to be maintained outside the outoroute algorithm
* while changing items on rhe board.
*/
void set_maintaining_autoroute_database(boolean p_value)
{
@ -1387,8 +1387,8 @@ public class RoutingBoard extends BasicBoard implements java.io.Serializable
}
/**
* Returns, if the eu.mihosoft.freerouting.autoroute database is maintained outside the outoroute algorithm
* while changing items on rhe eu.mihosoft.freerouting.board.
* Returns, if the autoroute database is maintained outside the outoroute algorithm
* while changing items on rhe board.
*/
boolean is_maintaining_autoroute_database()
{

4
src/main/java/eu/mihosoft/freerouting/board/SearchTreeManager.java
View File

@ -89,7 +89,7 @@ public class SearchTreeManager
}
/**
* Returns the default tree used in eu.mihosoft.freerouting.interactive routing.
* Returns the default tree used in interactive routing.
*/
public ShapeSearchTree get_default_tree()
{
@ -233,7 +233,7 @@ public class SearchTreeManager
}
/**
* Clears all compensated trees used in the eu.mihosoft.freerouting.autoroute algorithm apart from the default tree.
* Clears all compensated trees used in the autoroute algorithm apart from the default tree.
*/
public void reset_compensated_trees()
{

2
src/main/java/eu/mihosoft/freerouting/board/SearchTreeObject.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.board;
/**
* Common ShapeSearchTree functionality for eu.mihosoft.freerouting.board.Items and eu.mihosoft.freerouting.autoroute.ExpansionRooms
* Common ShapeSearchTree functionality for board.Items and autoroute.ExpansionRooms
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/board/ShapeSearchTree.java
View File

@ -54,7 +54,7 @@ import eu.mihosoft.freerouting.autoroute.CompleteFreeSpaceExpansionRoom;
/**
*
* Elementary geometric search functions making direct use
* of the MinAreaTree in the package eu.mihosoft.freerouting.datastructures.
* of the MinAreaTree in the package datastructures.
*
*
* @author Alfons Wirtz

2
src/main/java/eu/mihosoft/freerouting/board/Trace.java
View File

@ -549,5 +549,5 @@ public abstract class Trace extends Item implements Connectable, java.io.Seriali
private final int half_width ; // half width of the trace pen
private int layer ; // eu.mihosoft.freerouting.board layer of the trace
private int layer ; // board layer of the trace
}

4
src/main/java/eu/mihosoft/freerouting/board/Via.java
View File

@ -34,7 +34,7 @@ import eu.mihosoft.freerouting.library.Padstack;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Class describing the functionality of an electrical Item on the eu.mihosoft.freerouting.board,
* Class describing the functionality of an electrical Item on the board,
* which may have a shape on several layer, whose geometry is described by a
* padstack.
*
@ -277,6 +277,6 @@ public class Via extends DrillItem implements java.io.Serializable
/** True, if coppersharing of this via with smd pins of the same net is allowed. */
public final boolean attach_allowed;
transient private Shape[] precalculated_shapes = null;
/** Temporary data used in the eu.mihosoft.freerouting.autoroute algorithm. */
/** Temporary data used in the autoroute algorithm. */
transient private eu.mihosoft.freerouting.autoroute.ExpansionDrill autoroute_drill_info = null;
}

2
src/main/java/eu/mihosoft/freerouting/board/ViaObstacleArea.java
View File

@ -27,7 +27,7 @@ import eu.mihosoft.freerouting.geometry.planar.Area;
import eu.mihosoft.freerouting.geometry.planar.Vector;
/**
* Describes Areas on the eu.mihosoft.freerouting.board, where vias are not allowed.
* Describes Areas on the board, where vias are not allowed.
*
* @author alfons
*/

2
src/main/java/eu/mihosoft/freerouting/boardgraphics/ColorTableModel.java
View File

@ -25,7 +25,7 @@ package eu.mihosoft.freerouting.boardgraphics;
import javax.swing.table.AbstractTableModel;
/**
* Abstract class to store colors used for drawing the eu.mihosoft.freerouting.board.
* Abstract class to store colors used for drawing the board.
*
* @author Alfons Wirtz
*/

32
src/main/java/eu/mihosoft/freerouting/boardgraphics/CoordinateTransform.java
View File

@ -27,7 +27,7 @@ import java.awt.Dimension;
import java.awt.geom.Point2D;
/**
* Transformation function between the eu.mihosoft.freerouting.board and the screen coordinate systems.
* Transformation function between the board and the screen coordinate systems.
*
* @author Alfons Wirtz
*/
@ -79,7 +79,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* scale a value from the eu.mihosoft.freerouting.board to the screen coordinate system
* scale a value from the board to the screen coordinate system
*/
public double board_to_screen(double p_val)
{
@ -87,7 +87,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* scale a value the screen to the eu.mihosoft.freerouting.board coordinate system
* scale a value the screen to the board coordinate system
*/
public double screen_to_board(double p_val)
{
@ -96,7 +96,7 @@ public class CoordinateTransform implements java.io.Serializable
/**
* transform a eu.mihosoft.freerouting.geometry.planar.FloatPoint to a java.awt.geom.Point2D
* transform a geometry.planar.FloatPoint to a java.awt.geom.Point2D
*/
public Point2D board_to_screen(FloatPoint p_point)
{
@ -123,7 +123,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transform a java.awt.geom.Point2D to a eu.mihosoft.freerouting.geometry.planar.FloatPoint
* Transform a java.awt.geom.Point2D to a geometry.planar.FloatPoint
*/
public FloatPoint screen_to_board(Point2D p_point)
{
@ -149,7 +149,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms an angle in radian on the eu.mihosoft.freerouting.board to an angle on the screen.
* Transforms an angle in radian on the board to an angle on the screen.
*/
public double board_to_screen_angle(double p_angle)
{
@ -174,7 +174,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transform a eu.mihosoft.freerouting.geometry.planar.IntBox to a java.awt.Rectangle
* Transform a geometry.planar.IntBox to a java.awt.Rectangle
* If the internal rotation is not a multiple of Pi/2, a bounding rectangle of the
* rotated rectangular shape is returned.
*/
@ -193,7 +193,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transform a java.awt.Rectangle to a eu.mihosoft.freerouting.geometry.planar.IntBox
* Transform a java.awt.Rectangle to a geometry.planar.IntBox
* If the internal rotation is not a multiple of Pi/2, a bounding box of the
* rotated rectangular shape is returned.
*/
@ -210,7 +210,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* If p_value is true, the left side and the right side of the eu.mihosoft.freerouting.board will be swapped.
* If p_value is true, the left side and the right side of the board will be swapped.
*/
public void set_mirror_left_right(boolean p_value)
{
@ -218,7 +218,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Returns, if the left side and the right side of the eu.mihosoft.freerouting.board are swapped.
* Returns, if the left side and the right side of the board are swapped.
*/
public boolean is_mirror_left_right()
{
@ -226,7 +226,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* If p_value is true, the top side and the botton side of the eu.mihosoft.freerouting.board will be swapped.
* If p_value is true, the top side and the botton side of the board will be swapped.
*/
public void set_mirror_top_bottom(boolean p_value)
{
@ -236,7 +236,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Returns, if the top side and the botton side of the eu.mihosoft.freerouting.board are swapped.
* Returns, if the top side and the botton side of the board are swapped.
*/
public boolean is_mirror_top_bottom()
{
@ -246,7 +246,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Sets the rotation of the displayed eu.mihosoft.freerouting.board to p_value.
* Sets the rotation of the displayed board to p_value.
*/
public void set_rotation(double p_value)
{
@ -254,7 +254,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Returns the rotation of the displayed eu.mihosoft.freerouting.board.
* Returns the rotation of the displayed board.
*/
public double get_rotation()
{
@ -287,12 +287,12 @@ public class CoordinateTransform implements java.io.Serializable
private final double display_y_offset;
/**
* Left side and right side of the eu.mihosoft.freerouting.board are swapped.
* Left side and right side of the board are swapped.
*/
private boolean mirror_left_right = false;
/**
* Top side and bottom side of the eu.mihosoft.freerouting.board are swapped.
* Top side and bottom side of the board are swapped.
*/
private boolean mirror_top_bottom = true;

8
src/main/java/eu/mihosoft/freerouting/boardgraphics/GraphicsContext.java
View File

@ -47,7 +47,7 @@ import java.awt.geom.AffineTransform;
/**
* Context for drawing items in the eu.mihosoft.freerouting.board package to the screen.
* Context for drawing items in the board package to the screen.
*
* @author Alfons Wirtz
*/
@ -89,7 +89,7 @@ public class GraphicsContext implements java.io.Serializable
}
/**
* Changes the bounds of the eu.mihosoft.freerouting.board design to p_design_bounds.
* Changes the bounds of the board design to p_design_bounds.
* Useful when components are still placed outside the boaed.
*/
public void change_design_bounds(IntBox p_new_design_bounds)
@ -413,7 +413,7 @@ public class GraphicsContext implements java.io.Serializable
}
/**
* draws the interiour of an item of class eu.mihosoft.freerouting.geometry.planar.Area
* draws the interior of an item of class geometry.planar.Area
*/
public void fill_area(Area p_area, Graphics p_g, Color p_color, double p_translucency_factor)
{
@ -748,7 +748,7 @@ public class GraphicsContext implements java.io.Serializable
return result;
}
/** Returns the number of layers on the eu.mihosoft.freerouting.board */
/** Returns the number of layers on the board */
public int layer_count()
{
return layer_visibility_arr.length;

2
src/main/java/eu/mihosoft/freerouting/boardgraphics/ItemColorTableModel.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.boardgraphics;
import java.awt.Color;
/**
* Stores the layer dependent colors used for drawing for the items on the eu.mihosoft.freerouting.board.
* Stores the layer dependent colors used for drawing for the items on the board.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/datastructures/UndoableObjects.java
View File

@ -251,7 +251,7 @@ public class UndoableObjects implements java.io.Serializable
}
if (p_restored_objects == null || !p_restored_objects.remove(curr_deleted_node.object))
{
// the object needs only be cancelled if it is already in the eu.mihosoft.freerouting.board
// the object needs only be cancelled if it is already in the board
if (p_cancelled_objects != null)
{
p_cancelled_objects.add(curr_deleted_node.object);

2
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Component.java
View File

@ -27,7 +27,7 @@ package eu.mihosoft.freerouting.designforms.specctra;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Handels the placement bata of a eu.mihosoft.freerouting.library component.
* Handels the placement data of a library component.
*
* @author alfons
*/

6
src/main/java/eu/mihosoft/freerouting/designforms/specctra/ComponentPlacement.java
View File

@ -28,7 +28,7 @@ import java.util.LinkedList;
import java.util.Map;
/**
* Describes the placement data of a eu.mihosoft.freerouting.library component
* Describes the placement data of a library component
*
* @author alfons
*/
@ -42,10 +42,10 @@ public class ComponentPlacement
locations = new LinkedList<ComponentLocation>();
}
/** The name of the corresponding eu.mihosoft.freerouting.library component */
/** The name of the corresponding library component */
public final String lib_name;
/** The list of ComponentLocations of the eu.mihosoft.freerouting.library component on the eu.mihosoft.freerouting.board. */
/** The list of ComponentLocations of the library component on the board. */
public final Collection<ComponentLocation> locations;
/** The structure of an entry in the list locations. */

32
src/main/java/eu/mihosoft/freerouting/designforms/specctra/CoordinateTransform.java
View File

@ -31,7 +31,7 @@ import eu.mihosoft.freerouting.geometry.planar.PolylineShape;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Computes transformations between a specctra dsn-file coordinates and eu.mihosoft.freerouting.board coordinates.
* Computes transformations between a specctra dsn-file coordinates and board coordinates.
*
* @author Alfons Wirtz
*/
@ -40,7 +40,7 @@ public class CoordinateTransform implements java.io.Serializable
/**
* Creates a new instance of CoordinateTransform.
* The base point of the dsn coordinate system will be translated to zero in the eu.mihosoft.freerouting.board
* The base point of the dsn coordinate system will be translated to zero in the board
* coordinate system.
*/
public CoordinateTransform(double p_scale_factor, double p_base_x, double p_base_y)
@ -51,7 +51,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Scale a value from the eu.mihosoft.freerouting.board to the dsn coordinate system
* Scale a value from the board to the dsn coordinate system
*/
public double board_to_dsn(double p_val)
{
@ -59,7 +59,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Scale a value from the dsn to the eu.mihosoft.freerouting.board coordinate system
* Scale a value from the dsn to the board coordinate system
*/
public double dsn_to_board(double p_val)
{
@ -67,7 +67,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.FloatPoint to a tuple of doubles
* Transforms a geometry.planar.FloatPoint to a tuple of doubles
* in the dsn coordinate system.
*/
public double[] board_to_dsn(FloatPoint p_point)
@ -79,7 +79,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.FloatPoint to a tuple of doubles
* Transforms a geometry.planar.FloatPoint to a tuple of doubles
* in the dsn coordinate system in relative (vector) coordinates.
*/
public double[] board_to_dsn_rel(FloatPoint p_point)
@ -91,7 +91,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms an array of n eu.mihosoft.freerouting.geometry.planar.FloatPoints to
* Transforms an array of n geometry.planar.FloatPoints to
* an array of 2*n doubles in the dsn coordinate system.
*/
public double [] board_to_dsn(FloatPoint [] p_points)
@ -106,7 +106,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms an array of n eu.mihosoft.freerouting.geometry.planar.Lines to
* Transforms an array of n geometry.planar.Lines to
* an array of 4*n doubles in the dsn coordinate system.
*/
public double [] board_to_dsn(Line [] p_lines)
@ -125,7 +125,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms an array of n eu.mihosoft.freerouting.geometry.planar.FloatPoints to
* Transforms an array of n geometry.planar.FloatPoints to
* an array of 2*n doubles in the dsn coordinate system in relative (vector) coordinates.
*/
public double [] board_to_dsn_rel(FloatPoint [] p_points)
@ -140,7 +140,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.Vector to a tuple of doubles
* Transforms a geometry.planar.Vector to a tuple of doubles
* in the dsn coordinate system.
*/
public double[] board_to_dsn(Vector p_vector)
@ -153,7 +153,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a dsn tuple to a eu.mihosoft.freerouting.geometry.planar.FloatPoint
* Transforms a dsn tuple to a geometry.planar.FloatPoint
*/
public FloatPoint dsn_to_board(double [] p_tuple)
{
@ -163,7 +163,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a dsn tuple to a eu.mihosoft.freerouting.geometry.planar.FloatPoint in relative (vector) coordinates.
* Transforms a dsn tuple to a geometry.planar.FloatPoint in relative (vector) coordinates.
*/
public FloatPoint dsn_to_board_rel(double [] p_tuple)
{
@ -173,7 +173,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.Intbox to the coordinates of a Rectangle.
* Transforms a geometry.planar.Intbox to the coordinates of a Rectangle.
*/
public double [] board_to_dsn(IntBox p_box)
{
@ -186,7 +186,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.geometry.planar.Intbox to a Rectangle in relative (vector) coordinates.
* Transforms a geometry.planar.Intbox to a Rectangle in relative (vector) coordinates.
*/
public double [] board_to_dsn_rel(IntBox p_box)
{
@ -199,7 +199,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms a eu.mihosoft.freerouting.board shape to a dsn shape.
* Transforms a board shape to a dsn shape.
*/
public Shape board_to_dsn(eu.mihosoft.freerouting.geometry.planar.Shape p_board_shape, Layer p_layer)
{
@ -230,7 +230,7 @@ public class CoordinateTransform implements java.io.Serializable
}
/**
* Transforms the relative (vector) coordinates of a eu.mihosoft.freerouting.geometry.planar.Shape to a specctra dsn shape.
* Transforms the relative (vector) coordinates of a geometry.planar.Shape to a specctra dsn shape.
*/
public Shape board_to_dsn_rel(eu.mihosoft.freerouting.geometry.planar.Shape p_board_shape, Layer p_layer)
{

10
src/main/java/eu/mihosoft/freerouting/designforms/specctra/DsnFile.java
View File

@ -46,9 +46,9 @@ public class DsnFile
}
/**
* Creates a routing eu.mihosoft.freerouting.board from a Specctra dns file.
* Creates a routing board from a Specctra dns file.
* The parameters p_item_observers and p_item_id_no_generator are used,
* in case the eu.mihosoft.freerouting.board is embedded into a host system.
* in case the board is embedded into a host system.
* Returns false, if an error occured.
*/
public static ReadResult read(java.io.InputStream p_input_stream, eu.mihosoft.freerouting.interactive.IBoardHandling p_board_handling,
@ -92,7 +92,7 @@ public class DsnFile
result = ReadResult.OK;
if (read_scope_par.autoroute_settings == null)
{
// look for power planes with incorrect layer type and adjust eu.mihosoft.freerouting.autoroute parameters
// look for power planes with incorrect layer type and adjust autoroute parameters
adjust_plane_autoroute_settings(p_board_handling);
}
}
@ -185,7 +185,7 @@ public class DsnFile
}
if (curr_area < 0.5 * board_area)
{
// skip conduction areas not covering most of the eu.mihosoft.freerouting.board
// skip conduction areas not covering most of the board
continue;
}
@ -206,7 +206,7 @@ public class DsnFile
{
return false;
}
// Adjust the layer prefered directions in the eu.mihosoft.freerouting.autoroute settings.
// Adjust the layer preferred directions in the autoroute settings.
// and deactivate the changed layers.
eu.mihosoft.freerouting.interactive.AutorouteSettings autoroute_settings = p_board_handling.get_settings().autoroute_settings;
int layer_count = routing_board.get_layer_count();

2
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Layer.java
View File

@ -34,7 +34,7 @@ import java.util.LinkedList;
*/
public class Layer
{
/** all layers of the eu.mihosoft.freerouting.board */
/** all layers of the board */
public static final Layer PCB = new Layer("pcb", -1, false);
/** the signal layers */
public static final Layer SIGNAL = new Layer("signal", -1, true);

2
src/main/java/eu/mihosoft/freerouting/designforms/specctra/LayerStructure.java
View File

@ -45,7 +45,7 @@ public class LayerStructure
}
/**
* Creates a dsn-LayerStructure from a eu.mihosoft.freerouting.board LayerStructure.
* Creates a dsn-LayerStructure from a board LayerStructure.
*/
public LayerStructure(eu.mihosoft.freerouting.board.LayerStructure p_board_layer_structure)
{

4
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Library.java
View File

@ -35,7 +35,7 @@ import java.util.LinkedList;
/**
* Class for reading and writing eu.mihosoft.freerouting.library scopes from dsn-files.
* Class for reading and writing library scopes from dsn-files.
*
* @author Alfons Wirtz
*/
@ -132,7 +132,7 @@ public class Library extends ScopeKeyword
board.library.set_via_padstacks(via_padstacks);
}
// Create the eu.mihosoft.freerouting.library packages on the eu.mihosoft.freerouting.board
// Create the library packages on the board
board.library.packages = new eu.mihosoft.freerouting.library.Packages(board.library.padstacks);
Iterator<Package> it = package_list.iterator();
while (it.hasNext())

14
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Network.java
View File

@ -441,7 +441,7 @@ public class Network extends ScopeKeyword
curr_subnet.set_pins(curr_pin_list);
if (!net_rules.isEmpty())
{
// Evaluate the net eu.mihosoft.freerouting.rules.
// Evaluate the net rules.
eu.mihosoft.freerouting.rules.Net board_net = p_board.rules.nets.get(curr_subnet.id.name, curr_subnet.id.subnet_number);
if (board_net == null)
{
@ -712,7 +712,7 @@ public class Network extends ScopeKeyword
}
/**
* Inserts a via rule into the eu.mihosoft.freerouting.board.
* Inserts a via rule into the board.
* Replaces an already existing via rule with the same
*/
static boolean add_via_rule(Collection<String> p_name_list, eu.mihosoft.freerouting.board.BasicBoard p_board)
@ -801,7 +801,7 @@ public class Network extends ScopeKeyword
}
}
// read the trace width and clearance eu.mihosoft.freerouting.rules.
// read the trace width and clearance rules.
boolean clearance_rule_found = false;
@ -824,7 +824,7 @@ public class Network extends ScopeKeyword
}
}
// read the layer dependent eu.mihosoft.freerouting.rules.
// read the layer dependent rules.
for (Rule.LayerRule curr_layer_rule : p_class.layer_rules)
{
@ -1224,8 +1224,8 @@ public class Network extends ScopeKeyword
}
/**
* Create the part eu.mihosoft.freerouting.library on the eu.mihosoft.freerouting.board. Can be called after the components are inserted.
* Returns false, if an error occured.
* Create the part library on the board. Can be called after the components are inserted.
* Returns false, if an error occurred.
*/
private static boolean insert_logical_parts(ReadScopeParameter p_par)
{
@ -1318,7 +1318,7 @@ public class Network extends ScopeKeyword
}
/**
* Inserts all eu.mihosoft.freerouting.board components belonging to the input eu.mihosoft.freerouting.library component.
* Inserts all board components belonging to the input library component.
*/
private static void insert_component(ComponentPlacement.ComponentLocation p_location, String p_lib_key,
ReadScopeParameter p_par)

2
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Package.java
View File

@ -481,7 +481,7 @@ public class Package
public final Collection<Shape.ReadAreaScopeResult> via_keepouts;
/** Collection of place keepoouts belonging to this package */
public final Collection<Shape.ReadAreaScopeResult> place_keepouts;
/** If false, the package is placed on the back side of the eu.mihosoft.freerouting.board */
/** If false, the package is placed on the back side of the board */
public final boolean is_front;

4
src/main/java/eu/mihosoft/freerouting/designforms/specctra/ReadScopeParameter.java
View File

@ -62,14 +62,14 @@ public class ReadScopeParameter
/**
* Component placement information.
* It is filled while reading the placement scope and can be
* evaluated after reading the eu.mihosoft.freerouting.library and network scope.
* evaluated after reading the library and network scope.
*/
final Collection<ComponentPlacement> placement_list = new LinkedList<ComponentPlacement>();
/**
* The names of the via padstacks filled while reading the structure scope
* and evaluated after reading the eu.mihosoft.freerouting.library scope.
* and evaluated after reading the library scope.
*/
Collection<String> via_padstack_names = null;

2
src/main/java/eu/mihosoft/freerouting/designforms/specctra/RulesFile.java
View File

@ -30,7 +30,7 @@ import eu.mihosoft.freerouting.board.BasicBoard;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* File for saving the eu.mihosoft.freerouting.board rules, so that they can be restored after the Board
* File for saving the board rules, so that they can be restored after the Board
* is creates anew from the host system.
*
* @author Alfons Wirtz

4
src/main/java/eu/mihosoft/freerouting/designforms/specctra/SessionToEagle.java
View File

@ -715,7 +715,7 @@ public class SessionToEagle extends javax.swing.JFrame
/** The generated Eagle script file. */
private final java.io.OutputStreamWriter out_file;
/** Some information is read from the eu.mihosoft.freerouting.board, because it is not contained in the speccctra session file. */
/** Some information is read from the board, because it is not contained in the speccctra session file. */
private final eu.mihosoft.freerouting.board.BasicBoard board;
/** The layer structure in specctra format */
@ -726,7 +726,7 @@ public class SessionToEagle extends javax.swing.JFrame
/** The scale factor for transforming coordinates from the session file to Eagle */
private final double session_file_scale_denominator;
/** The scale factor for transforming coordinates from the eu.mihosoft.freerouting.board to Eagle */
/** The scale factor for transforming coordinates from the board to Eagle */
private final double board_scale_factor;
private static class PinInfo

8
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Shape.java
View File

@ -680,7 +680,7 @@ public abstract class Shape
}
/**
* Transforms a shape with holes to the eu.mihosoft.freerouting.board coordinate system.
* Transforms a shape with holes to the board coordinate system.
* The first shape in the Collection p_area is the border,
* the other shapes are holes of the area.
*/
@ -726,7 +726,7 @@ public abstract class Shape
}
/**
* Transforms the relative coordinates of a shape with holes to the eu.mihosoft.freerouting.board coordinate system.
* Transforms the relative coordinates of a shape with holes to the board coordinate system.
* The first shape in the Collection p_area is the border,
* the other shapes are holes of the area.
*/
@ -780,7 +780,7 @@ public abstract class Shape
}
/**
* Transforms a specctra dsn shape to a eu.mihosoft.freerouting.geometry.planar.Shape.
* Transforms a specctra dsn shape to a geometry.planar.Shape.
*/
public abstract eu.mihosoft.freerouting.geometry.planar.Shape transform_to_board(CoordinateTransform p_coordinate_transform);
@ -790,7 +790,7 @@ public abstract class Shape
public abstract Rectangle bounding_box();
/**
* Transforms the relative (vector) coordinates of a specctra dsn shape to a eu.mihosoft.freerouting.geometry.planar.Shape.
* Transforms the relative (vector) coordinates of a specctra dsn shape to a geometry.planar.Shape.
*/
public abstract eu.mihosoft.freerouting.geometry.planar.Shape transform_to_board_rel(CoordinateTransform p_coordinate_transform);

10
src/main/java/eu/mihosoft/freerouting/designforms/specctra/Structure.java
View File

@ -306,7 +306,7 @@ class Structure extends ScopeKeyword
Rectangle bounding_rectangle = new Rectangle(Layer.PCB, rect_coor);
bounding_rectangle.write_scope(p_par.file, p_par.identifier_type);
p_par.file.end_scope();
// lookup the outline in the eu.mihosoft.freerouting.board
// lookup the outline in the board
Storable curr_ob = null;
Iterator<UndoableObjects.UndoableObjectNode> it = p_par.board.item_list.start_read_object();
for (;;)
@ -348,7 +348,7 @@ class Structure extends ScopeKeyword
write_default_rules(p_par);
// write the eu.mihosoft.freerouting.autoroute settings
// write the autoroute settings
AutorouteSettings.write_scope(p_par.file, p_par.autoroute_settings,
p_par.board.layer_structure, p_par.identifier_type);
@ -847,7 +847,7 @@ class Structure extends ScopeKeyword
eu.mihosoft.freerouting.board.LayerStructure board_layer_structure = new eu.mihosoft.freerouting.board.LayerStructure(board_layer_arr);
p_par.layer_structure = new LayerStructure(p_board_construction_info.layer_info);
// Calculate an appropritate scaling between dsn coordinates and eu.mihosoft.freerouting.board coordinates.
// Calculate an approximate scaling between dsn coordinates and board coordinates.
int scale_factor = Math.max(p_par.resolution, 1);
double max_coor = 0;
@ -921,7 +921,7 @@ class Structure extends ScopeKeyword
eu.mihosoft.freerouting.board.BasicBoard board = p_par.board_handling.get_routing_board();
// Insert the holes in the eu.mihosoft.freerouting.board outline as keepouts.
// Insert the holes in the board outline as keepouts.
for (PolylineShape curr_outline_hole : hole_shapes)
{
for (int i = 0; i < board_layer_structure.arr.length; ++i)
@ -1090,7 +1090,7 @@ class Structure extends ScopeKeyword
}
/**
* Converts a dsn clearance rule into a eu.mihosoft.freerouting.board clearance rule.
* Converts a dsn clearance rule into a board clearance rule.
* If p_layer_no < 0, the rule is set on all layers.
* Returns true, if the string smd_to_turn_gap was found.
*/

30
src/main/java/eu/mihosoft/freerouting/gui/BoardFrame.java
View File

@ -34,7 +34,7 @@ import eu.mihosoft.freerouting.logger.FRLogger;
/**
*
* Graphical frame of for eu.mihosoft.freerouting.interactive editing of a routing eu.mihosoft.freerouting.board.
* Graphical frame of for interactive editing of a routing board.
*
* @author Alfons Wirtz
*/
@ -47,7 +47,7 @@ public class BoardFrame extends javax.swing.JFrame
}
/**
* Creates a new eu.mihosoft.freerouting.board frame with the input design file imbedded into a host cad software.
* Creates a new board frame with the input design file embedded into a host cad software.
*/
public static BoardFrame get_embedded_instance(String p_design_file_path_name,
BoardObservers p_observers, IdNoGenerator p_id_no_generator, java.util.Locale p_locale)
@ -85,7 +85,7 @@ public class BoardFrame extends javax.swing.JFrame
* If p_option = Option.IN_SAND_BOX, no security sensitive actions like for example choosing
* If p_option = Option.WEBSTART, the application has been started with Java Webstart.
* files are allowed, so that the frame can be used in an applet.
* Currently Option.EXTENDED_TOOL_BAR is used only if a new eu.mihosoft.freerouting.board is
* Currently Option.EXTENDED_TOOL_BAR is used only if a new board is
* created by the application from scratch.
* If p_test_level {@literal >} RELEASE_VERSION, functionality not yet ready for release is included.
* Also the warning output depends on p_test_level.
@ -160,7 +160,7 @@ public class BoardFrame extends javax.swing.JFrame
}
/**
* Reads eu.mihosoft.freerouting.interactive actions from a logfile.
* Reads interactive actions from a logfile.
*/
void read_logfile(java.io.InputStream p_input_stream)
{
@ -169,8 +169,8 @@ public class BoardFrame extends javax.swing.JFrame
/**
* Reads an existing eu.mihosoft.freerouting.board design from file.
* If p_is_import, the design is read from a scpecctra dsn file.
* Reads an existing board design from file.
* If p_is_import, the design is read from a specctra dsn file.
* Returns false, if the file is invalid.
*/
boolean read(java.io.InputStream p_input_stream, boolean p_is_import, javax.swing.JTextField p_message_field) {
@ -252,7 +252,7 @@ public class BoardFrame extends javax.swing.JFrame
this.setVisible(true);
if (p_is_import)
{
// Read the default eu.mihosoft.freerouting.gui settings, if eu.mihosoft.freerouting.gui default file exists.
// Read the default gui settings, if gui default file exists.
java.io.InputStream input_stream = null;
boolean defaults_file_found;
@ -290,7 +290,7 @@ public class BoardFrame extends javax.swing.JFrame
/**
* Saves the eu.mihosoft.freerouting.interactive settings and the design file to disk.
* Saves the interactive settings and the design file to disk.
* Returns false, if the save failed.
*/
boolean save()
@ -397,7 +397,7 @@ public class BoardFrame extends javax.swing.JFrame
}
/**
* Calculates the absolute location of the eu.mihosoft.freerouting.board frame in his outmost parent frame.
* Calculates the absolute location of the board frame in his outmost parent frame.
*/
java.awt.Point absolute_panel_location()
{
@ -413,7 +413,7 @@ public class BoardFrame extends javax.swing.JFrame
return new java.awt.Point(x, y);
}
/** Sets the displayed region to the whole eu.mihosoft.freerouting.board. */
/** Sets the displayed region to the whole board. */
public void zoom_all()
{
board_panel.board_handling.adjust_design_bounds();
@ -510,7 +510,7 @@ public class BoardFrame extends javax.swing.JFrame
}
/**
* Creates the additional frames of the eu.mihosoft.freerouting.board frame.
* Creates the additional frames of the board frame.
*/
private void initialize_windows()
{
@ -555,7 +555,7 @@ public class BoardFrame extends javax.swing.JFrame
}
/**
* Sets the background of the eu.mihosoft.freerouting.board panel
* Sets the background of the board panel
*/
public void set_board_background(java.awt.Color p_color)
{
@ -646,7 +646,7 @@ public class BoardFrame extends javax.swing.JFrame
}
/**
* Repaints this eu.mihosoft.freerouting.board frame and all the subwindows of the eu.mihosoft.freerouting.board.
* Repaints this board frame and all the subwindows of the board.
*/
public void repaint_all()
{
@ -657,13 +657,13 @@ public class BoardFrame extends javax.swing.JFrame
}
}
/** The scroll pane for the panel of the routing eu.mihosoft.freerouting.board. */
/** The scroll pane for the panel of the routing board. */
final javax.swing.JScrollPane scroll_pane;
/** The menubar of this frame */
final BoardMenuBar menubar;
/** The panel with the graphical representation of the eu.mihosoft.freerouting.board. */
/** The panel with the graphical representation of the board. */
final BoardPanel board_panel;
/** The panel with the toolbars */

2
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuBar.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Creates the menu bar of a eu.mihosoft.freerouting.board frame together with its menu items.
* Creates the menu bar of a board frame together with its menu items.
*
* @author Alfons Wirtz
*/

4
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuDisplay.java
View File

@ -24,13 +24,13 @@
package eu.mihosoft.freerouting.gui;
/**
* Creates the display menu of a eu.mihosoft.freerouting.board frame.
* Creates the display menu of a board frame.
*
* @author Alfons Wirtz
*/
public class BoardMenuDisplay extends javax.swing.JMenu
{
/** Returns a new display menu for the eu.mihosoft.freerouting.board frame. */
/** Returns a new display menu for the board frame. */
public static BoardMenuDisplay get_instance(BoardFrame p_board_frame)
{
final BoardMenuDisplay display_menu = new BoardMenuDisplay(p_board_frame);

6
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuFile.java
View File

@ -25,14 +25,14 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Creates the file menu of a eu.mihosoft.freerouting.board frame.
* Creates the file menu of a board frame.
*
* @author Alfons Wirtz
*/
public class BoardMenuFile extends javax.swing.JMenu
{
/** Returns a new file menu for the eu.mihosoft.freerouting.board frame. */
/** Returns a new file menu for the board frame. */
public static BoardMenuFile get_instance(BoardFrame p_board_frame, boolean p_session_file_option)
{
final BoardMenuFile file_menu = new BoardMenuFile(p_board_frame, p_session_file_option);
@ -198,7 +198,7 @@ public class BoardMenuFile extends javax.swing.JMenu
}
/**
* Adds a menu item for saving the current eu.mihosoft.freerouting.interactive settings as default.
* Adds a menu item for saving the current interactive settings as default.
*/
private void add_save_settings_item()
{

2
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuHelp.java
View File

@ -104,7 +104,7 @@ public class BoardMenuHelp extends BoardMenuHelpReduced
}
if (BoardFrame.help_broker != null)
{
// CSH.DisplayHelpFromSource is a convenience class to display the eu.mihosoft.freerouting.helpset
// CSH.DisplayHelpFromSource is a convenience class to display the helpset
contents_help = new CSH.DisplayHelpFromSource(BoardFrame.help_broker);
direct_help = new CSH.DisplayHelpAfterTracking(BoardFrame.help_broker);
}

2
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuInfo.java
View File

@ -29,7 +29,7 @@ package eu.mihosoft.freerouting.gui;
*/
public class BoardMenuInfo extends javax.swing.JMenu
{
/** Returns a new info menu for the eu.mihosoft.freerouting.board frame. */
/** Returns a new info menu for the board frame. */
public static BoardMenuInfo get_instance(BoardFrame p_board_frame)
{
final BoardMenuInfo info_menu = new BoardMenuInfo(p_board_frame);

2
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuOther.java
View File

@ -30,7 +30,7 @@ package eu.mihosoft.freerouting.gui;
*/
public class BoardMenuOther extends javax.swing.JMenu
{
/** Returns a new other menu for the eu.mihosoft.freerouting.board frame. */
/** Returns a new other menu for the board frame. */
public static BoardMenuOther get_instance(BoardFrame p_board_frame)
{
final BoardMenuOther other_menu = new BoardMenuOther(p_board_frame);

4
src/main/java/eu/mihosoft/freerouting/gui/BoardMenuParameter.java
View File

@ -24,13 +24,13 @@
package eu.mihosoft.freerouting.gui;
/**
* Creates the parameter menu of a eu.mihosoft.freerouting.board frame.
* Creates the parameter menu of a board frame.
*
* @author Alfons Wirtz
*/
public class BoardMenuParameter extends javax.swing.JMenu
{
/** Returns a new windows menu for the eu.mihosoft.freerouting.board frame. */
/** Returns a new windows menu for the board frame. */
public static BoardMenuParameter get_instance(BoardFrame p_board_frame)
{
final BoardMenuParameter parameter_menu = new BoardMenuParameter(p_board_frame);

10
src/main/java/eu/mihosoft/freerouting/gui/BoardPanel.java
View File

@ -42,7 +42,7 @@ import javax.swing.event.TableModelListener;
/**
*
* Panel containing the graphical representation of a routing eu.mihosoft.freerouting.board.
* Panel containing the graphical representation of a routing board.
*
* @author Alfons Wirtz
*/
@ -220,7 +220,7 @@ public class BoardPanel extends javax.swing.JPanel
}
/**
* overwrites the paintComponent method to draw the routing eu.mihosoft.freerouting.board
* overwrites the paintComponent method to draw the routing board
*/
public void paintComponent(Graphics p_g)
{
@ -315,7 +315,7 @@ public class BoardPanel extends javax.swing.JPanel
/**
* zooms the content of the eu.mihosoft.freerouting.board by p_factor
* zooms the content of the board by p_factor
* Returns the change of the cursor location
*/
public java.awt.geom.Point2D zoom(double p_factor, java.awt.geom.Point2D p_location)
@ -490,7 +490,7 @@ public class BoardPanel extends javax.swing.JPanel
private java.awt.Point middle_drag_position = null ;
/**
* Defines the appearance of the custom custom_cursor in the eu.mihosoft.freerouting.board panel.
* Defines the appearance of the custom custom_cursor in the board panel.
* Null, if the standard custom_cursor is used.
*/
private Cursor custom_cursor = null;
@ -500,7 +500,7 @@ public class BoardPanel extends javax.swing.JPanel
{
public void tableChanged(TableModelEvent p_event)
{
//redisplay eu.mihosoft.freerouting.board because some colors have changed.
//redisplay board because some colors have changed.
setBackground(board_handling.graphics_context.get_background_color());
repaint();
}

2
src/main/java/eu/mihosoft/freerouting/gui/BoardPanelStatus.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Panel at the lower border of the eu.mihosoft.freerouting.board frame containing amongst others the message line
* Panel at the lower border of the board frame containing amongst others the message line
* and the current layer and cursor position.
*
* @author Alfons Wirtz

2
src/main/java/eu/mihosoft/freerouting/gui/BoardSavableSubWindow.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Subwindow of the eu.mihosoft.freerouting.board frame, whose location and visibility can be saved and read from disc.
* Subwindow of the board frame, whose location and visibility can be saved and read from disc.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/BoardSubWindow.java
View File

@ -25,7 +25,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Subwindows of the eu.mihosoft.freerouting.board frame.
* Subwindows of the board frame.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/BoardTemporarySubWindow.java
View File

@ -46,7 +46,7 @@ public class BoardTemporarySubWindow extends BoardSubWindow
});
}
/** Used, when the eu.mihosoft.freerouting.board frame with all the subwindows is disposed. */
/** Used, when the board frame with all the subwindows is disposed. */
public void board_frame_disposed()
{
super.dispose();

2
src/main/java/eu/mihosoft/freerouting/gui/BoardToolbar.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Implements the toolbar panel of the eu.mihosoft.freerouting.board frame.
* Implements the toolbar panel of the board frame.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/BoardToolbarSelectedItem.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Describes the toolbar of the eu.mihosoft.freerouting.board frame, when it is in the selected item state.
* Describes the toolbar of the board frame, when it is in the selected item state.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/ColorManager.java
View File

@ -48,7 +48,7 @@ import eu.mihosoft.freerouting.boardgraphics.GraphicsContext;
/**
* Window for changing the colors of eu.mihosoft.freerouting.board objects.
* Window for changing the colors of board objects.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/ComboBoxClearance.java
View File

@ -25,7 +25,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.rules.ClearanceMatrix;
/**
* A Combo Box with an item for each clearance class of the eu.mihosoft.freerouting.board..
* A Combo Box with an item for each clearance class of the board.
*
* @author alfons
*/

8
src/main/java/eu/mihosoft/freerouting/gui/ComboBoxLayer.java
View File

@ -25,7 +25,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.board.LayerStructure;
/**
* A Combo Box with items for individuell eu.mihosoft.freerouting.board layers plus an additional item for all layers.
* A Combo Box with items for individual board layers plus an additional item for all layers.
*
* @author Alfons Wirtz
*/
@ -70,8 +70,8 @@ public class ComboBoxLayer extends javax.swing.JComboBox
private final Layer [] layer_arr;
/**
* Layers of the eu.mihosoft.freerouting.board layer structure plus layer "all".
* Index is the layer number in the eu.mihosoft.freerouting.board layer structure or -1 for layer "all".
* Layers of the board layer structure plus layer "all".
* Index is the layer number in the board layer structure or -1 for layer "all".
*/
public static class Layer
{
@ -88,7 +88,7 @@ public class ComboBoxLayer extends javax.swing.JComboBox
final String name;
/** The index in the eu.mihosoft.freerouting.board layer_structure, -1 for the layers with name "all" or "inner" */
/** The index in the board layer_structure, -1 for the layers with name "all" or "inner" */
final int index;
}

2
src/main/java/eu/mihosoft/freerouting/gui/DesignFile.java
View File

@ -247,7 +247,7 @@ public class DesignFile
}
/**
* Saves the eu.mihosoft.freerouting.board rule to file, so that they can be reused later on.
* Saves the board rule to file, so that they can be reused later on.
*/
private boolean write_rules_file(String p_design_name, eu.mihosoft.freerouting.interactive.BoardHandling p_board_handling)
{

4
src/main/java/eu/mihosoft/freerouting/gui/GUIDefaultsFile.java
View File

@ -29,14 +29,14 @@ import eu.mihosoft.freerouting.board.ItemSelectionFilter;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Description of a text file, where the eu.mihosoft.freerouting.board independent eu.mihosoft.freerouting.interactive settings are stored.
* Description of a text file, where the board independent interactive settings are stored.
*
* @author Alfons Wirtz
*/
public class GUIDefaultsFile
{
/**
* Keywords in the eu.mihosoft.freerouting.gui defaults file.
* Keywords in the gui defaults file.
*/
enum Keyword
{

14
src/main/java/eu/mihosoft/freerouting/gui/MainApplication.java
View File

@ -35,7 +35,7 @@ import java.io.File;
/**
*
* Main application for creating frames with new or existing eu.mihosoft.freerouting.board designs.
* Main application for creating frames with new or existing board designs.
*
* @author Alfons Wirtz
*/
@ -273,7 +273,7 @@ public class MainApplication extends javax.swing.JFrame
setSize(450,250);
}
/** opens a eu.mihosoft.freerouting.board design from a binary file or a specctra dsn file. */
/** opens a board design from a binary file or a specctra dsn file. */
private void open_board_design_action(java.awt.event.ActionEvent evt)
{
DesignFile design_file = DesignFile.open_dialog(this.design_dir_name);
@ -325,8 +325,8 @@ public class MainApplication extends javax.swing.JFrame
}
/**
* Creates a new eu.mihosoft.freerouting.board frame containing the data of the input design file.
* Returns null, if an error occured.
* Creates a new board frame containing the data of the input design file.
* Returns null, if an error occurred.
*/
static private BoardFrame create_board_frame(DesignFile p_design_file, javax.swing.JTextField p_message_field,
BoardFrame.Option p_option, boolean p_is_test_version, java.util.Locale p_locale)
@ -386,10 +386,10 @@ public class MainApplication extends javax.swing.JFrame
*/
private final WindowNetSamples window_net_demonstrations;
/**
* A Frame with sample eu.mihosoft.freerouting.board designs in the net.
* A Frame with sample board designs in the net.
*/
private final WindowNetSamples window_net_sample_designs;
/** The list of open eu.mihosoft.freerouting.board frames */
/** The list of open board frames */
private final java.util.Collection<BoardFrame> board_frames
= new java.util.LinkedList<>();
private String design_dir_name = null;
@ -411,7 +411,7 @@ public class MainApplication extends javax.swing.JFrame
{
if (board_frame != null)
{
// remove this board_frame from the list of eu.mihosoft.freerouting.board frames
// remove this board_frame from the list of board frames
board_frame.dispose();
board_frames.remove(board_frame);
board_frame = null;

2
src/main/java/eu/mihosoft/freerouting/gui/PopupMenuCopy.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Popup menu used in the eu.mihosoft.freerouting.interactive copy item state.
* Popup menu used in the interactive copy item state.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/PopupMenuDynamicRoute.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Popup menu used in the eu.mihosoft.freerouting.interactive route state.
* Popup menu used in the interactive route state.
*
* @author Alfons Wirtz
*/

4
src/main/java/eu/mihosoft/freerouting/gui/PopupMenuMain.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Popup Menu used in the eu.mihosoft.freerouting.interactive select state.
* Popup Menu used in the interactive select state.
*
* @author Alfons Wirtz
*/
@ -129,7 +129,7 @@ class PopupMenuMain extends PopupMenuDisplay
if (board_panel.board_handling.get_routing_board().library.logical_parts.count() > 0)
{
// the eu.mihosoft.freerouting.board contains swappable gates or pins
// the board contains swappable gates or pins
javax.swing.JMenuItem swap_pin_item = new javax.swing.JMenuItem();
swap_pin_item.setText(resources.getString("swap_pin"));
swap_pin_item.addActionListener(new java.awt.event.ActionListener()

2
src/main/java/eu/mihosoft/freerouting/gui/PopupMenuSelectedItems.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Popup menu used in the eu.mihosoft.freerouting.interactive selected item state..
* Popup menu used in the interactive selected item state..
*
* @author Alfons Wirtz
*/

4
src/main/java/eu/mihosoft/freerouting/gui/WindowClearanceMatrix.java
View File

@ -29,7 +29,7 @@ import eu.mihosoft.freerouting.rules.ClearanceMatrix;
import eu.mihosoft.freerouting.datastructures.UndoableObjects;
/**
* Window for eu.mihosoft.freerouting.interactive editing of the clearance Matrix.
* Window for interactive editing of the clearance Matrix.
*
* @author Alfons Wirtz
*/
@ -395,7 +395,7 @@ public class WindowClearanceMatrix extends BoardSavableSubWindow
int curr_row = p_row;
int curr_column = p_col - 1;
// check, if there are items on the eu.mihosoft.freerouting.board assigned to clearance class i or j.
// check, if there are items on the board assigned to clearance class i or j.
eu.mihosoft.freerouting.interactive.BoardHandling board_handling = board_frame.board_panel.board_handling;
eu.mihosoft.freerouting.datastructures.UndoableObjects item_list = board_handling.get_routing_board().item_list;

4
src/main/java/eu/mihosoft/freerouting/gui/WindowComponents.java
View File

@ -26,7 +26,7 @@ import eu.mihosoft.freerouting.board.Component;
import eu.mihosoft.freerouting.board.Components;
/**
* Window displaying the components on the eu.mihosoft.freerouting.board.
* Window displaying the components on the board.
*
* @author Alfons Wirtz
*/
@ -44,7 +44,7 @@ public class WindowComponents extends WindowObjectListWithFilter
}
/**
* Fills the list with the eu.mihosoft.freerouting.board components.
* Fills the list with the board components.
*/
protected void fill_list()
{

12
src/main/java/eu/mihosoft/freerouting/gui/WindowDisplayMisc.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Window for eu.mihosoft.freerouting.interactive changing of miscellanious display properties.
* Window for interactive changing of miscellaneous display properties.
*
* @author Alfons Wirtz
*/
@ -85,7 +85,7 @@ public class WindowDisplayMisc extends BoardSavableSubWindow
gridbag.setConstraints(separator, gridbag_constraints);
main_panel.add(separator, gridbag_constraints);
// Add label and buttongroup for the rotation of the eu.mihosoft.freerouting.board.
// Add label and buttongroup for the rotation of the board.
javax.swing.JLabel rotation_label = new javax.swing.JLabel(" " + resources.getString("rotation"));
gridbag_constraints.gridwidth = java.awt.GridBagConstraints.RELATIVE;
@ -128,7 +128,7 @@ public class WindowDisplayMisc extends BoardSavableSubWindow
main_panel.add(separator, gridbag_constraints);
// add label and buttongroup for the mirroring of the eu.mihosoft.freerouting.board.
// add label and buttongroup for the mirroring of the board.
javax.swing.JLabel mirroring_label = new javax.swing.JLabel(" " + resources.getString("board_mirroring"));
gridbag_constraints.gridwidth = java.awt.GridBagConstraints.RELATIVE;
@ -315,7 +315,7 @@ public class WindowDisplayMisc extends BoardSavableSubWindow
{
return; // mirroring already switched off
}
// remember the old viewort center to retain the displayed section of the eu.mihosoft.freerouting.board.
// remember the old viewort center to retain the displayed section of the board.
eu.mihosoft.freerouting.geometry.planar.FloatPoint old_viewport_center =
coordinate_transform.screen_to_board(panel.get_viewport_center());
coordinate_transform.set_mirror_left_right(false);
@ -336,7 +336,7 @@ public class WindowDisplayMisc extends BoardSavableSubWindow
{
return; // already mirrored
}
// remember the old viewort center to retain the displayed section of the eu.mihosoft.freerouting.board.
// remember the old viewport center to retain the displayed section of the board.
eu.mihosoft.freerouting.geometry.planar.FloatPoint old_viewport_center =
coordinate_transform.screen_to_board(panel.get_viewport_center());
coordinate_transform.set_mirror_left_right(true);
@ -356,7 +356,7 @@ public class WindowDisplayMisc extends BoardSavableSubWindow
{
return; // already mirrored
}
// remember the old viewort center to retain the displayed section of the eu.mihosoft.freerouting.board.
// remember the old viewport center to retain the displayed section of the board.
eu.mihosoft.freerouting.geometry.planar.FloatPoint old_viewport_center =
coordinate_transform.screen_to_board(panel.get_viewport_center());
coordinate_transform.set_mirror_top_bottom(true);

2
src/main/java/eu/mihosoft/freerouting/gui/WindowIncompletes.java
View File

@ -45,7 +45,7 @@ public class WindowIncompletes extends WindowObjectListWithFilter
/**
* Fills the list with the eu.mihosoft.freerouting.board incompletes.
* Fills the list with the board incompletes.
*/
protected void fill_list()
{

2
src/main/java/eu/mihosoft/freerouting/gui/WindowLayerVisibility.java
View File

@ -24,7 +24,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Interactive Frame to adjust the visibility of the individual eu.mihosoft.freerouting.board layers
* Interactive Frame to adjust the visibility of the individual board layers
*
* @author alfons
*/

2
src/main/java/eu/mihosoft/freerouting/gui/WindowManualRules.java
View File

@ -23,7 +23,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Used for manual choice of trace widths in eu.mihosoft.freerouting.interactive routing.
* Used for manual choice of trace widths in interactive routing.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/WindowNetDemonstrations.java
View File

@ -99,7 +99,7 @@ public class WindowNetDemonstrations extends WindowNetSamples
}
/**
* Additional Acction to be performed after opening the eu.mihosoft.freerouting.board.
* Additional Action to be performed after opening the board.
*/
private enum AdditionalAction
{

4
src/main/java/eu/mihosoft/freerouting/gui/WindowNetSampleDesigns.java
View File

@ -25,14 +25,14 @@ package eu.mihosoft.freerouting.gui;
/**
*
* Window with a list for selecting sample eu.mihosoft.freerouting.board designs in the net.
* Window with a list for selecting sample board designs in the net.
*
* @author Alfons Wirtz
*/
public class WindowNetSampleDesigns extends WindowNetSamples
{
/** Creates a new instance of WindowNeetSampleDesigns */
/** Creates a new instance of WindowNetSampleDesigns */
public WindowNetSampleDesigns(java.util.Locale p_locale)
{
super(p_locale, "sample_designs", "open_sample_design", 11);

4
src/main/java/eu/mihosoft/freerouting/gui/WindowObjectInfo.java
View File

@ -37,7 +37,7 @@ public class WindowObjectInfo extends BoardTemporarySubWindow implements eu.miho
{
/**
* Displays a new ObjectInfoWindow with information about the items in p_item_list.
* p_coordinate_transform is for transforming eu.mihosoft.freerouting.board to user coordinates,
* p_coordinate_transform is for transforming board to user coordinates,
* and p_location is the location of the window.
*/
public static void display(Collection<eu.mihosoft.freerouting.board.Item> p_item_list,
@ -129,7 +129,7 @@ public class WindowObjectInfo extends BoardTemporarySubWindow implements eu.miho
/**
* Displays a new ObjectInfoWindow with information about the objects in p_object_list.
* p_coordinate_transform is for transforming eu.mihosoft.freerouting.board to user coordinates,
* p_coordinate_transform is for transforming board to user coordinates,
* and p_location is the location of the window.
*/
public static WindowObjectInfo display(String p_title, Collection<Printable> p_object_list,

2
src/main/java/eu/mihosoft/freerouting/gui/WindowObjectVisibility.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.boardgraphics.ColorIntensityTable.ObjectNames;
/**
* Interactive Frame to adjust the visibility of the individual eu.mihosoft.freerouting.board items
* Interactive Frame to adjust the visibility of the individual board items
*
* @author alfons
*/

4
src/main/java/eu/mihosoft/freerouting/gui/WindowPackages.java
View File

@ -27,7 +27,7 @@ import eu.mihosoft.freerouting.library.Packages;
import eu.mihosoft.freerouting.library.Package;
/**
* Window displaying the eu.mihosoft.freerouting.library packagess.
* Window displaying the library packagess.
*
* @author Alfons Wirtz
*/
@ -45,7 +45,7 @@ public class WindowPackages extends WindowObjectListWithFilter
}
/**
* Fills the list with the eu.mihosoft.freerouting.library packages.
* Fills the list with the library packages.
*/
protected void fill_list()
{

4
src/main/java/eu/mihosoft/freerouting/gui/WindowPadstacks.java
View File

@ -29,7 +29,7 @@ import eu.mihosoft.freerouting.library.Padstack;
import eu.mihosoft.freerouting.library.Padstacks;
/**
* Window displaying the eu.mihosoft.freerouting.library padstacks.
* Window displaying the library padstacks.
*
* @author Alfons Wirtz
*/
@ -47,7 +47,7 @@ public class WindowPadstacks extends WindowObjectListWithFilter
}
/**
* Fills the list with the eu.mihosoft.freerouting.library padstacks.
* Fills the list with the library padstacks.
*/
protected void fill_list()
{

2
src/main/java/eu/mihosoft/freerouting/gui/WindowRouteDetail.java
View File

@ -25,7 +25,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.board.BoardOutline;
/**
* Window handling detail parameters of the eu.mihosoft.freerouting.interactive routing.
* Window handling detail parameters of the interactive routing.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/WindowRouteParameter.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.gui;
import java.util.Collection;
/**
* Window handling parameters of the eu.mihosoft.freerouting.interactive routing.
* Window handling parameters of the interactive routing.
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/WindowSelectParameter.java
View File

@ -27,7 +27,7 @@ import eu.mihosoft.freerouting.board.ItemSelectionFilter;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Window for the handling of the eu.mihosoft.freerouting.interactive selection parameters,
* Window for the handling of the interactive selection parameters,
*
* @author Alfons Wirtz
*/

2
src/main/java/eu/mihosoft/freerouting/gui/WindowSnapshot.java
View File

@ -26,7 +26,7 @@ package eu.mihosoft.freerouting.gui;
import eu.mihosoft.freerouting.logger.FRLogger;
/**
* Window handling snapshots of the eu.mihosoft.freerouting.interactive situation.
* Window handling snapshots of the interactive situation.
*
* @author Alfons Wirtz
*/

4
src/main/java/eu/mihosoft/freerouting/gui/WindowSnapshotSettings.java
View File

@ -25,7 +25,7 @@
package eu.mihosoft.freerouting.gui;
/**
* Window for the settinngs of eu.mihosoft.freerouting.interactive snapshots.
* Window for the settings of interactive snapshots.
*
* @author Alfons Wirtz
*/
@ -85,7 +85,7 @@ public class WindowSnapshotSettings extends BoardSavableSubWindow
main_panel.add(separator, gridbag_constraints);
// add check box for the eu.mihosoft.freerouting.interactive state
// add check box for the interactive state
this.interactive_state_check_box = new javax.swing.JCheckBox(resources.getString("interactive_state"));
gridbag.setConstraints(interactive_state_check_box, gridbag_constraints);

4
src/main/java/eu/mihosoft/freerouting/gui/WindowVia.java
View File

@ -29,7 +29,7 @@ import eu.mihosoft.freerouting.rules.BoardRules;
import eu.mihosoft.freerouting.board.Layer;
/**
* Window for eu.mihosoft.freerouting.interactive editing of via rules.
* Window for interactive editing of via rules.
*
* @author Alfons Wirtz
*/
@ -134,7 +134,7 @@ public class WindowVia extends BoardSavableSubWindow
this.rule_list_model.addElement(curr_rule);
}
// Add buttons to edit the via eu.mihosoft.freerouting.rules.
// Add buttons to edit the via rules.
javax.swing.JPanel via_rule_button_panel = new javax.swing.JPanel();
via_rule_button_panel.setLayout(new java.awt.FlowLayout());
this.add(via_rule_button_panel,java.awt.BorderLayout.SOUTH);

Some files were not shown because too many files have changed in this diff Show More