Click or drag to resize

GlExpClxDimBase Class

Base class for the GL-EXP and CLX-DIMU devices
Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpProGenericBase
    Crestron.SimplSharpProGenericDevice
      Crestron.SimplSharpPro.DeviceSupportGlExpClxDimBase
        Crestron.SimplSharpPro.LightingClxBase
        Crestron.SimplSharpPro.LightingGlExpBase

Namespace: Crestron.SimplSharpPro.DeviceSupport
Assembly: Crestron.SimplSharpPro.DeviceSupport (in Crestron.SimplSharpPro.DeviceSupport.dll) Version: 2.21.121
Syntax
C#
public class GlExpClxDimBase : GenericDevice, 
	ILightLoadOverrideControl

The GlExpClxDimBase type exposes the following members.

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.
(Inherited from GenericDevice)
Public propertyCode exampleDescription Get/Set the description of this device.
(Inherited from GenericBase)
Public propertyDimmingLoad Collection for the Dimming load with override.
Public propertyDisposed Property to indicate if the device has been disposed.
(Inherited from GenericDevice)
Public propertyEnableSerialDebug Enables serial debugging. Outputs to the DimmingLoadDebug class
Public propertyID Property to get the ID of the device.
(Inherited from GenericDevice)
Public propertyInExternalOverrideFeedback Indicates if the device is in external override mode

The OverrideEventHandler event will trigger with External.

Public propertyInManualOverrideFeedback Indicates if the device is in manual override mode

The OverrideEventHandler event will trigger with Manual.

Public propertyIsOnline Property to get the current online state of the device.
(Inherited from GenericDevice)
Public propertyName Get the name of this device.
(Inherited from GenericBase)
Public propertyParent The parent that a given object was added to.
(Inherited from GenericBase)
Public propertyRegisterable Property to indicate that this device can be registered.
(Inherited from GenericDevice)
Public propertyRegistered Property to get the current registration state of the device.
(Inherited from GenericDevice)
Public propertyRegistrationFailureReason Property to get the Registration Failure Reason, this will match the return value from the call to register.
(Inherited from GenericDevice)
Protected propertySIMPLDeviceImplementation Internal protected member used for actual device control.
(Inherited from GenericDevice)
Public propertyType Property to determine to type of device this is.
(Inherited from GenericDevice)
Public propertyUnRegistrationFailureReason Property to get the Unregistration Failure Reason, this will match the return value from the call to unregister.
(Inherited from GenericDevice)
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
(Inherited from GenericBase)
Protected propertyXioEndpointStubSIMPLDevice The SIMPL "stub" Device that the XiO Director creates for an endpoint to send the 1C/0E to the correct place in hierarchy.
(Inherited from GenericDevice)
Top
Methods
 NameDescription
Public methodDispose Clean up of resources.
(Inherited from GenericBase)
Protected methodDispose(Boolean) Method to perform the actual disposing of the device.
(Inherited from GenericDevice)
Public methodEnterManualOverride Enter manual override mode
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodExitManualOverride Exit manual override mode
Protected methodFinalize Destructor of the device.
(Inherited from GenericDevice)
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.
(Inherited from GenericBase)
Protected methodOnBaseEvent(Int32, UInt16) Protected member used to fine the BaseEvent with extended event information.
(Inherited from GenericBase)
Public methodRegister Register this device with the system.
(Inherited from GenericDevice)
Public methodToString Return the name of the device.
(Inherited from GenericDevice)
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.


(Inherited from GenericDevice)
Top
Events
 NameDescription
Public eventBaseEvent Generic base event, triggered when the there are no other handlers available for a specific EventID.
(Inherited from GenericBase)
Public eventDimmingLoadStateChange Event triggered when information from a load is received. EventIds for this event are located in GlExpClxDimBase class.
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.
(Inherited from GenericDevice)
Public eventOnlineStatusChange Event triggered when the Online status of the device changes.
(Inherited from GenericDevice)
Public eventOverrideEventHandler Override event handler EventIds for this event are located in eOverrideEvents.
Top
Fields
 NameDescription
Public fieldStatic memberDimmingCurveEventId Dimming curve feedback has changed
Public fieldStatic memberDimmingLevelEventId Dim level feedback has changed
Public fieldStatic memberDimmingLoadErrorEventId Error feedback has changed
Public fieldStatic memberDimmingLoadTypeEventIdObsolete.
No longer supported.
Public fieldStatic memberDimmingPhaseControlEventId Phase control of the load has changed
Public fieldStatic memberDimmingSerialDebugEventId Serial debug feedback has changed
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also