com.sun.electric.tool.user.tecEdit
Class TechConversionResult

java.lang.Object
  extended by com.sun.electric.tool.user.tecEdit.TechConversionResult
All Implemented Interfaces:
java.io.Serializable

public class TechConversionResult
extends java.lang.Object
implements java.io.Serializable

Class to define error messages that arise during technology creation. This class is necessary because errors occur during Jobs, but the display of the errors must be done on the client side. Therefore, objects of this class are passed from the server to the client for display.

See Also:
Serialized Form

Constructor Summary
TechConversionResult()
           
 
Method Summary
 boolean failed()
          Method to return the success status.
 java.lang.String getErrorMessage()
          Method to return the error message associated with this conversion.
 void markError(NodeInst ni, Cell cell, java.lang.String errorMessage)
          Method to mark a general error.
 void markStretchProblem(java.util.List<Example> neList, Sample ns, Cell cell, double sampleCoord, boolean xDir)
          Method to mark an error in determining stretching rules.
 void showError()
          Method to highlight the error.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TechConversionResult

public TechConversionResult()
Method Detail

failed

public boolean failed()
Method to return the success status.

Returns:
true if the conversion failed.

markError

public void markError(NodeInst ni,
                      Cell cell,
                      java.lang.String errorMessage)
Method to mark a general error.

Parameters:
ni - the NodeInst that caused the error (may be null).
cell - the Cell where the error occurred (may be null).
errorMessage - the message to display.

markStretchProblem

public void markStretchProblem(java.util.List<Example> neList,
                               Sample ns,
                               Cell cell,
                               double sampleCoord,
                               boolean xDir)
Method to mark an error in determining stretching rules.

Parameters:
neList - the Examples that invoked the error.
ns - the Sample on the main Example that failed.
cell - the Cell with the error.
sampleCoord - the coordinate (in X or Y) where the failure occurred.
xDir - true for an X-axis error, false for Y-axis.

getErrorMessage

public java.lang.String getErrorMessage()
Method to return the error message associated with this conversion.

Returns:
the error message associated with this conversion.

showError

public void showError()
Method to highlight the error.