## On this page

  

 

 # vss::lighting\_system\_control::LightingSystemControl Class Reference

 Last update: 14.01.2025 

Lighting System Control Service. [More...](classvss_1_1lighting__system__control_1_1_lighting_system_control.xhtml#details)

## <a name="pub-methods"></a>Public Member Functions

[vss::Status](structvss_1_1_status.xhtml) [Set](classvss_1_1lighting__system__control_1_1_lighting_system_control.xhtml#afd712cf0f68936c1f76224dfdfc78b20) ([LightingSystemState](structvss_1_1lighting__system__control_1_1_lighting_system_state.xhtml)) [TimeStampedLightingSystemState](structvss_1_1lighting__system__control_1_1_time_stamped_lighting_system_state.xhtml) [Get](classvss_1_1lighting__system__control_1_1_lighting_system_control.xhtml#a350f4512f37143a5c7d4430212d092b9) ([LightingSystemName](structvss_1_1lighting__system__control_1_1_lighting_system_name.xhtml)) <a id="details" name="details"></a>## Detailed Description

Lighting System Control Service.

This service is used to retrieve and update the position and orientation of each projector and module contained in a lighting system, and the flux and light functions of each lamp contained in a module.

NoteAny changes will be applied to the simulation on the next remote procedure call to the Update method of the Simulation service. 

## Member Function Documentation

<a id="afd712cf0f68936c1f76224dfdfc78b20"></a>## [◆ ](#afd712cf0f68936c1f76224dfdfc78b20)Set()

 [vss::Status](structvss_1_1_status.xhtml) vss::lighting\_system\_control::LightingSystemControl::Set  ( [LightingSystemState](structvss_1_1lighting__system__control_1_1_lighting_system_state.xhtml)  ) 

Updates the power of the lamps for a given set of projector/module/lamps.

Returns an error if any of the identities (lighting system/projector/module /lamp) do not exist.

Does not change the value of a lamp if it is present in the loaded projector but not in the [ProjectorState](structvss_1_1lighting__system__control_1_1_projector_state.xhtml "Message containing the state of a projector.") message. This procedure sends the new flux values to be applied. They will be applied at the next call of the Simulation Service Update remote procedure. A successful [vss.Status](structvss_1_1_status.xhtml "The status message returned by AVX for any procedure call.") return means that the [LightingSystemState](structvss_1_1lighting__system__control_1_1_lighting_system_state.xhtml "The message returned by AVX when the set procedure of the lighting system control service is called.") message is valid and will be applied.





<a id="a350f4512f37143a5c7d4430212d092b9"></a>## [◆ ](#a350f4512f37143a5c7d4430212d092b9)Get()

 [TimeStampedLightingSystemState](structvss_1_1lighting__system__control_1_1_time_stamped_lighting_system_state.xhtml) vss::lighting\_system\_control::LightingSystemControl::Get  ( [LightingSystemName](structvss_1_1lighting__system__control_1_1_lighting_system_name.xhtml)  ) 

Returns the [LightingSystemState](structvss_1_1lighting__system__control_1_1_lighting_system_state.xhtml "The message returned by AVX when the set procedure of the lighting system control service is called.") of the lighting system that has a lighting\_system\_name matching the name given as argument.





---

The documentation for this class was generated from the following file:- lighting\_system\_control.proto