fork/livesplit-core

git clone https://git.julia.blue/fork/livesplit-core

Christopher SerrAdd docsee16b86

v0.11.0
15.5 KiB338 linesraw
1<!doctype html>
2<html class="default no-js">
3<head>
4	<meta charset="utf-8">
5	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6	<title>AtomicDateTimeRef | livesplit</title>
7	<meta name="description" content="">
8	<meta name="viewport" content="width=device-width, initial-scale=1">
9	<link rel="stylesheet" href="../assets/css/main.css">
10</head>
11<body>
12<header>
13	<div class="tsd-page-toolbar">
14		<div class="container">
15			<div class="table-wrap">
16				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17					<div class="field">
18						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19						<input id="tsd-search-field" type="text" />
20					</div>
21					<ul class="results">
22						<li class="state loading">Preparing search index...</li>
23						<li class="state failure">The search index is not available</li>
24					</ul>
25					<a href="../index.html" class="title">livesplit</a>
26				</div>
27				<div class="table-cell" id="tsd-widgets">
28					<div id="tsd-filter">
29						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30						<div class="tsd-filter-group">
31							<div class="tsd-select" id="tsd-filter-visibility">
32								<span class="tsd-select-label">All</span>
33								<ul class="tsd-select-list">
34									<li data-value="public">Public</li>
35									<li data-value="protected">Public/Protected</li>
36									<li data-value="private" class="selected">All</li>
37								</ul>
38							</div>
39							<input type="checkbox" id="tsd-filter-inherited" checked />
40							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41							<input type="checkbox" id="tsd-filter-externals" checked />
42							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43							<input type="checkbox" id="tsd-filter-only-exported" />
44							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45						</div>
46					</div>
47					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48				</div>
49			</div>
50		</div>
51	</div>
52	<div class="tsd-page-title">
53		<div class="container">
54			<ul class="tsd-breadcrumb">
55				<li>
56					<a href="../globals.html">Globals</a>
57				</li>
58				<li>
59					<a href="atomicdatetimeref.html">AtomicDateTimeRef</a>
60				</li>
61			</ul>
62			<h1>Class AtomicDateTimeRef</h1>
63		</div>
64	</div>
65</header>
66<div class="container container-main">
67	<div class="row">
68		<div class="col-8 col-content">
69			<section class="tsd-panel tsd-comment">
70				<div class="tsd-comment tsd-typography">
71					<div class="lead">
72						<p>An Atomic Date Time represents a UTC Date Time that tries to be as close to
73						an atomic clock as possible.</p>
74					</div>
75				</div>
76			</section>
77			<section class="tsd-panel tsd-hierarchy">
78				<h3>Hierarchy</h3>
79				<ul class="tsd-hierarchy">
80					<li>
81						<span class="target">AtomicDateTimeRef</span>
82						<ul class="tsd-hierarchy">
83							<li>
84								<a href="atomicdatetimerefmut.html" class="tsd-signature-type">AtomicDateTimeRefMut</a>
85							</li>
86						</ul>
87					</li>
88				</ul>
89			</section>
90			<section class="tsd-panel-group tsd-index-group">
91				<h2>Index</h2>
92				<section class="tsd-panel tsd-index-panel">
93					<div class="tsd-index-content">
94						<section class="tsd-index-section ">
95							<h3>Constructors</h3>
96							<ul class="tsd-index-list">
97								<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="atomicdatetimeref.html#constructor" class="tsd-kind-icon">constructor</a></li>
98							</ul>
99						</section>
100						<section class="tsd-index-section ">
101							<h3>Properties</h3>
102							<ul class="tsd-index-list">
103								<li class="tsd-kind-property tsd-parent-kind-class"><a href="atomicdatetimeref.html#ptr" class="tsd-kind-icon">ptr</a></li>
104							</ul>
105						</section>
106						<section class="tsd-index-section ">
107							<h3>Methods</h3>
108							<ul class="tsd-index-list">
109								<li class="tsd-kind-method tsd-parent-kind-class"><a href="atomicdatetimeref.html#issynchronized" class="tsd-kind-icon">is<wbr>Synchronized</a></li>
110								<li class="tsd-kind-method tsd-parent-kind-class"><a href="atomicdatetimeref.html#torfc2822" class="tsd-kind-icon">to<wbr>Rfc2822</a></li>
111								<li class="tsd-kind-method tsd-parent-kind-class"><a href="atomicdatetimeref.html#torfc3339" class="tsd-kind-icon">to<wbr>Rfc3339</a></li>
112							</ul>
113						</section>
114					</div>
115				</section>
116			</section>
117			<section class="tsd-panel-group tsd-member-group ">
118				<h2>Constructors</h2>
119				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
120					<a name="constructor" class="tsd-anchor"></a>
121					<h3>constructor</h3>
122					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
123						<li class="tsd-signature tsd-kind-icon">new <wbr>Atomic<wbr>Date<wbr>Time<wbr>Ref<span class="tsd-signature-symbol">(</span>ptr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="atomicdatetimeref.html" class="tsd-signature-type">AtomicDateTimeRef</a></li>
124					</ul>
125					<ul class="tsd-descriptions">
126						<li class="tsd-description">
127							<aside class="tsd-sources">
128								<ul>
129									<li>Defined in livesplit_core.ts:1271</li>
130								</ul>
131							</aside>
132							<div class="tsd-comment tsd-typography">
133								<div class="lead">
134									<p>This constructor is an implementation detail. Do not use this.</p>
135								</div>
136							</div>
137							<h4 class="tsd-parameters-title">Parameters</h4>
138							<ul class="tsd-parameters">
139								<li>
140									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
141								</li>
142							</ul>
143							<h4 class="tsd-returns-title">Returns <a href="atomicdatetimeref.html" class="tsd-signature-type">AtomicDateTimeRef</a></h4>
144						</li>
145					</ul>
146				</section>
147			</section>
148			<section class="tsd-panel-group tsd-member-group ">
149				<h2>Properties</h2>
150				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
151					<a name="ptr" class="tsd-anchor"></a>
152					<h3>ptr</h3>
153					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
154					<aside class="tsd-sources">
155						<ul>
156							<li>Defined in livesplit_core.ts:1239</li>
157						</ul>
158					</aside>
159				</section>
160			</section>
161			<section class="tsd-panel-group tsd-member-group ">
162				<h2>Methods</h2>
163				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
164					<a name="issynchronized" class="tsd-anchor"></a>
165					<h3>is<wbr>Synchronized</h3>
166					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
167						<li class="tsd-signature tsd-kind-icon">is<wbr>Synchronized<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
168					</ul>
169					<ul class="tsd-descriptions">
170						<li class="tsd-description">
171							<aside class="tsd-sources">
172								<ul>
173									<li>Defined in livesplit_core.ts:1245</li>
174								</ul>
175							</aside>
176							<div class="tsd-comment tsd-typography">
177								<div class="lead">
178									<p>Represents whether the date time is actually properly derived from an
179										atomic clock. If the synchronization with the atomic clock didn&#39;t happen
180									yet or failed, this is set to false.</p>
181								</div>
182							</div>
183							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
184						</li>
185					</ul>
186				</section>
187				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
188					<a name="torfc2822" class="tsd-anchor"></a>
189					<h3>to<wbr>Rfc2822</h3>
190					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
191						<li class="tsd-signature tsd-kind-icon">to<wbr>Rfc2822<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
192					</ul>
193					<ul class="tsd-descriptions">
194						<li class="tsd-description">
195							<aside class="tsd-sources">
196								<ul>
197									<li>Defined in livesplit_core.ts:1255</li>
198								</ul>
199							</aside>
200							<div class="tsd-comment tsd-typography">
201								<div class="lead">
202									<p>Converts this atomic date time into a RFC 2822 formatted date time.</p>
203								</div>
204							</div>
205							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
206						</li>
207					</ul>
208				</section>
209				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
210					<a name="torfc3339" class="tsd-anchor"></a>
211					<h3>to<wbr>Rfc3339</h3>
212					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
213						<li class="tsd-signature tsd-kind-icon">to<wbr>Rfc3339<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
214					</ul>
215					<ul class="tsd-descriptions">
216						<li class="tsd-description">
217							<aside class="tsd-sources">
218								<ul>
219									<li>Defined in livesplit_core.ts:1265</li>
220								</ul>
221							</aside>
222							<div class="tsd-comment tsd-typography">
223								<div class="lead">
224									<p>Converts this atomic date time into a RFC 3339 formatted date time.</p>
225								</div>
226							</div>
227							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
228						</li>
229					</ul>
230				</section>
231			</section>
232		</div>
233		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
234			<nav class="tsd-navigation primary">
235				<ul>
236					<li class="globals  ">
237						<a href="../globals.html"><em>Globals</em></a>
238					</li>
239				</ul>
240			</nav>
241			<nav class="tsd-navigation secondary menu-sticky">
242				<ul class="before-current">
243				</ul>
244				<ul class="current">
245					<li class="current tsd-kind-class">
246						<a href="atomicdatetimeref.html" class="tsd-kind-icon">Atomic<wbr>Date<wbr>Time<wbr>Ref</a>
247						<ul>
248							<li class=" tsd-kind-constructor tsd-parent-kind-class">
249								<a href="atomicdatetimeref.html#constructor" class="tsd-kind-icon">constructor</a>
250							</li>
251							<li class=" tsd-kind-property tsd-parent-kind-class">
252								<a href="atomicdatetimeref.html#ptr" class="tsd-kind-icon">ptr</a>
253							</li>
254							<li class=" tsd-kind-method tsd-parent-kind-class">
255								<a href="atomicdatetimeref.html#issynchronized" class="tsd-kind-icon">is<wbr>Synchronized</a>
256							</li>
257							<li class=" tsd-kind-method tsd-parent-kind-class">
258								<a href="atomicdatetimeref.html#torfc2822" class="tsd-kind-icon">to<wbr>Rfc2822</a>
259							</li>
260							<li class=" tsd-kind-method tsd-parent-kind-class">
261								<a href="atomicdatetimeref.html#torfc3339" class="tsd-kind-icon">to<wbr>Rfc3339</a>
262							</li>
263						</ul>
264					</li>
265				</ul>
266				<ul class="after-current">
267				</ul>
268			</nav>
269		</div>
270	</div>
271</div>
272<footer class="with-border-bottom">
273	<div class="container">
274		<h2>Legend</h2>
275		<div class="tsd-legend-group">
276			<ul class="tsd-legend">
277				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
278				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
279				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
280				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
281				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
282				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
283				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
284			</ul>
285			<ul class="tsd-legend">
286				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
287				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
288				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
289				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
290			</ul>
291			<ul class="tsd-legend">
292				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
293				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
294				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
295				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
296				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
297				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
298			</ul>
299			<ul class="tsd-legend">
300				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
301				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
302				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
303				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
304				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
305				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
306				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
307			</ul>
308			<ul class="tsd-legend">
309				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
310				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
311				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
312				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
313			</ul>
314			<ul class="tsd-legend">
315				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
316				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
317				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
318			</ul>
319			<ul class="tsd-legend">
320				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
321				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
322				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
323			</ul>
324			<ul class="tsd-legend">
325				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
326				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
327			</ul>
328		</div>
329	</div>
330</footer>
331<div class="container tsd-generator">
332	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
333</div>
334<div class="overlay"></div>
335<script src="../assets/js/main.js"></script>
336<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
337</body>
338</html>