-
Notifications
You must be signed in to change notification settings - Fork 4
/
datastorage.m
2362 lines (2359 loc) · 100 KB
/
datastorage.m
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
classdef datastorage
%static
properties(Constant)
%default value of some internal parameters
parameter_list={...
'start', time.zero_date,@isdatetime;...
'stop', time.inf_date, @isdatetime;...
'debug', false, @islogical;...
'start_timestamp_only',true, @islogical;...
'inclusive', false, @islogical;...
};
end
%public
properties(GetAccess=public,SetAccess=public)
debug
inclusive
end
%read only
properties(SetAccess=private)
data
end
%private (visible only to this object)
properties(GetAccess=private)
starti
stopi
end
%calculated only when asked for
properties(Dependent)
start
stop
end
methods(Static)
function out=parameters(varargin)
persistent v
if isempty(v); v=varargs(datastorage.parameter_list); end
out=v.picker(varargin{:});
end
% function out=id(in,data_type,varargin)
% switch lower(data_type)
% case {'dataname','datanames','dn'}
% assert(numel(varargin)==1,['If datastorage.id is called with ''data_type'' as ''',data_type,...
% ''', then can only handle one optional input argument, not ',num2str(numel(varargin)),'.'])
% out=datanames(in,varargin{:});
% case {'product','products','dp'}
% out=dataproduct(in,varargin{:});
% otherwise
% assert(numel(varargin)==0,['If datastorage.id is called with ''data_type'' as ''',data_type,...
% ''', then can not handle any optional input argument (while ',num2str(numel(varargin)),' were given).'])
% out=datanames(in);
% out=out.(data_type);
% end
% end
end
methods
%% constructor
function obj=datastorage(varargin)
obj.log('@','in','varargin',varargin)
% reset data type list
obj=obj.data_init;
%create argument object, declare and parse parameters, save them to obj
[~,~,obj]=varargs.wrap('sinks',{obj},'sources',{datastorage.parameters('obj')},varargin{:});
% data is added to this initialized object with the 'init' method (see below)
obj.log('@','out')
end
function out=isempty(obj)
out=isempty(obj.data);
end
%% debug logging
function log(obj,varargin)
%don't do anything unless debug mode is on
if ~obj.debug
return
end
%sanity on the nr of input arguments
assert(mod(numel(varargin),2)==0,['the number of input arguments must be even, not ',num2str(numel(varargin)),'.'])
%make room for message
msg=cell((nargin-1)/2,1);
%loop over all arguments
for i=1:numel(msg)
idx_name=2*i-1;
idx_value=2*i;
%don't show empty arguments
if isempty(varargin{idx_value})
continue;
end
msg{i}=[varargin{idx_name},' ',str.show(varargin{idx_value})];
end
%clean up empty cells
msg=cells.rm_empty(msg);
%show the debug message
str.say('say_stack_delta',2,strjoin(msg,', '))
end
%% dataname operations (done at the root level of the obj.data structure)
function obj=data_init(obj)
obj.data=struct([]);
end
function out=isdata_empty(obj,dn)
%reduce dataname to common object
dn=datanames(dn);
%check is empty
out=~isfield(obj.data,dn.name_clean) || isempty(obj.data.(dn.name_clean));
%in case field_path is non-empty, check that too
if ~out && ~isempty(dn.field_path)
out=isempty(structs.get_value(obj.data.(dn.name_clean),dn.field_path));
end
end
function out=dataname_list(obj,non_empty)
out=datanames.array(fieldnames(obj.data));
if exist('non_empty','var') && non_empty
empty_idx=cellfun(@(i) isempty(obj.data.(i.name)),out);
out=out(~empty_idx);
end
end
function peek(obj,dn_list,varargin)
if obj.isempty
return
end
%look at all datanames by default
if ~exist('dn','var') || isempty(dn_list)
dn_list='all';
end
%parse optional arguments
p=machinery.inputParser;
p.addParameter('info_methods',{'size','nr_gaps','start','stop','first','last'}, @(i) ischar(i) || iscellstr(i));
p.addParameter('tab_info_methods',[12,7,20,20,20,20], @isnumeric);
p.addParameter('tab_product_names',42, @num.isscalar);
p.parse(varargin{:});
tab=[p.Results.tab_product_names,p.Results.tab_info_methods];
%show header
disp(str.tablify(tab,'product',p.Results.info_methods{:}))
%retrieve global field path list
obj_list=obj.data_get(dn_list);
dn_list=obj.data_list(dn_list);
%loop over all retrieved objects
for i=1:numel(obj_list)
msg=cell(size(p.Results.info_methods));
if isempty(obj_list{i})
msg(:)={'-'};
else
for m=1:numel(p.Results.info_methods)
%NOTICE: 'msg{m}=str.show(' below captures when there's a non-scalar vallue (as is the case with 'size')
if ismethod(obj_list{i},p.Results.info_methods{m})
msg{m}=str.show(eval([p.Results.info_methods{m},'(obj_list{i})']));
%NOTICE: any(isprop(...)) catches when obj_list{i} is a string
elseif any(isprop(obj_list{i},p.Results.info_methods{m}))
msg{m}=str.show(obj_list{i}.(p.Results.info_methods{m}));
else
msg{m}='N/A';
end
end
end
if ~all(...
cellfun(@(i) strcmp(i,'N/A' ),msg(2:end)) | ...
cellfun(@(i) strcmp(i,'0' ),msg(2:end)) | ...
cellfun(@(i) strcmp(i,'00-Jan-0000'),msg(2:end))...
)
disp(str.tablify(tab,dn_list{i}.str,msg{:}))
end
end
end
function da(obj,dn_list,varargin)
if obj.isempty
return
end
%look at all datanames by default
if ~exist('dn','var') || isempty(dn_list)
dn_list='all';
end
%parse optional arguments
p=machinery.inputParser;
p.addParameter('info_method','nr_gaps', @ischar);
p.addParameter('tab',[32,11], @isnumeric);
p.addParameter('period',days(1), @isduration);
p.addParameter('group',10, @num.isscalar);
p.parse(varargin{:});
%gather list of periods
[startlist,stoplist]=time.list(obj.start,obj.stop,p.Results.period);
%split list of periods into groups of 10 (otherwise it' difficult to see anything in the screen)
n=ceil(numel(startlist)/p.Results.group);
list0=cell(1,n);
list1=cell(1,n);
for i=1:n
start_idx=(i-1)*p.Results.group+1;
stop_idx=min([i*p.Results.group,numel(startlist)]);
list0{i}=startlist(start_idx:stop_idx);
list1{i}=stoplist( start_idx:stop_idx);
end
%show header
disp(str.show({'Showing',p.Results.info_method,'for periods of',p.Results.period,'.'}))
for l=1:n
disp(str.tablify(p.Results.tab,'product',list0{l}))
%retrieve global field path list
obj_list=obj.data_get(dn_list);
dn_list=obj.data_list(dn_list);
%loop over all retrieved objects
for i=1:numel(obj_list)
msg=cell(size(list0{l}));
if isempty(obj_list{i})
msg(:)={'-'};
else
for m=1:numel(list0{l})
%try to get the requested information
try
%get the requested info for the current data period
msg{m}=obj_list{i}.trim(list0{l}(m),list1{l}(m)).(p.Results.info_method);
catch
%patch with N/A
msg{m}='N/A';
end
end
end
disp(str.tablify(p.Results.tab,dn_list{i}.str,msg))
end
end
end
%% value operations (basically wraps some methods in the structs object; this is serialized!)
function out=value_get(obj,dn)
%reduce dataname to common object
dn=datanames(dn);
%retrieve value ('true' allows for structs.get_value to loop along dn.field_path
% until it refers to field available in obj.data.(dn.name_clean))
out=structs.get_value(obj.data.(dn.name_clean),dn.field_path,true);
end
function obj=value_set(obj,dn,value)
%reduce dataname to common object
dn=datanames(dn);
%make sure this dataname has been initiated
if ~isfield(obj.data,dn.name_clean)
obj.data(1).(dn.name_clean)={};
end
obj.data.(dn.name_clean)=structs.set_value(...
obj.data.(dn.name_clean),...
dn.field_path,...
value...
);
end
%% data operations (this is serialized!)
function out=isdata_leaf(obj,dn,varargin)
p=machinery.inputParser;
p.addParameter('only_non_empty',false,@(i) islogical(i) && isscalar(i));
p.parse(varargin{:});
%reduce dataname to common object
dn=datanames(dn);
%determine leafness (structs.isleaf returns empty structures as leafs by default, only_non_empty changes that)
out=~isfield(obj.data,dn.name_clean) || structs.isleaf(obj.data.(dn.name_clean),dn.field_path,p.Results.only_non_empty);
end
function dn_list=data_list(obj,dn,varargin)
p=machinery.inputParser;
p.addParameter('direct_access',false,@(i) islogical(i) && isscalar(i));
p.parse(varargin{:});
if numel(dn)==0
%trivial call
dn_list={};
return
elseif ischar(dn) && strcmp(dn,'all')
%handle named inputs
dn_list=obj.data_list(obj.dataname_list(true));
return
elseif numel(dn)>1 && ~ischar(dn)
%vector mode
assert(iscell(dn),['when dealing with non-scalar input ''dn'', can only deal with cells, not with ',class(dn),'.'])
dn_list=cells.flatten(cellfun(@obj.data_list,dn,'UniformOutput',false));
return
elseif isa(dn,'datanames') && any(strcmp(dn.field_path,'*'))
%get field_path list that matches input globbed field_path
field_path_globbed=structs.field_list_glob(obj.data.(dn.name_clean),dn.field_path);
%build list of datanames for this globbed field_path
dn_list=cell(size(field_path_globbed));
for i=1:numel(field_path_globbed)
%patch globbed field_path
dn_list{i}=datanames(dn.name,field_path_globbed{i});
end
return
else
%reduce dataname to common object
dn=datanames(dn);
end
%scalar mode
%check if this dataname is a leaf product or if direct access is requested
if obj.isdata_leaf(dn,varargin{:}) || p.Results.direct_access
field_path_list={dn.field_path};
else
%get all field names under dn.field_path
field_path_list=structs.field_list(structs.get_value(obj.data.(dn.name_clean),dn.field_path));
%prepend current dn.field_path
for i=1:numel(field_path_list)
field_path_list{i}=[dn.field_path,field_path_list{i}];
end
end
%handle empty field_path_list
if isempty(field_path_list)
dn_list={};
return
end
%be sure this is a cell of cells
assert(cells.iscellofcells(field_path_list,1),'variable ''field_path_list'' must be a cell of cells.')
%propagate field path list to list of dataname objects
dn_list=cellfun(@(i) dn.set_field_path(i),field_path_list,'UniformOutput',false);
end
function out=data_get(obj,dn,varargin)
%reduce dataname to common object
dn_list=obj.data_list(dn,varargin{:});
%retrieve
out=cell(size(dn_list));
for i=1:numel(dn_list)
if isfield(obj.data,dn_list{i}.name_clean)
out{i}=obj.value_get(dn_list{i});
end
end
end
%scalar mode is useful when calling this function as part of an expression
function out=data_get_scalar(obj,dn)
%call mother routine
out=data_get(obj,dn);
%some sanity
assert(numel(out)==1,'This routine cannot handle non-scalar data entries.')
%reduce to scalar
out=out{1};
end
function obj=data_set(obj,dn,values)
%reduce dataname to common object
dn_list=obj.data_list(dn);
values=cells.scalar(values,'set');
%TODO: I question the usefulness of this, need to be sure it does not break things
% %handle scalar values, unwrap them to all field paths
% if numel(values)==1 && ~iscell(values)
% tmp=values;
% values=cell(size(dn_list));
% values{:}=tmp;
% end
%check if fiels paths and values have the same length
assert(numel(dn_list)==numel(values),'Cannot handle inputs ''in'' and ''values''.')
%propagate
for i=1:numel(dn_list)
%try to match field names in structures with field paths
if isstruct(values{i})
tmp=structs.get_value(values{i},dn_list{1}.field_path);
if ~isempty(tmp)
obj=obj.value_set(dn_list{i},tmp);
else
assert(isempty(dn_list{1}.field_path),[...
'Cannot find field path ''',dn_list{1}.field_path_str,''' in product ''',dn_list{1}.filename,'''.'])
obj=obj.value_set(dn_list{i},values{i});
end
else
obj=obj.value_set(dn_list{i},values{i});
end
end
end
%% vector data operations, done over multiple datanames and all corresponding 'field_path's
% Applies the function f to all data entries and returns the result,
% so it transforms (tr) a list of objects into something else.
function out=vector_func_tr(obj,dn,f,varargin)
%collapse requested data into cell array and operate on the cell array
out=cellfun(@(i) f(i,varargin{:}),obj.data_get(dn));
end
% Applies the function f to all data entries under 'dn' and
% saves the resulting objects back to the same set, using data_set(...)
function obj=vector_func_op(obj,dn,f,varargin)
%operate on the requested set
values=obj.vector_tr(dn,f,varargin{:});
%sanity
if ~iscell(values)
error(['function ',fun2str(f),' must return a cell array, not a ',class(values),'.'])
end
%propagate cell array back to object
obj=obj.data_set(dn,values);
end
% Retrieves the values of particular field or a method from the
% object stored at the leaves of all data entries (used to be called vector_sts)
function [out,dn_list]=vector_method_tr(obj,dn,method,varargin)
%get data entries under 'dn'
dn_list=obj.data_list(dn);
%retrieve list of objects, i.e. the values given by obj.data_get
obj_list=obj.data_get(dn_list);
%shortcut to explicit literal methods (such as those defined in top level of structs)
shortcut_methods=cellfun(@(i) i.isfield_path_leaf(method),dn_list);
if any(shortcut_methods)
obj.log('@','shortcut methods','dn',dn,'method',method,'shortcut methods',dn_list(shortcut_methods),'shortcut values',obj_list(shortcut_methods))
out=obj_list(shortcut_methods);
dn_list=dn_list(shortcut_methods);
return
end
% NOTICE: below, this code serializes the fields in 'dn' and checks each entry if it
% responds to 'method', so fields with the same name as 'method' are ignored
%make room for outputs
out=cell(size(obj_list));
%loop over all objects
for i=1:numel(obj_list)
if isempty(obj_list{i})
out{i}=[];
else
%check if this object responds to this method
if structs.respondto(obj_list{i},method)
if numel(varargin)==0
out{i}=obj_list{i}.(method);
else
out{i}=obj_list{i}.(method)(varargin{:});
end
end
end
end
end
% Applies the given method to all data entries under 'dn' and
% saves the resulting objects back to the same set, using data_set(...)
function obj=vector_method_op(obj,dn,method,varargin)
%operate on the requested set
[values,dn_list]=vector_method_tr(obj,dn,method,varargin{:});
%propagate cell array back to object
obj=obj.data_set(dn_list,values);
end
% Sets the values of particular field or zero-input method of the
% object stored at the leaves of all data entries
function obj=vector_method_set(obj,dn,method,value)
%get data entries under 'dn'
dn_list=obj.data_list(dn);
%retrieve list of objects, i.e. the values given by obj.data_get
obj_list=obj.data_get(dn_list);
%loop over all objects
for i=1:numel(obj_list)
if ~isempty(obj_list{i})
%check if this object responds to this
if structs.respondto(obj_list{i},method)
obj_list{i}.(method)=value;
end
end
end
%propagate cell array back to object
obj=obj.data_set(dn_list,obj_list);
end
% Applies a 2-argument method to the data given by obj and obj2
function obj=vector_obj_op2(obj,dn,obj2,method,varargin)
%operate on the requested set
values1=obj.data_get(dn);
values2=obj2.data_get(dn);
%sanity
if numel(values1) ~= numel(values2)
error('the given dataname list does not correspond to the same number of data entries in both input obj.')
end
if any(numel(cells.rm_empty(values1))~=numel(cells.rm_empty(values2)))
error('the given dataname list does not have data in both objects. Debug needed.')
end
%outputs
result=cell(size(values1));
%operate
for i=1:numel(values1)
result{i}=values1{i}.(method)(values2{i},varargin{:});
end
%propagate cell array with results back to object
obj=obj.data_set(dn,result);
end
% Applies a 2-argument method to the data given by dn1 and dn2 and
% saves it in dn_out
function obj=vector_obj_op3(obj,dn1,dn2,method,dn_out,varargin)
%operate on the requested set
values1=obj.data_get(dn1);
values2=obj.data_get(dn2);
%sanity
if numel(values1) ~= numel(values2)
error('the given dataname list does not correspond to the same number of data entries in both input obj.')
end
%outputs
result=cell(size(values1));
%operate
for i=1:numel(values1)
%enforce common time domain both ways
values2{i}=values2{i}.interp2(values1{i},varargin{:},'check_width',false,'skip_par_check',{'lmax','labels','units'});
values1{i}=values1{i}.interp2(values2{i},varargin{:},'check_width',false,'skip_par_check',{'lmax','labels','units'});
%apply method
result{i}=values1{i}.(method)(values2{i},varargin{:});
end
%propagate cell array with results back to object
obj=obj.data_set(dn_out,result);
end
%% start/stop operations
%returns the start date out of the vector of dates 'io', according to the current valid criteria (as defined in obj.inclusive)
function io=start_criteria(obj,io)
assert(~isempty(io),'Cannot handle empty ''io''.')
%NOTICE: this makes it possible to have time-independent field paths, which need to
%be handled explicitly by whatever method deals with them
if iscell(io)
io=cells.rm_empty(io);
assert(all(cellfun(@isdatetime,io)),'Can only handle cell arrays of datetime')
elseif isdatetime(io)
io=cells.m2c(io(~isempty(io)));
else
error(['Can only handle cells or vectors of datetime, not ',class(io)'.'])
end
%need to filter out invalids (zero and inf dates)
invalid_idx=~time.isfinite(io);
if any(invalid_idx); io(invalid_idx)={time.zero_date}; end
%hanle inclusive datasets (span over all boundaries)
if obj.inclusive
if isempty(io)
io=time.zero_date;
else
io=min([io{:}]);
end
else
io=max([io{:}]);
end
end
%returns the stop date out of the vector of dates 'io', according to the current valid criteria (as defined in obj.inclusive)
function io=stop_criteria(obj,io)
assert(~isempty(io),'Cannot handle empty ''values''.')
%NOTICE: this makes it possible to have time-independent field paths, which need to
%be handled explicitly by whatever method deals with them
if iscell(io)
io=cells.rm_empty(io);
assert(all(cellfun(@isdatetime,io)),'Can only handle cell arrays of datetime')
elseif isdatetime(io)
io=cells.m2c(io(isfinite(io)));
else
error(['Can only handle cells or vectors of datetime, not ',class(io)'.'])
end
%need to filter out invalids (zero and inf dates)
invalid_idx=~time.isfinite(io);
if any(invalid_idx); io(invalid_idx)={time.inf_date}; end
%hanle inclusive datasets (span over all boundaries)
if obj.inclusive
if isempty(io)
io=time.inf_date;
else
io=max([io{:}]);
end
else
io=min([io{:}]);
end
end
%retrieves the start date ouf of products 'dn', according to the current valid criteria (as defined in obj.inclusive)
function out=start_retrieve(obj,dn)
out=obj.start_criteria(obj.vector_method_tr(dn,'start'));
end
%retrieves the stop date ouf of products 'dn', according to the current valid criteria (as defined in obj.inclusive)
function out=stop_retrieve(obj,dn)
out=obj.stop_criteria(obj.vector_method_tr(dn,'stop'));
end
function out=get.start(obj); out=obj.starti; end
function out=get.stop(obj); out=obj.stopi; end
%NOTICE: use obj.startstop_update instead of this method so that the inclusive flag is handled properly
function obj=set.start(obj,start)
%save current global start value
old_start=obj.starti;
%check if updating is needed
if isempty(obj.starti) || start==obj.start_criteria({obj.starti,start})
%don't report routine inits
if ~time.iszero(start) && ~isempty(obj.starti) && obj.starti~=start
obj.log('@','start update','from',obj.starti,'to',start)
end
%update internal record
obj.starti=start;
end
%check if something changed (also trims newly added data that starts before old_start)
if isempty(old_start) || start~=old_start
%trim all data entries
obj=obj.vector_method_set('all','start',obj.starti);
end
end
%NOTICE: use obj.startstop_update instead of this method so that the inclusive flag is handled properly
function obj=set.stop(obj,stop)
%save current global stop value
old_stop=obj.stopi;
%update if needed
if isempty(obj.stopi) || stop==obj.stop_criteria({obj.stopi,stop})
%don't report routine inits
if ~time.isinf(stop) && ~isempty(obj.stopi) && obj.stopi~=stop
obj.log('@','stop update','from',obj.stopi,'to',stop)
end
%update internal record
obj.stopi=stop;
end
%check if something changed (also trims newly added data that end after old_stop)
if isempty(old_stop) || stop~=old_stop
%trim all data entries
obj=obj.vector_method_set('all','stop',obj.stopi);
end
end
%NOTICE: this is the same as obj.startstop_update, except is can act on specific products (with 'dn_list')
function obj_out=trim(obj,varargin)
p=machinery.inputParser;
p.addParameter('start', obj.start,@(i) isdatetime(i) && isscalar(i));
p.addParameter('stop', obj.stop, @(i) isdatetime(i) && isscalar(i));
p.addParameter('dn_list',obj.data_list('all'), @iscell);
p.parse(varargin{:});
obj_out=obj.data_init.data_set(p.Results.dn_list,obj.data_get(p.Results.dn_list));
obj_out.inclusive=obj.inclusive;
obj_out=obj_out.startstop_update('start',p.Results.start,'stop',p.Results.stop,varargin{:});
end
%NOTICE: resolves the inclusing flag according to the following pecking order:
% 1. what is defined in all(product(s)) (can be empty)
% 2. what is passed in varargin
% 3. what is defined in obj.inclusive
function out=is_inclusive(obj,varargin)
v=varargs.wrap('sources',{...
{...
'inclusive', obj.inclusive , @(i) islogical(i) && isscalar(i); ...
'product', {} , @(i) iscell(i) && all(cellfun(@(j) isa(j,'dataproduct'),i)); ...
},...
},varargin{:});
% resolve it
if isempty(v.product)
out=v.inclusive;
else
%NOTICE: all products need to be inclusive, for this to resolve to inclusive as well
out=all(cellfun(@(i) i.mdget('inclusive','default',v.inclusive),v.product));
end
end
%NOTICE: temporarily sets obj.inclusive according to obj.is_inclusive, so that product and varargin inclusive flags are enforced
%NOTICE: will resolve start/stop from varargin and product, so to force a certain start/stop, do not pass a product
function obj=startstop_update(obj,varargin)
v=varargs.wrap('sources',{...
{...
'start', obj.start , @isdatetime; ...
'stop', obj.stop , @isdatetime; ...
'product', {} , @(i) iscell(i) && all(cellfun(@(j) isa(j,'dataproduct'),i)); ...
},...
},varargin{:});
obj.log('@','in','product(s)',cellfun(@(i) i.name,v.product,'UniformOutput',false),'start',obj.start,'stop',obj.stop,'inclusive',obj.inclusive)
%save current value of object-wide inclusive flag
inclusive_old=obj.inclusive;
% force input inclusive flag
obj.inclusive=obj.is_inclusive(varargin{:});
obj.log('updated inclusive',obj.inclusive)
% handle potential input products
if ~isempty(v.product)
start_list=obj.vector_method_tr(v.product,'start');
stop_list=obj.vector_method_tr(v.product,'stop');
else
start_list={};
stop_list={};
end
% append start/stop from varargin
start_list{end+1}=v.start;
stop_list{end+1}=v.stop;
%enforce start/stop
obj.start=obj.start_criteria(start_list);
obj.stop=obj.stop_criteria( stop_list);
%recover old value of inclusive flag
obj.inclusive=inclusive_old;
obj.log('@','out','product(s)',cellfun(@(i) i.name,v.product,'UniformOutput',false),'start',obj.start,'stop',obj.stop,'inclusive',obj.inclusive)
end
function [startlist,stoplist]=startstop_list(~,s_in)
if isstruct(s_in)
%first check if structure has explicit start/stop fields,
if isfield(s_in,'start') && isfield(s_in,'stop')
%use explicit start/stop fields
startlist=s_in.start;
stoplist=s_in.stop;
return
end
% serialize the data
s_cells=structs.get_value_all(s_in);
else
s_cells={s_in};
end
% catch unvalid s_in
time_vars=cells.respondto(s_cells,'start')&cells.respondto(s_cells,'stop');
if all(~time_vars)
startlist=[];stoplist=[];
else
% get list of start/stop dates from the data
startlist=cells.c2m(cellfun(@(i) i.start,s_cells(time_vars),'UniformOutput',false));
stoplist =cells.c2m(cellfun(@(i) i.stop, s_cells(time_vars),'UniformOutput',false));
end
end
%% time operations
function out=istequal(obj,dn)
%retrieve global field path list
global_field_path_list=obj.data_list(dn);
%default value
out=true;
%use the first object as reference
obj1=obj.data_get_scalar(global_field_path_list{1});
%loop over all remaining objects
for i=2:numel(global_field_path_list)
%check of the time domains agree
if ~obj1.istequal(obj.data_get_scalar(global_field_path_list{i}))
out=false;
return
end
end
end
function obj=interp(obj,dn)
%trivial call
if obj.istequal(dn)
return
end
%retrieve global field path list
global_field_path_list=obj.data_list(dn);
%use the first object as reference
obj_ref=obj.data_get_scalar(global_field_path_list{1});
%loop over all remaining objects (do it twice to be sure all time domains are the same)
for j=0:1
%the last object is for sure already merged on the second run, skip that
for i=2:numel(global_field_path_list)-j
%interpolate (with merging the time domains)
obj=obj.data_set(global_field_path_list{i},...
obj.data_get_scalar(global_field_path_list{i}).interp2(obj_ref)...
);
end
end
%sanity
assert(obj.istequal(dn),'Could not merge all time domains. Debug needed.')
end
%% overloaded operations
function out=length(obj,dn)
if ~exist('dn','var') || isempty(dn); dn='all'; end
out=cell2mat(obj.vector_method_tr(dn,'length'));
end
function out=overload_struct(~,s_in,method)
% serialize the data
if isstruct(s_in)
s_cells=structs.get_value_all(s_in);
elseif iscell(s_in)
s_cells=s_in(:);
else
s_cells={s_in};
end
%descriminate between properties and methods because matlab sucks
prop_vars=cells.isprop(s_cells,method);
meth_vars=cells.ismethod(s_cells,method);
% catch unvalid s_in
if all(~(prop_vars|meth_vars))
out=[];
return
end
%assign output
out=cell(size(s_cells));
%handle properties
if any(prop_vars)
% get list of property values from the data
out(prop_vars)=cellfun(@(i) i.(method),s_cells(prop_vars),'UniformOutput',false);
end
%handle methods
if any(meth_vars)
% get list of method values from the data
out(meth_vars)=cellfun(@(i) eval([method,'(i)']),s_cells(meth_vars),'UniformOutput',false);
end
%better remove empties
out=cells.rm_empty(out);
end
%% debug utils
function print(obj,dn,varargin)
%show everything by default
if ~exist('dn','var') || isempty(dn)
dn='all';
end
%retrieve global field path list
obj_list=obj.data_get(dn);
dn_list=obj.data_list(dn);
%loop over all retrieved objects
for i=1:numel(obj_list)
disp(dn_list{i}.str)
if isempty(obj_list{i})
disp('empty')
else
obj_list{i}.print(varargin{:});
end
end
end
%% product interface
function [product,dn]=product_get(~,id,varargin)
product=dataproduct(id,varargin{:});
if nargout>1; dn=product.dataname; end
end
%% load/save operations
%NOTICE: data_edges is only relevant to the load method; for operations, better use the startstop_update methods (and friends)
%Compares the product start/stop values (if any) with the object start/stop and updates object according to exclusive_loading
function out=data_edges(obj,product,mode,exclusive_loading)
if ~exist('exclusive_loading','var') || isempty(exclusive_loading)
exclusive_loading=true;
end
if exclusive_loading
switch mode
case 'start'; f=@max;
case 'stop'; f=@min;
end
else
switch mode
case 'start'; f=@min;
case 'stop'; f=@max;
end
end
if product.ismdfield(mode)
out=f([obj.(mode),product.(mode)]);
else
out=obj.(mode);
end
end
function [obj,success]=load(obj,product,varargin)
%gather inputs
v=varargs.wrap('sources',{{...
'plot_product', false,@(i) islogical(i) && isscalar(i);...
'exclusive_loading', false,@(i) islogical(i) && isscalar(i);... %exclusive loading is false so that it is possible to ingest products with different time spans
'start_timestamp_only',datastorage.parameters('start_timestamp_only'),@islogical;... %this needs to be in agreement with what is used in datastorage.save
},product.metadata},varargin{:});
obj.log('@','in','product',product,'start',obj.start,'stop',obj.stop)
%ignore plot products, file loading is done inside the init method
if v.plot_product
%update the start/stop if any if these metadata entries are given
for i={'start','stop'}
if product.ismdfield(i{1})
%NOTICE: we're not using exclusive_loading here but ~obj.inclusive because this is a processing step, not a loading step
obj.(i{1})=obj.data_edges(product,i{1},~obj.inclusive);
end
end
success=false;
else
% get loading start/stop
start_load=obj.data_edges(product,'start',v.exclusive_loading);
stop_load=obj.data_edges(product,'stop', v.exclusive_loading);
% get the file list
file_list=product.file('data',...
'start',start_load,...
'stop', stop_load,...
'start_timestamp_only',v. start_timestamp_only,...
'discover',false,... %this needs to be false so that data stops after the one in the data produce names of non-existing files
'ensure_dir',false,...
varargin{:}...
);
% get file existence
file_exists=product.isfile('data',...
'start',start_load,...
'stop', stop_load,...
'start_timestamp_only',v. start_timestamp_only,...
varargin{:});
% check if any file is missing
if any(~file_exists)
success=false;
% debug output
if isempty(file_list)
obj.log('@','out','no files to load for',product)
else
obj.log('@','out','cannot load: file(s) missing for',[product.str,newline,strjoin(file_list(~file_exists),newline)])
end
return
end
obj.log('nr of files to load',numel(file_list),'from dir',fileparts(file_list{1}))
%loop over all files
for f=1:numel(file_list)
%load data in this file
load(file_list{f},'s');
if f==1
%move to cumulative variable
s_out=s;
else
%%append to cumulative data
if isstruct(s_out)
%do that for all fields in this structure
s_out=structs.objmethod2('append',s_out,s);
else
%simple call
s_out=s_out.append(s);
end
end
%get start/stop lists
[startlist,stoplist]=obj.startstop_list(s_out);
% debug output
start_now=obj.start_criteria(startlist);
stop_now =obj.stop_criteria( stoplist );
nr_gaps =max(cells.c2m(obj.overload_struct(s_out,'nr_gaps')));
nr_data =min(cells.c2m(obj.overload_struct(s_out,'length')));
[~,file_now,e]=fileparts(file_list{f});
obj.log(['loaded file ',num2str(f)],[file_now,e],...
'cdate',file.datestr(file_list{f}),...
'cum start',start_now,'cum stop',stop_now,...
'gaps',nr_gaps,'len',nr_data)
end
% enforce start/stop in metadata
%NOTICE: this handles the case when data is saved first and the start/stop metadata entries are increased/decreased (trimming the saved data)
%NOTICE: this does not handle decreasing/increased the start/stop metadata such that no new data file(s) is created (e.g. when using yearly or global storage_period)
s_out=structs.objmethod('trim',s_out,start_load,stop_load);
% save the data in the object
obj=obj.data_set(product,s_out);
% update start/stop
obj=obj.startstop_update('start',start_load,'stop',stop_load,'inclusive',~v.exclusive_loading);
% debug output
success=true;
end
obj.log('@','out','product',product,'start',obj.start,'stop',obj.stop)
end
function save(obj,product,varargin)
%gather inputs
v=varargs.wrap('sources',{{...
'force', false,@(i) islogical(i) && isscalar(i);...
'plot_product', false,@(i) islogical(i) && isscalar(i);...
'start_timestamp_only',datastorage.parameters('start_timestamp_only'),@islogical;... %this needs to be in agreement with what is used in datastorage.load
},product.metadata},varargin{:});
%ignore plot products, file saving is done inside the init method
if v.plot_product
return
end
obj.log('@','in','product',product,'start',obj.start,'stop',obj.stop)
% get the data to be saved
% NOTICE: it is *always* everything under this product.name, never resolved at the level of the field_path
% this is to be in agreement with how the filenames are built in datanames
s0=obj.value_get(product.name);
% get list of start/stop dates from the data
[startlist,stoplist]=obj.startstop_list(s0);
% catch invalid products
if isempty(startlist)
obj.log('@','out','no data to save for',product)
return
end
% get the file list
[file_list,startlist,stoplist]=product.file('data',...
'start',min(startlist),...
'stop',max(stoplist),...
'start_timestamp_only',v.start_timestamp_only,... %this needs to be in agreement with what is used in datastorage.load
'discover',false,...
varargin{:}...
);
%check if nothing is to be save
if isempty(file_list)
obj.log('@','out','no files to save for',product)
return
end
obj.log('nr of files to save',numel(file_list))
%loop over all files
for f=1:numel(file_list)
% global storage periods not have start/stop lists
if isempty(startlist) || isempty(stoplist)
%paranoid sanity
assert(numel(file_list)==1,['expecting there to be a single file name to save, not ',num2str(numel(file_list)),'.'])
s=s0;
else
%trim the data to the current start/stop epochs (structs.objmethod handles both structures and objects)
s=structs.objmethod('trim',s0,startlist(f),stoplist(f));
end
% do not save gaps at edges
s=structs.objmethod('noedgegaps',s);
%skip if this entry is empty
if structs.isempty(s) || all(structs.iseq_numscal_method('nr_valid',s,0))
obj.log(['skip saving file ',num2str(f)],['no data for ',datestr(startlist(f),29)])
continue
end
%check if this file already exists
if exist(file_list{f},'file')
%save the data if force is true
if product.force(v.force)
replace_flag=true;
else
%save new variable
s1=s;
%load this file
load(file_list{f},'s');
%re-align data if needed
if ~strcmp(class(s),class(s1))
disp(['Data type in newly-computed object (',class(s1),...
') differs from what is saved in file ',file_list{f},' (',class(s),')',...
'; replacing data saved in file'])
%discard saved data
replace_flag=true;
s=s1;
elseif isstruct(s)
replace_flag=false;
[good_fnl,fnl,fnl_new]=structs.iseq_field_list(s,s1);
if good_fnl
%skip saving if start/stop dates in s_new are not wider than those already in file
for i=1:numel(fnl)
s_new=structs.get_value(s1,fnl{i});
s_old=structs.get_value(s, fnl{i});
if isempty(s_new)
replace_flag=false;
elseif isempty(s_old)
replace_flag=true;
elseif s_new.start>=s_old.start && s_new.stop<=s_old.stop
%do nothing
elseif isempty(s_new) && isempty(s_old)
%also do nothing
elseif s_new.start<s_old.start || s_new.stop>s_old.stop
%augment saved data
s=structs.set_value(s,fnl{i},s_old.augment(s_new));
replace_flag=true;
else
replace_flag=true;
end
end
else
disp(['structure fields in newly-computed object (',...
strjoin(cellfun(@(i) strjoin(i,'.'),fnl_new,'UniformOutput',false),', '),...
') differ from what is saved in file ',file_list{f},' (',...
strjoin(cellfun(@(i) strjoin(i,'.'),fnl,'UniformOutput',false)),...
'); replacing data saved in file'])
%discard saved data
replace_flag=true;
s=s1;
end
else
assert(...
(ismethod(s,'start') || isprop(s,'start')) && ...
(ismethod(s,'stop' ) || isprop(s,'stop' )),...
['Cannot handle data of type ',class(s),', no support for start/stop.']...
);
assert(...
(ismethod(s1,'start') || isprop(s1,'start')) && ...
(ismethod(s1,'stop' ) || isprop(s1,'stop' )),...