Click or drag to resize

ClsC6xBaseClsC6SceneProgramming Class

Scene Programming class for ClsC6xBase.

This class will trigger SceneProgrammingStateChange event.

Inheritance Hierarchy
SystemObject
  Crestron.SimplSharpPro.LightingClsC6xBaseClsC6SceneProgramming

Namespace: Crestron.SimplSharpPro.Lighting
Assembly: Crestron.SimplSharpPro.Lighting (in Crestron.SimplSharpPro.Lighting.dll) Version: 2.21.121
Syntax
C#
public sealed class ClsC6SceneProgramming : IParentInformation

The ClsC6xBaseClsC6SceneProgramming type exposes the following members.

Properties
 NameDescription
Public propertyDecrementFadeTime Property to decrement the fade time. The fade time is the time it takes for all the lights in the scene to reach their target levels. The fade time will decrement within a range of 99 minutes to 1 minute, and then 59 seconds to 0 seconds. If this property value is true for longer than 0.5 seconds, the fade time will auto-decrement until this property value changes to false or until the fade time reaches 0 seconds.
Public propertyFadeTimeFeedback Property to report the fade time in minutes or seconds.

This property will trigger SceneProgrammingStateChange event with FadeTimeFeedbackEventId.

Public propertyFadeTimeInMinutesFeedback Property to indicate that the fade time is in minutes when the property value is true, and seconds when the value is false.

This property will trigger SceneProgrammingStateChange event with FadeTimeInMinutesEventId.

Public propertyIncrementFadeTime Property to increment the fade time. The fade time is the time it takes for all the lights in the scene to reach their target levels. The fade time will increment within a range of 0 seconds to 59 seconds, and then from 1 minute to 99 minutes. If this property value is true for longer than 0.5 seconds, the fade time will auto-increment until the property value changes to false or until the maximum fade time (99 minutes) is reached.
Public propertyInSetupModeFeedback Property to indicate that the CLS-C6 is in local setup mode. This locks out all the properties in the Scene Programming class.

This property will trigger SceneProgrammingStateChange event with InSetupModeEventId.

Public propertyLightingLoadProgramming Lighting Load Scene Programming objects collection.

This property will trigger SceneProgrammingStateChange event with event IDs defined in ClsC6xBase for lighting load.

Public propertyParent Parent for ClsC6xBaseClsC6SceneProgramming class.
Public propertyProgrammedScene Property to set the current scene that will be programmed when scene programming is activated (when ProgramSceneByNumber method is called). The scene number must be set before activating scene programming. Any change in the scene number/type will be ignored during scene programming.
Public propertyProgrammedSceneFeedback Property to report the actual scene currently being programmed.

This property will trigger SceneControlChange event with SceneNumberFeedbackEventId.

Public propertyProgrammingSceneFeedback Property to indicate that the scene programming is active.

This property will trigger SceneProgrammingStateChange event with ProgrammingSceneEventId.

Public propertySceneLockedFeedback Property to indicate that the current scene is locked, meaning that the local buttons on the CLS-C6 are locked out from adjusting the lights, shades or fade times.

This property will trigger SceneProgrammingStateChange event with SceneLockedEventId.

Public propertyShadeGroupProgramming Shade Group Scene Programming objects collection.

This property will trigger SceneProgrammingStateChange event with event IDs defined in ClsC6xBase for shade group load

.
Public propertyUserSpecifiedObject Can be assigned anything that user wants.
Top
Methods
 NameDescription
Public methodCancel Method to cancel the scene programming and restores the specified ProgrammedScene to the original values. This will exit scene programming and drive all feedback outputs to 0.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodLockScene Method to turn on the "locked" setting for the selected ProgrammedScene. This means that when the scene is saved, the local buttons on the CLS-C6 will be locked out from adjusting the lights, shades, or fade times.
Public methodProgramSceneByNumber Method to enable the scene specified in ProgrammedScene to be programmed. This enables properties in the LDimmingLoad, ShadeGroups and ClsC6xBaseClsC6Dimming classes for scene programming, and locks out all other properties. When scene programming is enabled, the CLS-C6 will recall the specified ProgrammedScene (with no fade time). In addition, the properties ProgrammedSceneFeedback, FadeTimeFeedback will be updated and reports the affected lights and shades. A call to Save or Cancel will save or cancel the current settings and sets this property value to false, thus exiting scene programming. A second call to this method while scene programming is active will re-start scene programming using the current ProgrammedScene.
Public methodQuickSave Method to enable the following steps to modify a scene: Recall a scene Optionally modify some scene levels Save new levels to the current scene or any other scene
Public methodSave Method to save the current light levels, shade positions and "locked" status into the scene specified in the ProgrammedScene.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Public methodUnlockScene Method to turn off the "locked" setting for the selected ProgrammedScene. This means that when the scene is saved, the local buttons on the CLS-C6 can control the lights, shades, and fade times. This means that when the scene is saved, the local buttons on the CLS-C6 can control the lights, shades, and fade times.
Top
Events
 NameDescription
Public eventSceneProgrammingStateChange Event triggered when a feedback has changed for this ClsC6xBaseClsC6SceneProgramming. EventIds for this event are located in the ClsC6xBase class.
Top

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also