Client |
Defines the API available to SP-ICE-3 Card client applications.
It encapsulates in particular:
- Communications handling.
- Command List handling.
- Laser and Scan Head configuration.
- Command List Execution control.
- Status and Error reporting.
Inheritance HierarchySystemObject
RAYLASE.SPICE3.ClientLibClientAPI
RAYLASE.SPICE3.ClientLibClientAPI
Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.6.0
SyntaxC#
public class ClientAPI : IDisposable
The ClientAPI type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ClientAPI | Initializes a new instance of the ClientAPI class. |
| ClientAPI(CardInfo) | Create a new ClientAPI instance with a connection to the card at the address contained in the given cardInfo. |
| ClientAPI(String, Int32) | Create a new ClientAPI instance with a connection to the card at the given cardAddress. |
Properties| Name | Description | |
|---|---|---|
 | AdapterBoard | Provides access to AdapterBoard handling operations. |
| Address | Get the address of the current remote endpoint if connected. |
| Configuration | Provides access to Configuration operations. |
| Connected | Gets a flag indicating whether this instance has an active (open) connection to the card. |
| Font | Provides access to Font handling operations. |
| Gpio | Provides access to GPIO handling operations. |
| HeadCorrection | Provides access to HeadCorrection operations. |
| Laser | Provides access to Laser handling operations. |
| List | Provides access to List handling operations. |
| Motf | Provides access to MOTF operations. |
| PowerCorrection | Provides access to PowerCorrection operations. |
| Process | Provides access to Process Variable handling operations. |
| Scanner | Provides access to Scanner operations. |
| ScannerCommunication | Provides access to ScannerCommunication operations. |
| SerialPort | Provides access to the Serial Port operations. |
| Sfio | Provides access to the SFIO (Special-Function-Input-Output) operations. |
| System | Provides access to System operations. |
| Timeout | Gets or sets the amount of time in milliseconds that elapsed before a timeout error is generated |
| Variables | Provides access to variable handling operations. |
Methods| Name | Description | |
|---|---|---|
| Connect(CardInfo) | Connects to the card identified by card. |
| Connect(String, Int32) | Connects to the card identified by its hostNameOrAddresshostname or IPAddress. |
| DisableLog | Deactivates logging the communication between this client connection and the card. |
| Disconnect | Disconnects this instance from the currently connected card. |
 | Discover | Discovers cards on the network using the UPnP SSDP protocol, and returns a list of those discovered. |
| DiscoverByPinging | Discovers cards on the network by pinging the card's expected IP address based on its serial number, and returns a list of those discovered. |
| Dispose | Close all open connections and dispose. |
| EnableLog(String, Int32) | Activates logging the communication between this client connection and the card. |
| EnableLog(TextWriter, Int32, Boolean) | Activates logging the communication between this client connection and the card. |
| PredictIPAddressFromSerialNumber | Predicts the card's IP address from its serial number. |
Fields| Name | Description | |
|---|---|---|
 | DefaultPort | Indicates the default TCP port of the Spice3 interface. |
See Also