com.esri.arcgis.geodatabase
Interface ITinEditErrorLog

All Superinterfaces:
Serializable
All Known Implementing Classes:
Tin

public interface ITinEditErrorLog
extends Serializable

Provides access to TIN's internal edit errors.

Description

This interface is used to catch and report problems that may occur when inserting geometry into a triangulation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux


Method Summary
 void clearEditErrorLog()
          Clears existing error log contents.
 String getCurrentObjectClassName()
          Name representing a group of shapes to be added/edited.
 int getCurrentObjectID()
          ID of the shape to be added/edited.
 int getEditErrorCount()
          The number of errors.
 void saveEditErrorLog(String fileName)
          Saves error log contents to a file.
 void setCurrentObjectClassName(String pName)
          Name representing a group of shapes to be added/edited.
 void setCurrentObjectID(int pID)
          ID of the shape to be added/edited.
 

Method Detail

clearEditErrorLog

void clearEditErrorLog()
                       throws IOException,
                              AutomationException
Clears existing error log contents.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

saveEditErrorLog

void saveEditErrorLog(String fileName)
                      throws IOException,
                             AutomationException
Saves error log contents to a file.

Description

Saves a log file containing information about errors encountered while triangulating. If EditErrorCount is greater than zero at the end of an edit session call SaveEditErrorLog to write out a report.

filename is the location where to write the log file.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
fileName - The fileName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEditErrorCount

int getEditErrorCount()
                      throws IOException,
                             AutomationException
The number of errors.

Description

The number of errors encountered while modifying the triangulation.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pcErrors
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentObjectClassName

void setCurrentObjectClassName(String pName)
                               throws IOException,
                                      AutomationException
Name representing a group of shapes to be added/edited.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pName - The pName (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentObjectClassName

String getCurrentObjectClassName()
                                 throws IOException,
                                        AutomationException
Name representing a group of shapes to be added/edited.

Description

The ObjectClass of geometry associated with a triangulation error. You can set this value to be anything meaningful to you like the name of the source featureclass of the geometry.

If you're adding shapes with ITinEdit.AddShape or ITinEdit.AddShapeZ and an error is raised with a code of:

E_TIN_INTERNAL_ERROR

some form of error was encountered during triangulation. In the rare case an error occurs, it's usually failure to enforce some part of a breakline. In your error handler you can trap for this error code, record the source of geometry in the CurrentObjectClass property (e.g. featureclass name), along with an ID code in CurrentObjectID (e.g. OID), and continue on.

At the end of the edit session your code can check EditErrorCount and if errors exist call SaveEditErrorLog to persist the information to a log file on disk. The ObjectClass and ObjectID you recorded for each instance of an error will be written out along with coordinates identifying the problem locations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCurrentObjectID

void setCurrentObjectID(int pID)
                        throws IOException,
                               AutomationException
ID of the shape to be added/edited.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Parameters:
pID - The pID (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCurrentObjectID

int getCurrentObjectID()
                       throws IOException,
                              AutomationException
ID of the shape to be added/edited.

Description

The ID of geometry associated with a triangulation error. You can set this value to be anything meaningful to you like the OID of a feature or the iteration number of a loop.

If you're adding shapes with ITinEdit.AddShape or ITinEdit.AddShapeZ and an error is raised with a code of:

E_TIN_INTERNAL_ERROR

some form of error was encountered during triangulation. In the rare case an error occurs, it's usually failure to enforce some part of a breakline. In your error handler you can trap for this error code, record the source of geometry in the CurrentObjectClass property (e.g. featureclass name), along with an ID code in CurrentObjectID (e.g. OID), and continue on.

At the end of the edit session your code can check EditErrorCount and if errors exist call SaveEditErrorLog to persist the information to a log file on disk. The ObjectClass and ObjectID you recorded for each instance of an error will be written out along with coordinates identifying the problem locations.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Returns:
The pID
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.