Generic |
public abstract class GenericBase : IDisposable, IParentInformation
The GenericBase type exposes the following members.
| Name | Description | |
|---|---|---|
| GenericBase | Initializes a new instance of the GenericBase class |
| Name | Description | |
|---|---|---|
| ConnectedIpList | A property containing the list of the ConnectedIpInformation objects which contain information about the devices that are connected to this IP ID. This property is only valid for an ethernet device. If this is not an ethernet device, then this property will return null. If this is an ethernet device, the list will be non-null. It will be empty if no devices are connected. The order of items in this list is not guaranteed. | |
| Description | Get/Set the description of this device. | |
| Disposed | Property to indicate if the device has been disposed. | |
| ID | Property to get the ID of the device. | |
| IsOnline | Property to get the current online state of the device. | |
| Name | Get the name of this device. | |
| Parent | The parent that a given object was added to. | |
| Registerable | Property to indicate that this device can be registered. | |
| Registered | Property to get the current registration state of the device. | |
| RegistrationFailureReason | Property to get the Registration Failure Reason, this will match the return value from the call to register. | |
| SIMPLDeviceImplementation | Internal protected member used for actual device control. | |
| Type | Property to determine to type of device this is. | |
| UnRegistrationFailureReason | Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister. | |
| UserSpecifiedObject | Can be assigned anything that user wants. |
| Name | Description | |
|---|---|---|
| Dispose | Clean up of resources. | |
| Dispose(Boolean) | Method to perform the actual disposing of the device. | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) | |
| GetHashCode | Serves as the default hash function. (Inherited from Object) | |
| GetType | Gets the Type of the current instance. (Inherited from Object) | |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) | |
| OnBaseEvent(Int32) | Protected member used to fire the BaseEvent with the default extended information. | |
| OnBaseEvent(Int32, UInt16) | Protected member used to fine the BaseEvent with extended event information. | |
| Register | Register this device with the system. | |
| ToString | Returns a string that represents the current object. (Inherited from Object) | |
| UnRegister |
Unregister this device with the system. This function can not be called from the device's own SigChange event handler.
On successful unregistration, if this device supports the OnlineStatusChange event, it will trigger indicating the device when offline. |
| Name | Description | |
|---|---|---|
| BaseEvent | Generic base event, triggered when the there are no other handlers available for a specific EventID. | |
| IpInformationChange | Event that tells what IP Address is connected/disconnected from an IP ID for a non-UDP device. This is only valid for an Ethernet device. An exception will be thrown if it is not. | |
| OnlineStatusChange | Event triggered when the Online status of the device changes. |