Pinchot C# Error Handling API

This high level document covers the main objects, methods, and properties related to error handling when using the Pinchot C# API. Exception handling, status checking, and identifying invalid data conditions are essential.

---

High-Level Overview

The Pinchot C# API provides multiple layers of error detection and handling:

1. Exceptions - Thrown for critical errors that prevent normal operation
2. Status Properties and Methods - Allow checking the current state of system components
3. Data Validation - Methods to verify the integrity of acquired scan data
4. Connection Health - Tools to monitor and validate network connectivity

Proper error handling ensures robust applications that can gracefully handle hardware issues, network problems, and invalid configurations.

---

Relevant API Calls

Exceptions

• VersionCompatibilityException - ScanHead is not compatible with the operation being performed
• ArgumentException - Invalid parameter values
• InvalidOperationException - Operations called in wrong state
• ArgumentNullException - Invalid parameter values
• ArgumentOutOfRangeException - Invalid parameter values
• IOException - Network communication errors
• WebException - Errors related to REST calls to ScanHead

ScanSystem

• ScanSystem.IsConnected - Overall system connection state
• ScanSystem.IsScanning - Current scanning operation status
• ScanSystem.ScanHeads - Collection of discovered scan heads
• ScanSystem.Connect - If there is a problem, the Connect method could throw a variety of exceptions

ScanHead

• ScanHead.RequestStatus - Current operational status
• ScanHead.IsConnected - Connection state
• ScanHeadStatus - ScanHead status object

ScanSync

• ScanSyncData - ScanSync data object

IProfile

• IProfile.PacketsExpected - Number of packets expected
• IProfile.PacketsReceived - Number of packets received
• Profile.HasValidData - Check for meaningful scan data
• IProfile.ValidPointCount - Count of points with valid ata
• IProfile.GetValidXYPoints - Get valid XY points