[c++/m] Add nix.Tag retrieveData function

Author: mpsonntag

+nix/Tag.m

@@ -63,6 +63,14 @@
                 'Tag::openReferenceIdx', idx, @nix.DataArray);
         end;
 
+        function data = retrieve_data(obj, id_or_name)
+            tmp = nix_mx('Tag::retrieveData', obj.nix_handle, id_or_name);
+
+            % data must agree with file & dimensions
+            % see mkarray.cc(42)
+            data = permute(tmp, length(size(tmp)):-1:1);
+        end;
+
         function data = retrieve_data_idx(obj, idx)
             tmp = nix_mx('Tag::retrieveDataIdx', obj.nix_handle, idx);
 

nix_mx.cc

@@ -329,6 +329,7 @@ void mexFunction(int            nlhs,
         methods->add("Tag::sourcesFiltered", nixtag::sourcesFiltered);
         methods->add("Tag::referencesFiltered", nixtag::referencesFiltered);
         methods->add("Tag::featuresFiltered", nixtag::featuresFiltered);
+        methods->add("Tag::retrieveData", nixtag::retrieveData);
         methods->add("Tag::retrieveDataIdx", nixtag::retrieveDataIdx);
         methods->add("Tag::featureRetrieveDataIdx", nixtag::retrieveFeatureDataIdx);
 

src/nixtag.cc

@@ -114,6 +114,14 @@ namespace nixtag {
         output.set(0, res);
     }
 
+    void retrieveData(const extractor &input, infusor &output) {
+        nix::Tag currObj = input.entity<nix::Tag>(1);
+        std::string name_id = input.str(2);
+
+        mxArray *data = make_mx_array_from_ds(currObj.retrieveData(name_id));
+        output.set(0, data);
+    }
+
     void retrieveDataIdx(const extractor &input, infusor &output) {
         nix::Tag currObj = input.entity<nix::Tag>(1);
         nix::ndsize_t idx = (nix::ndsize_t)input.num<double>(2);

src/nixtag.h

@@ -39,6 +39,8 @@ namespace nixtag {
 
     void featuresFiltered(const extractor &input, infusor &output);
 
+    void retrieveData(const extractor &input, infusor &output);
+
     void retrieveDataIdx(const extractor &input, infusor &output);
 
     void retrieveFeatureDataIdx(const extractor &input, infusor &output);

tests/TestTag.m

@@ -34,6 +34,7 @@
     funcs{end+1} = @test_open_reference_idx;
     funcs{end+1} = @test_set_metadata;
     funcs{end+1} = @test_open_metadata;
+    funcs{end+1} = @test_retrieve_data;
     funcs{end+1} = @test_retrieve_data_idx;
     funcs{end+1} = @test_retrieve_feature_data_idx;
     funcs{end+1} = @test_attrs;
@@ -524,6 +525,43 @@
     assert(strcmp(t.open_metadata.name, 'testSection'));
 end
 
+%% Test: Retrieve referenced data by name and id
+function [] = test_retrieve_data( varargin )
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    tagStartPos = [3];
+    t = b.create_tag('testTag', 'nixTag', tagStartPos);
+    t.extent = [3];
+
+    rawName = [1, 2, 3, 4, 5, 6, 7, 8, 9];
+    rawID = [11, 12, 13, 14, 15, 16, 17];
+    d = b.create_data_array_from_data('testDataArrayName', 'nixDataArray', rawName);
+    d.append_sampled_dimension(1);
+    t.add_reference(d);
+
+    d = b.create_data_array_from_data('testDataArrayID', 'nixDataArray', rawID);
+    d.append_sampled_dimension(1);
+    t.add_reference(d);
+
+    % test get non existent
+    try
+        retData = t.retrieve_data('I do not exist, dont hate me!');
+    catch ME
+        assert(~isempty(strfind(ME.message, 'no DataArray with the specified name')), ...
+            'Non existent check fail');
+    end
+
+    % test get referenced data by name
+    retData = t.retrieve_data('testDataArrayName');
+    assert(size(retData, 2) == t.extent, 'Get by name extent check fail');
+    assert(retData(1) == rawName(t.position + 1), 'Get by name position check fail');
+
+    % test get referenced data by id
+    retData = t.retrieve_data(d.id);
+    assert(size(retData, 2) == t.extent, 'Get by id extent check fail');
+    assert(retData(1) == rawID(t.position + 1), 'Get by id position check fail');
+end
+
 %% Test: Retrieve referenced data by index
 function [] = test_retrieve_data_idx( varargin )
     f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);