WindowControl QML Type
Provides an interface to the window control. More...
| Import Statement: | import QtInterfaceFramework.VehicleFunctions 1.0 |
| Instantiates: | QIfWindowControl |
| Inherits: |
Properties
- blindMode : QtIfVehicleFunctions::BlindMode
- blindState : QtIfVehicleFunctions::WindowState
- configurationId : string
- discoveryMode : enumeration
- discoveryResult : enumeration
- heater : bool
- heaterMode : QtIfVehicleFunctions::HeaterMode
- isInitialized : bool
- isValid : bool
- preferredBackends : list<string>
- serviceObject : ServiceObject
- state : QtIfVehicleFunctions::WindowState
Methods
- close()
- open()
- enumeration startAutoDiscovery()
Detailed Description
The QIfWindowControl provides an interface to control the physical windows of the vehicle.
All properties are exposed through zone objects. The zones are retrieved using the zoneAt method.
The QIfWindowControl expects a single backend to be available. It is recommended to use it with discoveryMode set to zoneAt.
Property Documentation
blindMode : QtIfVehicleFunctions::BlindMode |
Holds the current mode of the window blind.
Available values are:
| Constant | Description |
|---|---|
BlindOpen | The blind will be opened. |
BlindClosed | The blind will be closed. |
AutoBlind | The blind is opened or closed automatically. |
blindState : QtIfVehicleFunctions::WindowState |
Holds the current state of the window blind.
Available values are:
| Constant | Description |
|---|---|
FullyOpen | The object is fully open. |
Open | The object is open, but not fully open yet. |
Closed | The object is closed. |
configurationId : string |
Holds the id to determine which configuration this feature belongs to.
Once the id has been set, it is possible to change certain values using the InterfaceFrameworkConfiguration API.
Note: Values set in the matching InterfaceFrameworkConfiguration can override the initial values set during the component creation.
See also InterfaceFrameworkConfiguration.
discoveryMode : enumeration |
Holds the mode that is used for the autoDiscovery
Available values are:
| Constant | Description |
|---|---|
NoAutoDiscovery | No auto discovery is done and the ServiceObject needs to be set manually. |
AutoDiscovery | Tries to find a production backend with a matching interface and falls back to a simulation backend if not found. |
LoadOnlyProductionBackends | Only tries to load a production backend with a matching interface. |
LoadOnlySimulationBackends | Only tries to load a simulation backend with a matching interface. |
If necessary, auto discovery is started once the feature creation is completed.
Note: If you change this property after the feature is instantiated, make sure to call startAutoDiscovery() to search for a new service object.
discoveryResult : enumeration |
The result of the last autoDiscovery
Available values are:
| Constant | Description |
|---|---|
NoResult | Indicates that no auto discovery was started because the feature has already assigned a valid ServiceObject. |
ErrorWhileLoading | An error has happened while searching for a backend with a matching interface. |
ProductionBackendLoaded | A production backend was loaded, as a result of auto discovery. |
SimulationBackendLoaded | A simulation backend was loaded, as a result of auto discovery. |
heater : bool |
Indicates whether the window heater is currently running.
heaterMode : QtIfVehicleFunctions::HeaterMode |
Holds the current mode of the window heater.
Available values are:
| Constant | Description |
|---|---|
HeaterOn | The window heater is turned on. |
HeaterOff | The window heater is turned off. |
AutoHeater | The window heater is turning off and on automatically. |
isInitialized : bool |
Indicates whether the feature has been initialized with all the values from the backend.
The property is true once the backend sends the QIfFeatureInterface::initializationDone signal to indicate that all values have now been initialized with values from the backend.
See also isValid and QIfFeatureInterface::initializationDone.
isValid : bool |
Indicates whether the feature is ready for use.
The property is true if the feature is ready to be used, otherwise false. Not being ready usually indicates that no suitable service object could be found, or that automatic discovery has not been triggered.
The backend still might not have sent all properties yet and is not fully initialized. Use isInitialized instead to know when the feature holds all correct values.
See also QIfServiceObject, discoveryMode, and isInitialized.
Holds a list of wildcards to load the preferred backend during auto discovery.
The auto discovery mechanism will automatically search for backends which provide a matching interface for this feature implementation. See startAutoDiscovery() for more information.
In case multiple backends implement the same interface, the list of wildcards can be used to determine the correct one to load.
The wildcards are applied in order to the found backends. If the wildcard matches some backends those backends will be loaded, otherwise the next wildcard is used.
For example: Given an AbstractFeature with two backends, backend_mqtt.so and backend_qtro.so, the property can be set to "*_mqtt*" to always select the backend_mqtt.so backend when available.
serviceObject : ServiceObject |
Sets the service object for the feature.
As Features only expose the front API facing the developer, a service object implementing the actual function is required. This is usually retrieved through the auto discovery mechanism.
The setter for this property returns false if the QIfServiceObject is already set to this particular instance or the QIfServiceObject isn't accepted by the feature.
See also discoveryMode.
state : QtIfVehicleFunctions::WindowState |
Holds the current state of the window.
Available values are:
| Constant | Description |
|---|---|
FullyOpen | The object is fully open. |
Open | The object is open, but not fully open yet. |
Closed | The object is closed. |
Method Documentation
close() |
Closes the window, if not already in the QIfWindowControl::Closed state.
open() |
Opens the window, if not already in the QIfWindowControl::FullyOpen state.
enumeration startAutoDiscovery() |
Performs an automatic discovery attempt.
The feature tries to locate a single ServiceObject that implements the required interface.
If no ServiceObject is found, the feature remains invalid. If more than one ServiceObject is found, the first instance is used.
This function returns either the type of the backend that was loaded; or an error.
If the discoveryMode is set to QIfAbstractFeature::NoAutoDiscovery, this function does nothing and returns QIfAbstractFeature::NoResult.
Return values are:
| Constant | Description |
|---|---|
NoResult | Indicates that no auto discovery was started because the feature already has a valid ServiceObject assigned. |
ErrorWhileLoading | Indicates an error has occurred while searching for a backend with a matching interface. |
ProductionBackendLoaded | A production backend was loaded, as a result of auto discovery. |
SimulationBackendLoaded | A simulation backend was loaded, as a result of auto discovery. |
See also Dynamic Backend System and QIfServiceManager.
© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.