forked from modelica/ModelicaStandardLibrary
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Time.mo
1287 lines (1049 loc) · 39.5 KB
/
Time.mo
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
within Modelica.Utilities;
package Time "Functions to work with date and time"
extends Modelica.Icons.FunctionsPackage;
impure function getTime "Retrieve the current time (in the local time zone)"
extends Modelica.Icons.Function;
output Types.TimeType now "Current time";
algorithm
(now.millisecond, now.second, now.minute, now.hour, now.day, now.month, now.year) := Internal.Time.getTime();
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote><pre>
now = Time.<strong>getTime</strong>();
</pre></blockquote>
<h4>Description</h4>
<p>
Returns the local time at the time instant this function was called.
The returned value is of type <a href=\"modelica://Modelica.Utilities.Types.TimeType\">TimeType</a>.
</p>
<h4>Example</h4>
<blockquote><pre>
now = getTime() // = Modelica.Utilities.Types.TimeType(281, 30, 13, 10, 15, 2, 2015)
// Feb. 15, 2015 at 10:13 after 30.281 s
</pre></blockquote>
<h4>Note</h4>
<p>This function is impure!</p>
</html>"));
end getTime;
function dayOfWeek "Return day of week for given date"
extends Modelica.Icons.Function;
input Types.TimeType timeIn "Date";
output Integer dow(min=1, max=7) "Day of week: 1 = Monday, ..., 6 = Saturday, 7 = Sunday";
algorithm
dow := Internal.Time.dayOfWeek(timeIn.year, timeIn.month, timeIn.day);
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote><pre>
dow = Time.<strong>dayOfWeek</strong>(timeIn);
</pre></blockquote>
<h4>Description</h4>
<p>
Returns the day of the week for a given date using Tomohiko Sakamoto's algorithm.
The returned Integer number of <code>dow</code> has the following meaning:
</p>
<blockquote>
<table border=1 cellspacing=0 cellpadding=2>
<tr><th>Day of week</th>
<th>Number</th></tr>
<tr><td>Monday</td> <td>1</td></tr>
<tr><td>Tuesday</td> <td>2</td></tr>
<tr><td>Wednesday</td> <td>3</td></tr>
<tr><td>Thursday</td> <td>4</td></tr>
<tr><td>Friday</td> <td>5</td></tr>
<tr><td>Saturday</td> <td>6</td></tr>
<tr><td>Sunday</td> <td>7</td></tr>
</table>
</blockquote>
<h4>Example</h4>
<blockquote><pre>
now = getTime() // = Modelica.Utilities.Types.TimeType(281, 30, 13, 10, 6, 12, 2019)
// Dec. 06, 2019 at 10:13 after 30.281 s
dow = dayOfWeek(now) // = 5
// Dec. 06, 2019 (Saint Nicholas Day) is a Friday
</pre></blockquote>
</html>"));
end dayOfWeek;
function daysInYear "Get number of days in year"
extends Modelica.Icons.Function;
input Integer a "Year";
output Integer days "Number of days in year a";
algorithm
days := if isLeapYear(a) then 366 else 365;
end daysInYear;
function isLeapYear "Check if a year is a leap year"
extends Modelica.Icons.Function;
input Integer year "Year";
output Boolean isLeap "= true, if year is a leap year";
algorithm
isLeap := (mod(year, 4) == 0 and mod(year, 100) <> 0) or mod(year, 400) == 0;
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote><pre>
isLeap = Time.<strong>isLeapYear</strong>(year);
</pre></blockquote>
<h4>Description</h4>
<p>
Checks if a given year is a leap year.
</p>
</html>"));
end isLeapYear;
function leapDays "Return the number of leap days in range"
extends Modelica.Icons.Function;
input Integer year1 "First year";
input Integer year2 "Second year";
output Integer days "Number of leap days in range [year1, year2 - 1]";
protected
Integer d "Length of range";
Integer y1;
Integer y2;
algorithm
d := year2 - year1;
if d == 0 then
days := 0;
return;
elseif d < 0 then
y1 := year2;
y2 := year1;
d := -d;
else
y1 := year1;
y2 := year2;
end if;
days := div(d - 1, 4) - div(d - 1, 100) + div(d - 1, 400);
if isLeapYear(y1) or isLeapYear(y2 - 1) then
days := days + 1;
end if;
if year1 > year2 then
days := -days;
end if;
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote><pre>
days = Time.<strong>leapDays</strong>(year1, year2);
</pre></blockquote>
<h4>Description</h4>
<p>
Returns the number of leap days in the range [<code>year1</code>, <code>year2</code> - 1].
In case of <code>year1</code> > <code>year2</code>, the result is the negative number of leap days in range [<code>year2</code>, <code>year1</code> - 1].
</p>
<h4>Example</h4>
<blockquote><pre>
days = leapDays(2000, 2020) // = 5 leap days in range [2000, 2019]
// for the years 2000, 2004, 2008, 2012 and 2016
// excluding the second year 2020
</pre></blockquote>
</html>"));
end leapDays;
final constant String weekDays[7] = {"Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday"} "Array of week days";
final constant String shortWeekDays[7] = {"Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun"} "Array of abbreviated week days";
final constant String months[12] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"} "Array of month names";
final constant String shortMonths[12] = {"Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"} "Array of abbreviated month names";
operator record DateTime "DateTime record with several constructors and overloaded operators"
extends Modelica.Icons.Record;
Integer millisecond(min=0, max=999) "Millisecond" annotation(absoluteValue=true);
Integer second(min=0, max=61) "Second" annotation(absoluteValue=true);
Integer minute(min=0, max=59) "Minute" annotation(absoluteValue=true);
Integer hour(min=0, max=23) "Hour" annotation(absoluteValue=true);
Integer day(min=1, max=31) "Day" annotation(absoluteValue=true);
Integer month(min=1, max=12) "Month" annotation(absoluteValue=true);
Integer year "Year" annotation(absoluteValue=true);
encapsulated operator 'constructor' "Available constructors"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.FunctionsPackage;
function fromReadable "Create DateTime from human readable format"
extends Icons.Function;
input Integer year "Year";
input Integer month "Month";
input Integer day "Day";
input Integer hour "Hour";
input Integer minute "Minute";
input Integer second "Second";
input Integer millisecond "Millisecond";
output DateTime dt(millisecond=millisecond, second=second, minute=minute, hour=hour, day=day, month=month, year=year);
algorithm
end fromReadable;
function fromSystemTime "Create DateTime from current system time"
import Modelica.Utilities.Internal.Time.getTime;
extends Icons.Function;
output DateTime dt;
protected
Integer millisecond "Millisecond";
Integer second "Second";
Integer minute "Minute";
Integer hour "Hour";
Integer day "Day";
Integer month "Month";
Integer year "Year";
algorithm
(millisecond, second, minute, hour, day, month, year) := getTime();
dt :=DateTime(millisecond=millisecond, second=second, minute=minute, hour=hour, day=day, month=month, year=year);
end fromSystemTime;
function fromEpoch "Create DateTime from elapsed seconds since reference year"
import Modelica.Utilities.Internal.Time.getTime;
import Modelica.Math.nearestInteger;
import Modelica.Utilities.Time.isLeapYear;
import Modelica.Utilities.Time.daysInYear;
extends Icons.Function;
input Real seconds "Elapsed seconds since epoch_year";
input Integer epoch_year = 1970 "Reference year";
output DateTime dt;
protected
Integer[2,12] days_passed = {{31,59,90,120,151,181,212,243,273,304,334,365},
{31,60,91,121,152,182,213,244,274,305,335,366}};
Real rem;
Integer days, day_of_year, counted_days;
Integer i, j;
Integer millisecond "Millisecond";
Integer second "Second";
Integer minute "Minute";
Integer hour "Hour";
Integer day "Day";
Integer month "Month";
Integer year "Year";
algorithm
// get milliseconds
millisecond := nearestInteger(mod(abs(seconds),1)*1000);
// get seconds
second :=nearestInteger(mod(seconds,60));
// get minutes
rem :=seconds - second;
minute :=nearestInteger(mod(rem/60, 60));
// get hours
rem :=rem - minute*60;
hour :=nearestInteger(mod(rem/3600, 24));
// get number of days since epoch year
rem :=rem - hour*3600;
days :=nearestInteger(rem/(24*3600));
// get year
if days >= 0 then
// time is after reference year: count how many years must pass from reference year until 'days' is reached
year :=epoch_year;
counted_days := 0;
while counted_days+daysInYear(year) <= days loop
counted_days := counted_days + daysInYear(year);
year :=year + 1;
end while;
else
// time is before reference year: count years downwards
year :=epoch_year - 1;
counted_days := if isLeapYear(year) then -366 else -365;
while counted_days > days loop
year :=year - 1;
counted_days := counted_days - daysInYear(year);
end while;
end if;
// compute day in current year
day_of_year :=days - counted_days + 1;
// get month
// use correct column depending on leap and regular year
j :=if isLeapYear(year) then 2 else 1;
for i in 1:12 loop
if days_passed[j,i] >= day_of_year then
month :=i;
break;
end if;
end for;
// get day
day :=if month > 1 then day_of_year - days_passed[j,month-1] else day_of_year;
dt :=DateTime(millisecond=millisecond, second=second, minute=minute, hour=hour, day=day, month=month, year=year);
end fromEpoch;
end 'constructor';
encapsulated operator 'String' "Convert DateTime to string"
import Modelica.Utilities.Time.DateTime;
import Modelica.Utilities.Strings.replace;
import Modelica.Icons;
extends Icons.FunctionsPackage;
function formated "Use a subset of C strftime() conversion specifiers to format a DateTime record as string"
extends Icons.Function;
import Modelica.Utilities.Internal.Time.dayOfWeek;
import Modelica.Utilities.Time.weekDays;
import Modelica.Utilities.Time.shortWeekDays;
import Modelica.Utilities.Time.months;
import Modelica.Utilities.Time.shortMonths;
input DateTime dt;
input String format = "%Y-%m-%d %H:%M:%S";
output String str;
protected
encapsulated function string0 "Create string with minimum length, filled with 0"
import Modelica.Utilities.Strings.replace;
input Integer i;
input Integer l;
output String s0;
algorithm
s0 :=replace(String(i, minimumLength=l, leftJustified=false), " ", "0");
end string0;
algorithm
str :=replace(format, "%%", "%");
str :=replace(str, "%y", string0(mod(dt.year, 100), l=2));
str :=replace(str, "%Y", string0(dt.year, l=4));
str :=replace(str, "%m", string0(dt.month, l=2));
str :=replace(str, "%d", string0(dt.day, l=2));
str :=replace(str, "%H", string0(dt.hour, l=2));
str :=replace(str, "%M", string0(dt.minute, l=2));
str :=replace(str, "%S", string0(dt.second, l=2));
str :=replace(str, "%L", string0(dt.millisecond, l=3));
str :=replace(str, "%a", shortWeekDays[dayOfWeek(dt.year, dt.month, dt.day)]);
str :=replace(str, "%A", weekDays[dayOfWeek(dt.year, dt.month, dt.day)]);
str :=replace(str, "%b", shortMonths[dt.month]);
str :=replace(str, "%B", months[dt.month]);
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote>
<pre>
String(dt)
String(dt, format)
</pre>
</blockquote>
<h4>Description</h4>
<p>
The input value \"dt\" of type DateTime is converted to a string.
</p>
<p>
The content of the output string can be controlled
via the \"format\" string by setting one or more of the conversion specifiers listed below.
</p>
<table border=\"1\" cellpadding=\"2\" cellspacing=\"0\">
<tr>
<th>Specifier</th>
<th>Meaning</th>
<th>Examples</th>
</tr>
<tr>
<td>%y</td>
<td>year without century</td>
<td>01, 02, ... 99</td>
</tr>
<tr>
<td>%Y</td>
<td>year with century</td>
<td>2001, 2002, 2099</td>
</tr>
<tr>
<td>%b</td>
<td>abbreviated month name</td>
<td>Jan, Feb</td>
</tr>
<tr>
<td>%B</td>
<td>full month name</td>
<td>January, February</td>
</tr>
<tr>
<td>%m</td>
<td>month as number, zero padded to length 2</td>
<td>01, 02, ... 12</td>
</tr>
<tr>
<td>%a</td>
<td>abbreviated weekday</td>
<td>Mon, Tue</td>
</tr>
<tr>
<td>%A</td>
<td>full name of weekday</td>
<td>Monday, Tuesday</td>
</tr>
<tr>
<td>%d</td>
<td>day of month, zero padded to length 2</td>
<td>01, 02, ... 31</td>
</tr>
<tr>
<td>%H</td>
<td>hour, zero padded to length 2</td>
<td>00, 01, ... 24</td>
</tr>
<tr>
<td>%M</td>
<td>minute, zero padded to length 2</td>
<td>00, 01, ... 60</td>
</tr>
<tr>
<td>%S</td>
<td>second, zero padded to length 2</td>
<td>00, 01, ... 60</td>
</tr>
<tr>
<td>%%</td>
<td>single percent character. Not fully supported. See the Limitations section below.</td>
<td>%</td>
</tr>
</table>
<p>Additionally the following conversion specifiers are supported, which are not part of the C standard.</p>
<table border=\"1\" cellpadding=\"2\" cellspacing=\"0\">
<tr>
<th>Specifier</th>
<th>Meaning</th>
<th>Examples</th>
</tr>
<tr>
<td>%L</td>
<td>millisecond, zero padded to length 3</td>
<td>000, 001, ... 999</td>
</tr>
</table>
<h4>Example</h4>
<blockquote>
<pre>
import Modelica.Utilities.Time.DateTime;
dt = DateTime(2020, 12, 24, 00, 01, 02, 003);
String(dt) // = \"2020-12-24 00:01:02\"
String(dt, \"\"%a, %b. %d %Y, %H:%M:%S\"\") // = \"Thu, Dec. 24 2020, 00:01:02\"
String(dt, format=\"%A, %d. %B %y, %H:%M:%S.%L\") // = \"Thursday, 24. December 20, 00:01:02.003\"
</pre>
</blockquote>
<h4>Limitations</h4>
<p>
This function uses simple string replace methods to exchange the conversion specifiers with the appropriate values.
</p>
<p>
When additional % characters are included in the format string (via %%) problems can occur, like shown below.
</p>
<blockquote>
<pre>
// ANTI-EXAMPLE - do not use
String(dt, format=\"%%b\") // Should give \"%b\", but gives \"Dec.\" instead
</pre>
</blockquote>
</html>"));
end formated;
end 'String';
encapsulated operator function '==' "Check equality of two DateTime objects"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt1;
input DateTime dt2;
output Boolean result "= dt1 == dt2";
algorithm
result := dt1.year == dt2.year and
dt1.month == dt2.month and
dt1.day == dt2.day and
dt1.hour == dt2.hour and
dt1.minute == dt2.minute and
dt1.second == dt2.second and
dt1.millisecond == dt2.millisecond;
end '==';
encapsulated operator function '<>' "Check inequality of two DateTime objects"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt1;
input DateTime dt2;
output Boolean result "= dt1 <> dt2";
algorithm
result := not dt1 == dt2;
end '<>';
encapsulated operator function '>' "Check if DateTime dt1 is later as dt2"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt1;
input DateTime dt2;
output Boolean result "= dt1 > dt2";
algorithm
if dt1.year > dt2.year then
result :=true;
else
if dt1.year==dt2.year and dt1.month > dt2.month then
result :=true;
else
if dt1.month==dt2.month and dt1.day > dt2.day then
result :=true;
else
if dt1.day==dt2.day and dt1.hour > dt2.hour then
result :=true;
else
if dt1.hour==dt2.hour and dt1.minute > dt2.minute then
result :=true;
else
if dt1.minute==dt2.minute and dt1.second > dt2.second then
result :=true;
else
if dt1.second==dt2.second and dt1.millisecond > dt2.millisecond then
result :=true;
else
result :=false;
end if;
end if;
end if;
end if;
end if;
end if;
end if;
end '>';
encapsulated operator function '>=' "Check if DateTime dt1 is equal to dt2 or later"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt1;
input DateTime dt2;
output Boolean result "= dt1 >= dt2";
algorithm
result :=dt1 == dt2 or dt1 > dt2;
end '>=';
encapsulated operator function '<' "Check if DateTime dt1 is earlier as dt2"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt1;
input DateTime dt2;
output Boolean result "= dt1 < dt2";
algorithm
result := not dt1 == dt2 and dt2 > dt1;
end '<';
encapsulated operator function '<=' "Check if DateTime dt1 is equal to dt2 or earlier"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt1;
input DateTime dt2;
output Boolean result "= dt1 <= dt2";
algorithm
result := dt1 == dt2 or dt1 < dt2;
end '<=';
encapsulated operator '-' "Unary and binary minus"
import Modelica.Utilities.Time.DateTime;
import Modelica.Icons;
extends Icons.FunctionsPackage;
function subtract "Return time delta between dt2 and dt1 as Duration"
extends Icons.Function;
import Modelica.Utilities.Time.Duration;
input DateTime dt1;
input DateTime dt2;
output Duration result "= dt1 - dt2";
algorithm
result := Duration.'constructor'.fromDateTimes(dt2, dt1);
end subtract;
end '-';
encapsulated function epoch "Convert DateTime to elapsed seconds since custom epoch year"
import Modelica.Utilities.Time.DateTime;
import Modelica.Utilities.Time.isLeapYear;
import Modelica.Icons;
extends Icons.Function;
input DateTime dt;
input Integer epoch_year = 1970 "Reference year";
output Real seconds "Elapsed seconds since epoch_year";
protected
Integer[2,12] days_passed = {{0,31,59,90,120,151,181,212,243,273,304,334},
{0,31,60,91,121,152,182,213,244,274,305,335}};
Integer leap_days, day_of_year;
Integer leap_years_til_epoch;
Integer j;
// Aux variables for shorter access in code
Integer millisecond=dt.millisecond "Millisecond";
Integer second=dt.second "Second";
Integer minute=dt.minute "Minute";
Integer hour=dt.hour "Hour";
Integer day=dt.day "Day";
Integer month=dt.month "Month";
Integer year=dt.year "Year";
algorithm
// get leap years from year 0 until the chosen epoch year
leap_years_til_epoch :=integer(epoch_year/4) - integer((epoch_year)/100) + integer((epoch_year)/400);
// get leap days of passed years since epoch year
leap_days :=integer((year-1)/4) - integer((year-1)/100) + integer((year-1)/400) - leap_years_til_epoch;
// get current day of year and consider leap day if current year is leap year and february has passed
j := if isLeapYear(year) then 2 else 1;
day_of_year :=day + days_passed[j,month];
seconds :=millisecond/1000 + second + 60*(minute + 60*(hour + 24*(day_of_year-1 + leap_days + 365*(year-epoch_year))));
end epoch;
encapsulated function now "Get current system date and time as DateTime"
import Modelica.Utilities.Time.DateTime;
output DateTime now;
algorithm
now:=DateTime.'constructor'.fromSystemTime();
end now;
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote>
<pre>
Time.<strong>DateTime</strong>();
Time.<strong>DateTime</strong>(year, month, day, hour, minute, second, millisecond);
Time.<strong>DateTime</strong>(seconds);
Time.<strong>DateTime</strong>(seconds, epoch_year);
</pre>
</blockquote>
<h4>Description</h4>
<p>
The operator record DateTime stores the required information to address a specific point in time via date and time values.
</p>
<p>
There are multiple constructors provided to create a DateTime element. See the examples below for details.
</p>
<p>
DateTimes can be compared (==, <>, >, <, ≥, ≤), giving a boolean result and subtracted (-), giving a Duration.
</p>
<p>
DateTimes can be converted to an epoch representation with the function DateTime.epoch(dt, epoch_year).
</p>
<h4>Example</h4>
The examples below demonstrate the different methods to create a DateTime record.
<blockquote>
<pre>
import Modelica.Utilities.Time.DateTime;
// Create DateTime records from the current system time
DateTime(); // create DateTime record using default constructor, which is fromSystemTime
DateTime.'constructor'.fromSystemTime(); // explicit call of constructor
DateTime.now(); // convenience function for explicit call of constructor fromSystemTime
// Create DateTime records manually by setting each field
DateTime.'constructor'.fromReadable(2020, 01, 31, 14, 40, 50, 500); // explicit call of constructor
DateTime(2020, 01, 31, 14, 40, 50, 500); // automatic selection of constructor fromReadable
// Create DateTime records manually using the elapsed seconds since the given epoch year
DateTime(seconds=1); // automatic selection of constructor fromEpoch
DateTime.'constructor'.fromEpoch(1); // explicit call of constructor. 1s passed since default epoch year 1970
DateTime.'constructor'.fromEpoch(1000, 2020); // explicit call of constructor. 1000s passed since custom epoch year 2020
</pre>
</blockquote>
</html>"));
end DateTime;
operator record Duration "Duration record with several constructors and overloaded operators"
extends Modelica.Icons.Record;
Integer days "Days";
Integer hours "Hours";
Integer minutes "Minutes";
Integer seconds "Seconds";
Integer milliseconds "Milliseconds";
encapsulated operator 'constructor' "Available constructors"
import Modelica.Utilities.Time.Duration;
import Modelica.Icons;
extends Icons.FunctionsPackage;
function fromInput "Create Duration field by field from user input"
extends Icons.Function;
input Integer days=0 "Days";
input Integer hours=0 "Hours";
input Integer minutes=0 "Minutes";
input Integer seconds=0 "Seconds";
input Integer milliseconds=0 "Milliseconds";
output Duration d(days=days, hours=hours, minutes=minutes, seconds=seconds, milliseconds=milliseconds);
algorithm
end fromInput;
function fromDateTimes "Create Duration from two DateTime records"
import Modelica.Utilities.Time.DateTime;
import Modelica.Math.nearestInteger;
extends Icons.Function;
input DateTime dt1 "Start time";
input DateTime dt2 "End time";
output Duration d "= dt2 - dt1";
protected
Real diff;
Integer sign_;
Real e1, e2;
DateTime dt_tmp;
Integer days "Elapsed days";
Integer hours "Elapsed hours";
Integer minutes "Elapsed minutes";
Integer seconds "Elapsed seconds";
Integer milliseconds "Elapsed milliseconds";
algorithm
dt_tmp :=dt2;
e1 :=DateTime.epoch(dt1, epoch_year=dt1.year);
e2 :=DateTime.epoch(dt_tmp, epoch_year=dt1.year);
diff :=abs(e2 - e1);
sign_ :=sign(e2 - e1);
days := integer(diff/(24*3600));
hours := integer(diff/3600-days*24);
minutes := integer((diff-(days*24+hours)*3600)/60);
seconds := integer(diff - (days*24+hours)*3600 - minutes*60);
milliseconds := nearestInteger(rem(diff,1)*1000);
hours := sign_*hours;
minutes := sign_*minutes;
seconds := sign_*seconds;
milliseconds := sign_*milliseconds;
d :=Duration(days=days, hours=hours, minutes=minutes, seconds=seconds, milliseconds=milliseconds);
end fromDateTimes;
function fromSeconds "Create duration record from total amount of seconds, rounding to the third decimal"
extends Icons.Function;
import Modelica.Math.nearestInteger;
input Real totalSeconds "Duration in seconds. Decimal place is converted to milliseconds";
output Duration d "Duration with input converted to seconds and milliseconds";
protected
Integer days, hours, minutes, seconds, milliseconds;
Integer carryover;
algorithm
milliseconds := nearestInteger(rem(totalSeconds, 1) * 1000);
seconds :=integer(div(totalSeconds, 1));
carryover :=div(seconds, 60);
seconds := rem(seconds, 60);
minutes :=carryover;
carryover :=div(minutes, 60);
minutes :=rem(minutes, 60);
hours :=carryover;
carryover :=div(hours, 24);
hours := rem(hours, 24);
days := carryover;
d :=Duration(
days=days,
hours=hours,
minutes=minutes,
seconds=seconds,
milliseconds=milliseconds);
end fromSeconds;
end 'constructor';
encapsulated operator 'String' "Convert Duration to string"
import Modelica.Utilities.Time.Duration;
import Modelica.Utilities.Strings.replace;
import Modelica.Icons;
extends Icons.FunctionsPackage;
function formated "Convert duration to string, using C inspired conversion specifier characters"
import Modelica.Utilities.Strings.contains;
extends Icons.Function;
input Duration d;
input String format = "%daysd %hoursh %minutesmin %secondss %millisecondsms";
output String str;
protected
Duration d2;
encapsulated function string0 "Create string with minimum length, filled with 0"
import Modelica.Utilities.Strings.replace;
input Integer i;
input Integer l;
output String s0;
algorithm
s0 :=replace(String(i, minimumLength=l, leftJustified=false), " ", "0");
end string0;
algorithm
d2 :=d;
if not contains(format, "%days") and not contains(format, "%d") then
d2.hours :=d2.hours + d2.days*24;
end if;
if not contains(format, "%hours") and not contains(format, "%H") then
d2.minutes :=d2.minutes + d2.hours*60;
end if;
if not contains(format, "%minutes") and not contains(format, "%M") then
d2.seconds :=d2.seconds + d2.minutes*60;
end if;
if not contains(format, "%seconds") and not contains(format, "%S") then
d2.milliseconds :=d2.milliseconds + d2.seconds*1000;
end if;
str :=replace(format, "%%", "%");
str :=replace(str, "%days", String( d2.days));
str :=replace(str, "%d", string0(d2.days, l=2));
str :=replace(str, "%hours", String( d2.hours));
str :=replace(str, "%H", string0(d2.hours, l=2));
str :=replace(str, "%minutes", String( d2.minutes));
str :=replace(str, "%M", string0(d2.minutes, l=2));
str :=replace(str, "%seconds", String( d2.seconds));
str :=replace(str, "%S", string0(d2.seconds, l=2));
str :=replace(str, "%milliseconds", String( d2.milliseconds));
str :=replace(str, "%L", string0(d2.milliseconds, l=3));
annotation (Documentation(info="<html>
<h4>Syntax</h4>
<blockquote>
<pre>
String(d)
String(d, format)
</pre>
</blockquote>
<h4>Description</h4>
<p>
The input value \"d\" of type Duration is converted to a string.
</p>
<p>
The content of the output string can be controlled
via the \"format\" string by setting one or more of the conversion specifiers listed below.
</p>
<p>
If higher time value are not included, they are added to the next lower time value.
If e.g. days are not part of the format string, but hours, the number of days will be converted
to hours and added to the hours value.
</p>
<p>
If lower time values are not included, they are neglected.
If e.g. only days and hours are part of the format string, minutes, seconds and milliseconds will be ignored.
</p>
<table border=\"1\" cellpadding=\"2\" cellspacing=\"0\">
<tr>
<th>Specifier</th>
<th>Meaning</th>
<th>Examples</th>
</tr>
<tr>
<td>%d</td>
<td>number of days, zero padded to length 2</td>
<td>01, 02, ...</td>
</tr>
<tr>
<td>%days</td>
<td>number of days as simple decimal</td>
<td>1, 2, ...</td>
</tr>
<tr>
<td>%H</td>
<td>number of hours, zero padded to length 2</td>
<td>00, 01, ...</td>
</tr>
<tr>
<td>%hours</td>
<td>number of hours as simple decimal</td>
<td>0, 1, ...</td>
</tr>
<tr>
<td>%M</td>
<td>number of minutes, zero padded to length 2</td>
<td>00, 01, ...</td>
</tr>
<tr>
<td>%minutes</td>
<td>number of minutes as simple decimal</td>
<td>0, 1, ...</td>
</tr>
<tr>
<td>%S</td>
<td>number of seconds, zero padded to length 2</td>
<td>00, 01, ...</td>
</tr>
<tr>
<td>%seconds</td>
<td>number of seconds as simple decimal</td>
<td>0, 1, ...</td>
</tr>
<tr>
<td>%L</td>
<td>number of milliseconds, zero padded to length 3</td>
<td>00, 01, ...</td>
</tr>
<tr>
<td>%milliseconds</td>
<td>number of milliseconds as simple decimal</td>
<td>0, 1, ...</td>
</tr>
<tr>
<td>%%</td>
<td>single percent character. Not fully supported. See the Limitations section below.</td>
<td>%</td>
</tr>
</table>
<h4>Example</h4>
<blockquote>
<pre>
import Modelica.Utilities.Time.Duration;
d = Duration(days=1, hour=2, minutes=3, seconds=4, milliseconds=5);
String(d) // = \"1d 2h 3min 4s 5ms\"
String(d, \"%hoursh %secondss\") // = \"26h 184s\" (days are included in hours, minutes in seconds, ms stripped off)
String(d, format=\"%Hh %S.%L''\") // = \"26h 184.005''\" (days are included in hours, minutes in seconds)
String(d, format=\"%days'\") // = \"1\" (only full days are shown, rest is stripped off)
</pre>
</blockquote>
<h4>Limitations</h4>
<p>
This function uses simple string replace methods to exchange the conversion specifiers with the appropriate values.
</p>
<p>
When additional % characters are included in the format string (via %%) problems can occur, like shown below.
</p>
<blockquote>
<pre>
// ANTI-EXAMPLE - do not use
String(d, format=\"%%days\") // Should give \"%days\", but gives \"1\" instead
</pre>
</blockquote>
</html>"));
end formated;