Generic |
public class GenericDevice : GenericBase
The GenericDevice type exposes the following members.
| Name | Description | |
|---|---|---|
| GenericDevice | Constructor for the base 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.
(Overrides GenericBaseConnectedIpList) | |
| Description |
Get/Set the description of this device.
(Inherited from GenericBase) | |
| Disposed |
Property to indicate if the device has been disposed.
(Overrides GenericBaseDisposed) | |
| ID |
Property to get the ID of the device.
(Overrides GenericBaseID) | |
| IsOnline |
Property to get the current online state of the device.
(Overrides GenericBaseIsOnline) | |
| Name |
Get the name of this device.
(Inherited from GenericBase) | |
| Parent |
The parent that a given object was added to.
(Inherited from GenericBase) | |
| Registerable |
Property to indicate that this device can be registered.
(Overrides GenericBaseRegisterable) | |
| Registered |
Property to get the current registration state of the device.
(Overrides GenericBaseRegistered) | |
| RegistrationFailureReason |
Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Overrides GenericBaseRegistrationFailureReason) | |
| SIMPLDeviceImplementation |
Internal protected member used for actual device control.
(Overrides GenericBaseSIMPLDeviceImplementation) | |
| Type |
Property to determine to type of device this is.
(Overrides GenericBaseType) | |
| UnRegistrationFailureReason |
Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Overrides GenericBaseUnRegistrationFailureReason) | |
| UserSpecifiedObject |
Can be assigned anything that user wants.
(Inherited from GenericBase) | |
| XioEndpointStubSIMPLDevice | The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy. |
| Name | Description | |
|---|---|---|
| Dispose |
Clean up of resources.
(Inherited from GenericBase) | |
| Dispose(Boolean) |
Method to perform the actual disposing of the device.
(Overrides GenericBaseDispose(Boolean)) | |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) | |
| Finalize |
Destructor of the device.
(Overrides ObjectFinalize) | |
| 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.
(Inherited from GenericBase) | |
| OnBaseEvent(Int32, UInt16) |
Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase) | |
| Register |
Register this device with the system.
(Overrides GenericBaseRegister) | |
| ToString |
Return the name of the device.
(Overrides ObjectToString) | |
| 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. (Overrides GenericBaseUnRegister) |
| Name | Description | |
|---|---|---|
| BaseEvent |
Generic base event, triggered when the there are no other handlers available
for a specific EventID.
(Inherited from GenericBase) | |
| 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.
(Overrides GenericBaseIpInformationChange) | |
| OnlineStatusChange |
Event triggered when the Online status of the device changes.
(Overrides GenericBaseOnlineStatusChange) |