RAYLASE. |
Contains definitions used in common by the SP-ICE-3 Client Library and the Card's Firmware.
Classes| Class | Description | |
|---|---|---|
 | AbortedException | Execution has been aborted, either due to a hardware signal, or programmatically. |
| AdapterBoardConfig | Configuration used to describe and set up an adapter board. Nearly, all properties will be stored externally on the board's EERPOM if available./> |
| AxisParameterSet | Settings of one axis |
| BadResponseException | Thrown when a bad response is received on the serial port. This can happen when using SERIAL_PORT_TRANSCEIVE etc. |
| Command | Represents a SP-ICE-3 command and its parameters. |
| CommandValue | Provides static functions and extensions to CommandValueType and CommandValueTypeAcronym. |
| ConfigBase | Abstract base class for all configurations: uses an integer version number. |
| ConfigSet | Container for a collection of configurations. |
| CorrectionFile | Allows creating and accessing correction files. |
| EventConfig | Container for event configuration parameters. |
| EventStatus | Container for configuring one event |
| ExecutionException | An unexpected error condition has occurred during command execution. |
| FatalException | An unrecoverable error condition has occurred during command execution. |
| Font | Holds the definition of a font for use on the SP-ICE-3 Card. |
| GpioConfig | A collection of individual I/O Port configurations. |
| InitializationException | An unexpected error condition has occurred during initialization of the card. |
| InverseCorrection | Holds the inverse of a CorrectionFile. |
| IOPinMapping | Describes the available mappings for a single I/O pin. |
| JumpAndShootItemT | A single Pixel inside a JumpAndShoot path |
| LaserConfig | Container for laser source configuration parameters. |
| ListException | An error occurred while generating or parsing a List. |
| ListExecutionException | List execution could not be completed due to an error. |
| ListExecutionStats | Container for list execution statistics. |
| ListLabelException | The Label is not valid within the List. |
| ListNotFoundException | The specified ListID could not be found during List execution. |
| MotfConfig | Configuration Parameters for Mark-On-The-Fly. |
| MotfSource | Selects source types and modules for Motf. |
| NotConnectedException | An attempt was made to communicate with a card for which no network connection is currently established. |
| OpticalParameters | Parameters used when generating the Field Distortion Correction File for a scan head. |
| OutOfFieldException | At least one of the axes has exceeded the limits of the field, after applying all transformations and field corrections. |
| PortConfig | The complete configuration data of a single I/O Port. |
| Positions | Container that holds the coordinates of the last position that was processed by the card including all intermediate coordinates from the different calculation and transformation steps. |
| PowerOverflowException | Thrown when a power overflow occurs. This can happen when using PowerCorrection/VelocityCorrection. |
| ProcessVariables | Container for process variables. |
| QuadratureDecoderConfig | Container for the QuadratureDecoderModules, which can be used as MotF sources. |
| QuadratureDecoderModule | QuadratureDecoder module that can be used with MotF |
| RawCommand | |
| ScanHeadConfig | Container for scan head configuration parameters. |
| ScannerCommunicationException | A problem occurred during communications with the scanners. |
| ScannerConfig | Container for scanner configuration parameters. |
| ScannerInfo | Extra scanner information that can be optionally included into the correction file |
| ScannerMonitoringConfig | Specifies the monitoring configuration for the scanhead(s). |
| ScannerMonitoringException | Scanner monitoring error has occurred. |
| SerialPortConfig | Container for serial port configuration parameters. |
| SkyWritingSettings | Settings used for sky writing. |
| Spice3AppException |
The generic exception used for reporting problems from the "firmware" (RTB) back to the ClientLib.
Remarks Exceptions thrown inside the RTB are caught by the JSON-RPC layer, which then wraps them in a Spice3AppExecption before serializing them for transmission to the ClientLib.
The ClientLib then de-serializes the Spice3AppException, and throws it forwards. |
| Spice3CommandList | |
| SpiConfig | Container for SPI (serial peripheral interface) configuration parameters. |
| SpiModule | Configuration for a single SPI-Module. |
| SupportedConfigVersion | Helper to get the supported version of a configuration. |
| SystemConfig | Container for system configuration parameters. |
| TimeZone | Represents a timezone used for the SP-ICE-3 card timezone settings. |
| TraceBufferConfig | Container for traceBuffer configuration parameters. |
| TraceBufferConfig0 | Container for configuration settings of traceBuffer IO Events in TB register 0. |
| TraceBufferConfig1 | Container for configuration settings of traceBuffer Position Events in TB register 1. |
| TraceBufferConfig2 | Container for configuration settings of traceBuffer Power Events in TB register 2. |
| TraceBufferConfig3 | Container for configuration settings of traceBuffer Control Events in TB register 3. |
| VersionMismatchException | There is mis-match between ClientLib and Card Firmware version, or between Card Firmware and Adapter Board Firmware versions. |
| WaitTimeoutException | Thrown when a power overflow occurs. This can happen when using PowerCorrection/VelocityCorrection. |
| WobbleSettings | Settings for configuration of the wobble feature |
| XForm | Transformation matrix |
Interfaces| Interface | Description | |
|---|---|---|
 | IConfig | Configuration interface |
Enumerations| Enumeration | Description | |
|---|---|---|
 | Axes | Used to select a set of one or more scanner axes. |
| Axis | Selector values for individual scanner axes. |
| CardDisposition | Card installation locations. |
| CommandCode | These are the names of the currently implemented command codes for the SP-ICE-3 Card. |
| CommandCodeAcronym | These are the compact symbolic names of the native command codes which the SP-ICE-3 card understands. |
| CommandValueType | Payload types of transmitted command parameters. |
| CommandValueTypeAcronym | Contains acronyms for CommandValueTypes. |
| ConfigSection | Selector for configuration(s) inside in a ConfigSet. |
| DataSource | Selector for the SPI output source. |
| EventType | The configurable event-types. |
| FatalExceptionError | Indicates the underlying error condition of a fatal exception. |
| IODirection | The available I/O directions. |
| IOPort | Selector values for the I/O Ports. |
| IOVoltage | Available logic voltage levels: for PortA and PortB only. |
| LaserSignal | Laser signal identifiers. |
| LaserStatus | Laser status identifiers. |
| LAYERS | Number of layers for 3D correction files |
| ListStatus | These are the symbolic names of the status for lists on the card. |
| MotfDistanceMode | Modes for measuring the distance. |
| MotfOperatingMode | Modes for operating mark-on-the-fly. |
| MotfSourceType | Type of source that is used for the MainSource and the CompensationSource |
| OperatingState | Symbolic names for operating state of the card's firmware. |
| Order | Byte order. |
| PinAction | Defines how an associated mask-value is to be applied to a given set of I/O Pins. |
| Polarity | Logic polarities for GPIO Pins. |
| PowerChannels | Selector for Power Target Channels supported by the card. |
| PowerTarget | Power targets supported by the card. |
| ScanHeadFlags | Flags used to define the ScanHeadFormat |
| ScanHeadFormat | Available scanhead formats. |
| Sfr0Bits |
Bit masks for access to input signal states assigned to Sfr0.
Refer to 10.2 Special Function Registers for more details. |
| Sfr1Bits |
Bit masks for access to input signal states assigned to Sfr1.
Refer to 10.2 Special Function Registers for more details. |
| SfRegister |
Selector values for the Special Function Registers.
Refer to 10.2 Special Function Registers for more details. |
| SkyWritingMode | Specifies where sky-writing extension vectors should be generated. |
| SyncMode | Selector for SPI sync mode. |