FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kLight.h
Go to the documentation of this file.
1 
8 #ifndef K_FIRESYNC_LIGHT_H
9 #define K_FIRESYNC_LIGHT_H
10 
11 #include <kFireSync/kNodeDef.h>
12 
19 //typedef kObject kLight; --forward-declared in kFsDef.x.h
20 
31 kFsFx(kSize) kLight_Id(kLight light);
32 
41 kFsFx(kStatus) kLight_Clear(kLight light, kSize stateCount);
42 
51 kFsFx(kStatus) kLight_ClearAll(kLight light, kSize stateCount);
52 
64 kFsFx(kStatus) kLight_Enable(kLight light, kBool enable);
65 
73 kFsFx(kBool) kLight_IsEnabled(kLight light);
74 
86 kFsFx(kStatus) kLight_SetControl(kLight light, kLightControl type);
87 
95 kFsFx(kLightControl) kLight_Control(kLight light);
96 
105 kFsFx(kStatus) kLight_ControlInfo(kLight light, kInfoBits* info);
106 
118 kFsFx(kStatus) kLight_SetControlId(kLight light, k32u id);
119 
127 kFsFx(k32u) kLight_ControlId(kLight light);
128 
137 kFsFx(kStatus) kLight_ControlIdInfo(kLight light, kInfo* info);
138 
175 
184 
193 kFsFx(kStatus) kLight_PrimingModeInfo(kLight light, kInfoBits* info);
194 
229 
238 
247 kFsFx(kStatus) kLight_CouplingModeInfo(kLight light, kInfoBits* info);
248 
263 kFsFx(kStatus) kLight_SetIntensity(kLight light, k64f intensity);
264 
272 kFsFx(k64f) kLight_Intensity(kLight light);
273 
282 kFsFx(kStatus) kLight_IntensityInfo(kLight light, kInfo64f* info);
283 
302 kFsFx(kStatus) kLight_SetMask(kLight light, kLightMask mask);
303 
311 kFsFx(kLightMask) kLight_Mask(kLight light);
312 
321 kFsFx(kStatus) kLight_MaskInfo(kLight light, kInfoBits* info);
322 
334 kFsFx(kStatus) kLight_SetMaskId(kLight light, k32u id);
335 
343 kFsFx(k32u) kLight_MaskId(kLight light);
344 
353 kFsFx(kStatus) kLight_MaskIdInfo(kLight light, kInfo* info);
354 
367 kFsFx(kStatus) kLight_SetMaskPolarity(kLight light, kBool isActiveHigh);
368 
376 kFsFx(kBool) kLight_MaskPolarity(kLight light);
377 
386 kFsFx(kStatus) kLight_MaskPolarityInfo(kLight light, kInfoBool* info);
387 
403 kFsFx(kStatus) kLight_EnablePowerSaver(kLight light, kBool enabled);
404 
413 
423 
436 kFsFx(kStatus) kLight_SetMaxDutyCycle(kLight light, k64f dutyCycle);
437 
445 kFsFx(k64f) kLight_MaxDutyCycle(kLight light);
446 
455 kFsFx(kStatus) kLight_MaxDutyCycleInfo(kLight light, kInfo64f* info);
456 
475 kFsFx(kStatus) kLight_LockOut(kLight light, kBool shouldLock);
476 
484 kFsFx(kBool) kLight_IsLockedOut(kLight light);
485 
494 kFsFx(kStatus) kLight_LockedOutInfo(kLight light, kInfoBool* info);
495 
506 kFsFx(kStatus) kLight_AddState(kLight light, kLightState* state);
507 
516 kFsFx(kStatus) kLight_DeleteState(kLight light, kLightState state);
517 
527 kFsFx(kStatus) kLight_SwapStates(kLight light, kSize index0, kSize index1);
528 
536 kFsFx(kSize) kLight_StateCount(kLight light);
537 
546 kFsFx(kStatus) kLight_StateCountInfo(kLight light, kInfoSize* info);
547 
556 kFsFx(kLightState) kLight_StateAt(kLight light, kSize index);
557 
569 kFsFx(kStatus) kLight_AddExtension(kLight light, kType type, kLightExt* extension);
570 
579 kFsFx(kStatus) kLight_DeleteExtension(kLight light, kLightExt extension);
580 
588 kFsFx(kSize) kLight_ExtensionCount(kLight light);
589 
598 kFsFx(kLightExt) kLight_ExtensionAt(kLight light, kSize index);
599 
609 kFsFx(k64u) kLight_MinimumPeriod(kLight light);
610 
625 kFsFx(kStatus) kLight_SetOutputState(kLight light, kBool state);
626 
635 kFsFx(kStatus) kLight_Stats(kLight light, kLightStats* stats);
636 
644 kFsFx(kStatus) kLight_Trigger(kLight light);
645 
660 kFsFx(kStatus) kLight_Override(kLight light, const kLightOverrideItem* overrides, kSize count);
661 
662 #include <kFireSync/Client/kLight.x.h>
663 
664 #endif
kSize kLight_Id(kLight light)
Gets the id of the light module.
kStatus kLight_SetOutputState(kLight light, kBool state)
Sets output state of the light in SetBySoftware mode.
kStatus kLight_MaskInfo(kLight light, kInfoBits *info)
Reports constraint and validity information for the Mask setting.
kStatus kLight_SwapStates(kLight light, kSize index0, kSize index1)
Swaps the order of two states in the light's state list.
k64f kLight_Intensity(kLight light)
Gets the intensity associated with this light.
kStatus kLight_Trigger(kLight light)
Provides a software trigger to a light.
Represents light override item.
Definition: kNodeDef.h:979
kStatus kLight_StateCountInfo(kLight light, kInfoSize *info)
Reports constraint and validity information for the StateCount setting.
kStatus kLight_AddExtension(kLight light, kType type, kLightExt *extension)
Creates and adds a new light control extension of the specified type.
kStatus kLight_MaskPolarityInfo(kLight light, kInfoBool *info)
Reports constraint and validity information for the MaskPolarity setting.
k64u kLight_MinimumPeriod(kLight light)
Reports the time required by this light to respond to an event.
kStatus kLight_ControlIdInfo(kLight light, kInfo *info)
Reports constraint and validity information for the ControlId setting.
k64f kLight_MaxDutyCycle(kLight light)
Gets the maximum light duty cycle setting.
kLightExt kLight_ExtensionAt(kLight light, kSize index)
Gets the control extension at the specified index.
kStatus kLight_AddState(kLight light, kLightState *state)
Creates and adds a new state with default values.
Represents a light state configuration.
Represents constraint and validity information for a bit flag setting.
Definition: kInfo.h:544
kStatus kLight_Enable(kLight light, kBool enable)
Enables or disables the light.
Represents light coupling mode.
kStatus kLight_SetMaskPolarity(kLight light, kBool isActiveHigh)
Sets the light mask polarity.
kStatus kLight_MaskIdInfo(kLight light, kInfo *info)
Reports constraint and validity information for the MaskId setting.
kLightMask kLight_Mask(kLight light)
Reports the light mask source type.
kLightPrimingMode kLight_PrimingMode(kLight light)
Reports the light priming mode.
Represents constraint and validity information for a double setting.
Definition: kInfo.h:438
Represents light run-time statistics.
Definition: kNodeDef.h:1052
kStatus kLight_SetPrimingMode(kLight light, kLightPrimingMode mode)
Sets the light priming mode.
Essential declarations related to FireSync nodes.
kStatus kLight_Override(kLight light, const kLightOverrideItem *overrides, kSize count)
Provides a list of configuration overrides to modify live light behaviour.
kStatus kLight_SetMaskId(kLight light, k32u id)
Sets the light mask source id.
Represents light priming mode.
kLightState kLight_StateAt(kLight light, kSize index)
Gets the state at the specified index.
kStatus kLight_SetControl(kLight light, kLightControl type)
Sets the light control mode.
kStatus kLight_ClearAll(kLight light, kSize stateCount)
Resets light mode and device settings to defaults.
kStatus kLight_IntensityInfo(kLight light, kInfo64f *info)
Reports constraint and validity information for the Intensity setting.
k32u kLight_MaskId(kLight light)
Gets the light mask source id.
kStatus kLight_MaxDutyCycleInfo(kLight light, kInfo64f *info)
Reports constraint and validity information for the MaxDutyCycle setting.
kBool kLight_MaskPolarity(kLight light)
Gets the light mask polarity.
kStatus kLight_DeleteState(kLight light, kLightState state)
Destroys the specified state and removes it from the light's state list.
kBool kLight_IsEnabled(kLight light)
Reports whether the light is currently enabled.
kStatus kLight_Stats(kLight light, kLightStats *stats)
Gets light statistics.
Represents light configuration.
Represents light control modes.
kLightCouplingMode kLight_CouplingMode(kLight light)
Reports the light coupling mode.
kSize kLight_StateCount(kLight light)
Gets the number of states belonging to the light.
kStatus kLight_ControlInfo(kLight light, kInfoBits *info)
Reports constraint and validity information for the Control setting.
k32u kLight_ControlId(kLight light)
Gets the control source id for a light.
kStatus kLight_SetCouplingMode(kLight light, kLightCouplingMode mode)
Sets the light coupling mode.
kStatus kLight_PowerEnabledSaverInfo(kLight light, kInfoBool *info)
Reports constraint and validity information for the PowerSaverEnabled property.
kStatus kLight_EnablePowerSaver(kLight light, kBool enabled)
Enables light power-saver mode.
kStatus kLight_SetControlId(kLight light, k32u id)
Sets the control source id for a light.
kStatus kLight_LockedOutInfo(kLight light, kInfoBool *info)
Reports constraint and validity information for the LockOut property.
kLightControl kLight_Control(kLight light)
Reports the light control mode.
Represents constraint and validity information for a kSize setting.
Definition: kInfo.h:370
Represents light mask sources.
kStatus kLight_SetMaxDutyCycle(kLight light, k64f dutyCycle)
Sets the maximum light duty cycle.
kStatus kLight_DeleteExtension(kLight light, kLightExt extension)
Destroys the specified light control extension and removes it from the light's extension list...
kStatus kLight_Clear(kLight light, kSize stateCount)
Resets light mode settings to defaults.
Abstract base class for light control extension parameters.
kSize kLight_ExtensionCount(kLight light)
Gets the number of control extensions that have been configured.
Represents constraint and validity information for a general setting.
Definition: kInfo.h:64
kStatus kLight_LockOut(kLight light, kBool shouldLock)
Controls the light lockout state.
kBool kLight_IsLockedOut(kLight light)
Reports whether light lockout is currently in effect.
kStatus kLight_SetMask(kLight light, kLightMask mask)
Sets the light mask source type.
kStatus kLight_PrimingModeInfo(kLight light, kInfoBits *info)
Reports constraint and validity information for the PrimingMode setting.
kStatus kLight_SetIntensity(kLight light, k64f intensity)
Sets intensity associated with this light.
kStatus kLight_CouplingModeInfo(kLight light, kInfoBits *info)
Reports constraint and validity information for the CouplingMode setting.
Represents constraint and validity information for a boolean setting.
Definition: kInfo.h:493
kBool kLight_PowerSaverEnabled(kLight light)
Reports whether power saver is currently enabled.