[c++/m] Add Tag getByIndex functions

Implements the getByIndex functions on the
c++ and the Matlab side and adds corresponding
tests.
- getReference
- getFeature
- getSource

Author: mpsonntag

+nix/Tag.m

@@ -58,6 +58,11 @@
                 'Tag::openReferenceDataArray', id_or_name, @nix.DataArray);
         end;
 
+        function retObj = open_reference_idx(obj, idx)
+            retObj = nix.Utils.open_entity(obj, ...
+                'Tag::openReferenceIdx', idx, @nix.DataArray);
+        end;
+
         function data = retrieve_data(obj, index)
             % convert Matlab-like to C-like index
             assert(index > 0, 'Subscript indices must be positive');
@@ -99,7 +104,12 @@
             retObj = nix.Utils.open_entity(obj, ...
                 'Tag::openFeature', id_or_name, @nix.Feature);
         end;
-        
+
+        function retObj = open_feature_idx(obj, idx)
+            retObj = nix.Utils.open_entity(obj, ...
+                'Tag::openFeatureIdx', idx, @nix.Feature);
+        end;
+
         function data = retrieve_feature_data(obj, index)
             % convert Matlab-like to C-like index
             assert(index > 0, 'Subscript indices must be positive');

nix_mx.cc

@@ -303,6 +303,9 @@ void mexFunction(int            nlhs,
         methods->add("Tag::addSource", nixtag::addSource);
         methods->add("Tag::addSources", nixtag::addSources);
         methods->add("Tag::createFeature", nixtag::createFeature);
+        methods->add("Tag::openReferenceIdx", nixtag::openReferenceIdx);
+        methods->add("Tag::openFeatureIdx", nixtag::openFeatureIdx);
+        methods->add("Tag::openSourceIdx", nixtag::openSourceIdx);
 
         classdef<nix::MultiTag>("MultiTag", methods)
             .desc(&nixmultitag::describe)

src/nixtag.cc

@@ -78,4 +78,22 @@ namespace nixtag {
         output.set(0, data);
     }
 
+    void openReferenceIdx(const extractor &input, infusor &output) {
+        nix::Tag currObj = input.entity<nix::Tag>(1);
+        nix::ndsize_t idx = (nix::ndsize_t)input.num<double>(2);
+        output.set(0, currObj.getReference(idx));
+    }
+
+    void openFeatureIdx(const extractor &input, infusor &output) {
+        nix::Tag currObj = input.entity<nix::Tag>(1);
+        nix::ndsize_t idx = (nix::ndsize_t)input.num<double>(2);
+        output.set(0, currObj.getFeature(idx));
+    }
+
+    void openSourceIdx(const extractor &input, infusor &output) {
+        nix::Tag currObj = input.entity<nix::Tag>(1);
+        nix::ndsize_t idx = (nix::ndsize_t)input.num<double>(2);
+        output.set(0, currObj.getSource(idx));
+    }
+
 } // namespace nixtag

src/nixtag.h

@@ -29,6 +29,12 @@ namespace nixtag {
 
     void retrieveFeatureData(const extractor &input, infusor &output);
 
+    void openReferenceIdx(const extractor &input, infusor &output);
+
+    void openFeatureIdx(const extractor &input, infusor &output);
+
+    void openSourceIdx(const extractor &input, infusor &output);
+
 } // namespace nixtag
 
 #endif

tests/TestTag.m

@@ -25,10 +25,13 @@
     funcs{end+1} = @test_fetch_features;
     funcs{end+1} = @test_feature_count;
     funcs{end+1} = @test_open_source;
+    funcs{end+1} = @test_open_source_idx;
     funcs{end+1} = @test_has_source;
     funcs{end+1} = @test_source_count;
     funcs{end+1} = @test_open_feature;
+    funcs{end+1} = @test_open_feature_idx;
     funcs{end+1} = @test_open_reference;
+    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;
@@ -350,6 +353,23 @@
     assert(isempty(getNonSource));
 end
 
+function [] = test_open_source_idx( varargin )
+%% Test Open Source by index
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    t = b.create_tag('testTag', 'nixTag', [2 9]);
+    s1 = b.create_source('testSource1', 'nixSource');
+    s2 = b.create_source('testSource2', 'nixSource');
+    s3 = b.create_source('testSource3', 'nixSource');
+    t.add_source(s1);
+    t.add_source(s2);
+    t.add_source(s3);
+
+    assert(strcmp(f.blocks{1}.tags{1}.open_source_idx(0).name, s1.name));
+    assert(strcmp(f.blocks{1}.tags{1}.open_source_idx(1).name, s2.name));
+    assert(strcmp(f.blocks{1}.tags{1}.open_source_idx(2).name, s3.name));
+end
+
 %% Test: nix.Tag has nix.Source by ID or entity
 function [] = test_has_source( varargin )
     fileName = 'testRW.h5';
@@ -402,6 +422,22 @@
     assert(isempty(getFeat));
 end
 
+function [] = test_open_feature_idx( varargin )
+%% Test Open feature by index
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    t = b.create_tag('testTag', 'nixTag', [2 9]);
+    d1 = b.create_data_array('testFeature1', 'nixDataArray', nix.DataType.Double, [1 2]);
+    d2 = b.create_data_array('testFeature2', 'nixDataArray', nix.DataType.Double, [3 2]);
+    d3 = b.create_data_array('testFeature3', 'nixDataArray', nix.DataType.Double, [7 2]);
+    t.add_feature(d1, nix.LinkType.Tagged);
+    t.add_feature(d2, nix.LinkType.Untagged);
+    t.add_feature(d3, nix.LinkType.Indexed);
+
+    assert(f.blocks{1}.tags{1}.open_feature_idx(0).linkType == nix.LinkType.Tagged);
+    assert(f.blocks{1}.tags{1}.open_feature_idx(1).linkType == nix.LinkType.Untagged);
+    assert(f.blocks{1}.tags{1}.open_feature_idx(2).linkType == nix.LinkType.Indexed);
+end
 
 %% Test: Open reference by ID or name
 function [] = test_open_reference( varargin )
@@ -423,6 +459,23 @@
     assert(isempty(getNonRef));
 end
 
+function [] = test_open_reference_idx( varargin )
+%% Test Open reference by index
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    t = b.create_tag('testTag', 'nixTag', [2 9]);
+    d1 = b.create_data_array('testReference1', 'nixDataArray', nix.DataType.Double, [1 2]);
+    d2 = b.create_data_array('testReference2', 'nixDataArray', nix.DataType.Double, [3 2]);
+    d3 = b.create_data_array('testReference3', 'nixDataArray', nix.DataType.Double, [7 2]);
+    t.add_reference(d1);
+    t.add_reference(d2);
+    t.add_reference(d3);
+
+    assert(strcmp(f.blocks{1}.tags{1}.open_reference_idx(0).name, d1.name));
+    assert(strcmp(f.blocks{1}.tags{1}.open_reference_idx(1).name, d2.name));
+    assert(strcmp(f.blocks{1}.tags{1}.open_reference_idx(2).name, d3.name));
+end
+
 %% Test: Set metadata
 function [] = test_set_metadata ( varargin )
     fileName = fullfile(pwd, 'tests', 'testRW.h5');