summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/public/SDLSeatControlCapabilities.h
blob: 3895a89e10621d5783e9a68e388f0518377a8211 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
//  SDLSeatControlCapabilities.h
//


#import "SDLRPCStruct.h"
#import "SDLModuleInfo.h"

NS_ASSUME_NONNULL_BEGIN

/**
 * Include information about a seat control capabilities.
 */
@interface SDLSeatControlCapabilities : SDLRPCStruct

/// Constructs a newly allocated SDLSeatControlCapabilities object with moduleName and moduleInfo
///
/// @param moduleName The short friendly name of the module.
/// @param moduleInfo Information about a RC module, including its id
/// @return An SDLSeatControlCapabilities object
- (instancetype)initWithName:(NSString *)moduleName moduleInfo:(nullable SDLModuleInfo *)moduleInfo;

/// Constructs a newly allocated SDLSeatControlCapabilities object with all parameters
///
/// @param moduleName The short friendly name of the module.
/// @param moduleInfo Information about a RC module, including its id
/// @param heatingEnabledAvail Whether or not heating is available
/// @param coolingEnabledAvail Whether or not heating is available
/// @param heatingLevelAvail Whether or not heating level is available
/// @param coolingLevelAvail Whether or not cooling level is available
/// @param horizontalPositionAvail Whether or not horizontal Position is available
/// @param verticalPositionAvail Whether or not vertical position is available
/// @param frontVerticalPositionAvail Whether or not front vertical position is available
/// @param backVerticalPositionAvail Whether or not back vertical position is available
/// @param backTitlAngleAvail Whether or not backTilt angle is available
/// @param headSupportHorizontalPositionAvail Whether or not head supports for horizontal position is available
/// @param headSupportVerticalPositionAvail Whether or not head supports for vertical position is available
/// @param massageEnabledAvail Whether or not massage enabled is available
/// @param massageModeAvail Whether or not massage mode is available
/// @param massageCushionFirmnessAvail Whether or not massage cushion firmness is available
/// @param memoryAvail Whether or not massage cushion firmness is available
/// @return An SDLSeatControlCapabilities object
- (instancetype)initWithName:(NSString *)moduleName moduleInfo:(nullable SDLModuleInfo *)moduleInfo heatingEnabledAvailable:(BOOL)heatingEnabledAvail
     coolingEnabledAvailable:(BOOL)coolingEnabledAvail heatingLevelAvailable:(BOOL)heatingLevelAvail coolingLevelAvailable:(BOOL)coolingLevelAvail horizontalPositionAvailable:(BOOL)horizontalPositionAvail verticalPositionAvailable:(BOOL)verticalPositionAvail frontVerticalPositionAvailable:(BOOL)frontVerticalPositionAvail backVerticalPositionAvailable:(BOOL)backVerticalPositionAvail backTiltAngleAvailable:(BOOL)backTitlAngleAvail headSupportHorizontalPositionAvailable:(BOOL)headSupportHorizontalPositionAvail headSupportVerticalPositionAvailable:(BOOL)headSupportVerticalPositionAvail massageEnabledAvailable:(BOOL)massageEnabledAvail massageModeAvailable:(BOOL)massageModeAvail massageCushionFirmnessAvailable:(BOOL)massageCushionFirmnessAvail memoryAvailable:(BOOL)memoryAvail;

/**
 * @abstract The short friendly name of the seat control module.
 * It should not be used to identify a module by mobile application.
 *
 * Required, Max length 100 chars
 */
@property (strong, nonatomic) NSString *moduleName;

/**
 * @abstract Whether or not heating is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *heatingEnabledAvailable;

/**
 * @abstract Whether or not cooling is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *coolingEnabledAvailable;

/**
 * @abstract Whether or not heating level is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *heatingLevelAvailable;

/**
 * @abstract Whether or not cooling level is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *coolingLevelAvailable;

/**
 * @abstract Whether or not horizontal Position is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *horizontalPositionAvailable;

/**
 * @abstract Whether or not vertical Position is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *verticalPositionAvailable;

/**
 * @abstract Whether or not front Vertical Position is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *frontVerticalPositionAvailable;

/**
 * @abstract Whether or not back Vertical Position is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *backVerticalPositionAvailable;

/**
 * @abstract Whether or not backTilt Angle Available is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *backTiltAngleAvailable;

/**
 * @abstract Whether or not head Supports for Horizontal Position is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *headSupportHorizontalPositionAvailable;

/**
 * @abstract Whether or not head Supports for Vertical Position is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *headSupportVerticalPositionAvailable;

/**
 * @abstract Whether or not massage Enabled is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *massageEnabledAvailable;

/**
 * @abstract Whether or not massage Mode is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *massageModeAvailable;

/**
 * @abstract Whether or not massage Cushion Firmness is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *massageCushionFirmnessAvailable;

/**
 * @abstract Whether or not memory is Available.

 * Optional
 */
@property (nullable, strong, nonatomic) NSNumber<SDLBool> *memoryAvailable;

/**
 *  @abstract Information about a RC module, including its id.
 *
 *  Optional
 */
@property (nullable, strong, nonatomic) SDLModuleInfo *moduleInfo;

@end

NS_ASSUME_NONNULL_END