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

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithFahrenheitValue:">-initWithFahrenheitValue:</a></li>
  <li><a href="#section--initWithCelsiusValue:">-initWithCelsiusValue:</a></li>
  <li><a href="#section--initWithUnit:value:">-initWithUnit:value:</a></li>
  <li><a href="#section-unit">unit</a></li>
  <li><a href="#section-value">value</a></li>
</ul>

<h3>Overview</h3>

<p>Struct representing a temperature.</p>


<section class="section task-group-section">
  <h3 id="section--initWithFahrenheitValue:">
      -initWithFahrenheitValue:
  </h3>
  
  <p>Convenience init for a fahrenheit temperature value.</p>

  
  
  <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">initWithFahrenheitValue</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="n">fahrenheitValue</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>value</dt>
      <dd><p>Temperature value in fahrenheit</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLTemperature object</p>
  </div>
  
  <h3 id="section--initWithCelsiusValue:">
      -initWithCelsiusValue:
  </h3>
  
  <p>Convenience init for a celsius temperature value.</p>

  
  
  <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">initWithCelsiusValue</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">value</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="n">celsiusValue</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>value</dt>
      <dd><p>Temperature value in celsius</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLTemperature object</p>
  </div>
  
  <h3 id="section--initWithUnit:value:">
      -initWithUnit:value:
  </h3>
  
  <p>Convenience init for all parameters.</p>

  
  
  <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">initWithUnit</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Type%20Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span><span class="p">)</span><span class="nv">unit</span>
                               <span class="nf">value</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">value</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">unit</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>unit</dt>
      <dd><p>Temperature unit</p></dd>
      <dt>value</dt>
      <dd><p>Temperature value in specified unit</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLTemperature object</p>
  </div>
  
  <h3 id="section-unit">
      unit
  </h3>
  
  <p>Temperature unit</p>

<p>Required, float</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:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</a></span> <span class="n">_Nonnull</span> <span class="n">unit</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">unit</span><span class="p">:</span> <span class="kt"><a href="../Type%20Definitions.html#/c:SDLTemperatureUnit.h@T@SDLTemperatureUnit">SDLTemperatureUnit</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-value">
      value
  </h3>
  
  <p>Temperature value in specified unit. Range depends on OEM and is not checked by SDL.</p>

<p>Required, float</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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">_Nonnull</span> <span class="n">value</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
</section>