Click or drag to resize

GenericBase Class

Base class for devices in SIMPL# Pro.
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice

Namespace: Crestron.SimplSharpPro
Assembly: SimplSharpPro (in SimplSharpPro.dll) Version: 2.21.121
Syntax
C#
public abstract class GenericBase : IDisposable, 
	IParentInformation

The GenericBase type exposes the following members.

Constructors
 NameDescription
Protected methodGenericBaseInitializes a new instance of the GenericBase class
Top
Properties
 NameDescription
Public propertyConnectedIpList 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.
Public propertyCode exampleDescription Get/Set the description of this device.
Public propertyDisposed Property to indicate if the device has been disposed.
Public propertyID Property to get the ID of the device.
Public propertyIsOnline Property to get the current online state of the device.
Public propertyName Get the name of this device.
Public propertyParent The parent that a given object was added to.
Public propertyRegisterable Property to indicate that this device can be registered.
Public propertyRegistered Property to get the current registration state of the device.
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
Public propertyType Property to determine to type of device this is.
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Protected methodOnBaseEvent(Int32) Protected member used to fire the BaseEvent with the default extended information.
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
Public methodRegister Register this device with the system.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUnRegister 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.

Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
Public eventIpInformationChange 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.
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also