summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLRoofStatus.html
blob: c737ac82d894b609511401c91e72fa4b3be0b7b6 (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
<h1>SDLRoofStatus Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithLocation:status:">-initWithLocation:status:</a></li>
  <li><a href="#section--initWithLocation:status:state:">-initWithLocation:status:state:</a></li>
  <li><a href="#section-location">location</a></li>
  <li><a href="#section-status">status</a></li>
  <li><a href="#section-state">state</a></li>
</ul>

<h3>Overview</h3>

<p>Describes the status of a parameter of roof/convertible roof/sunroof/moonroof etc. If roof is open (AJAR), state will determine percentage of roof open.</p>

<p>@added in SmartDeviceLink 7.1.0</p>


<section class="section task-group-section">
  <h3 id="section--initWithLocation:status:">
      -initWithLocation:status:
  </h3>
  
  
  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLocation</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLGrid.html">SDLGrid</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">location</span>
                                  <span class="nf">status</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLDoorStatusType.h@T@SDLDoorStatusType">SDLDoorStatusType</a></span><span class="p">)</span><span class="nv">status</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">location</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGrid.html">SDLGrid</a></span><span class="p">,</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLDoorStatusType.h@T@SDLDoorStatusType">SDLDoorStatusType</a></span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>location</dt>
      <dd><p>- location</p></dd>
      <dt>status</dt>
      <dd><p>- status</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLRoofStatus object</p>
  </div>
  
  <h3 id="section--initWithLocation:status:state:">
      -initWithLocation:status:state:
  </h3>
  
  
  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithLocation</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLGrid.html">SDLGrid</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">location</span>
                                  <span class="nf">status</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLDoorStatusType.h@T@SDLDoorStatusType">SDLDoorStatusType</a></span><span class="p">)</span><span class="nv">status</span>
                                   <span class="nf">state</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLWindowState.html">SDLWindowState</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">state</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="nv">location</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGrid.html">SDLGrid</a></span><span class="p">,</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLDoorStatusType.h@T@SDLDoorStatusType">SDLDoorStatusType</a></span><span class="p">,</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLWindowState.html">SDLWindowState</a></span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>location</dt>
      <dd><p>- location</p></dd>
      <dt>status</dt>
      <dd><p>- status</p></dd>
      <dt>state</dt>
      <dd><p>- state</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLRoofStatus object</p>
  </div>
  
  <h3 id="section-location">
      location
  </h3>
  
  <p>The location of the roof on the vehicle grid</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLGrid.html">SDLGrid</a></span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">location</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">location</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLGrid.html">SDLGrid</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-status">
      status
  </h3>
  
  <p>The status of the roof (e.g. if it is detachable)</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">)</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLDoorStatusType.h@T@SDLDoorStatusType">SDLDoorStatusType</a></span> <span class="n">_Nonnull</span> <span class="n">status</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">status</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLDoorStatusType.h@T@SDLDoorStatusType">SDLDoorStatusType</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-state">
      state
  </h3>
  
  <p>The state of the roof if it has a window</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLWindowState.html">SDLWindowState</a></span> <span class="o">*</span><span class="n">state</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">state</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLWindowState.html">SDLWindowState</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>