[c++/m] Add Source sourcesFilter

Author: mpsonntag

+nix/Source.m

@@ -73,5 +73,10 @@
             retObj = nix.Utils.fetchObjList('Source::referringMultiTags', ...
                 obj.nix_handle, @nix.MultiTag);
         end
+
+        function filtered = filter_sources(obj, filter, val)
+            filtered = nix.Utils.filter(obj, filter, val, ...
+                'Source::sourcesFiltered', @nix.Source);
+        end
     end;
 end

nix_mx.cc

@@ -283,6 +283,7 @@ void mexFunction(int            nlhs,
             .reg("referringMultiTags", GETTER(std::vector<nix::MultiTag>, nix::Source, referringMultiTags));
         methods->add("Source::openSourceIdx", nixsource::openSourceIdx);
         methods->add("Source::compare", nixsource::compare);
+        methods->add("Source::sourcesFiltered", nixsource::sourcesFiltered);
 
         classdef<nix::Tag>("Tag", methods)
             .desc(&nixtag::describe)

src/nixsource.cc

@@ -12,8 +12,9 @@
 
 #include <nix.hpp>
 
-#include "handle.h"
 #include "arguments.h"
+#include "filters.h"
+#include "handle.h"
 #include "struct.h"
 
 namespace nixsource {
@@ -39,4 +40,13 @@ namespace nixsource {
         output.set(0, currObj.compare(other));
     }
 
+    void sourcesFiltered(const extractor &input, infusor &output) {
+        nix::Source currObj = input.entity<nix::Source>(1);
+        std::vector<nix::Source> res = filterEntity<nix::Source>(input,
+                                            [currObj](const nix::util::Filter<nix::Source>::type &filter) {
+            return currObj.sources(filter);
+        });
+        output.set(0, res);
+    }
+
 } // namespace nixsource

src/nixsource.h

@@ -19,6 +19,8 @@ namespace nixsource {
 
     void compare(const extractor &input, infusor &output);
 
+    void sourcesFiltered(const extractor &input, infusor &output);
+
 } // namespace nixsource
 
 #endif

tests/TestSource.m

@@ -26,6 +26,7 @@
     funcs{end+1} = @test_referring_tags;
     funcs{end+1} = @test_referring_multi_tags;
     funcs{end+1} = @test_compare;
+    funcs{end+1} = @test_filter_source;
 end
 
 %% Test: fetch sources
@@ -298,3 +299,73 @@
     assert(s2.compare(s1) > 0);
     assert(s1.compare(s3) ~= 0);
 end
+
+%% Test: filter sources
+function [] = test_filter_source( varargin )
+    filterName = 'filterMe';
+    filterType = 'filterType';
+    f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);
+    b = f.create_block('testBlock', 'nixBlock');
+    ms = b.create_source('testSource', 'nixSource');
+    s = ms.create_source(filterName, 'nixSource');
+    filterID = s.id;
+	s = ms.create_source('testSource1', filterType);
+    filterIDs = {filterID, s.id};
+    s = ms.create_source('testSource2', filterType);
+
+    % test empty id filter
+    assert(isempty(f.blocks{1}.sources{1}.filter_sources(nix.Filter.id, 'IdoNotExist')));
+
+    % test nix.Filter.accept_all
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.accept_all, '');
+    assert(size(filtered, 1) == 3);
+
+    % test nix.Filter.id
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.id, filterID);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.id, filterID));
+
+    % test nix.Filter.ids
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.ids, filterIDs);
+    assert(size(filtered, 1) == 2);
+    assert(strcmp(filtered{1}.id, filterIDs{1}) || strcmp(filtered{1}.id, filterIDs{2}));
+    
+    % test nix.Filter.name
+    filtered  = f.blocks{1}.sources{1}.filter_sources(nix.Filter.name, filterName);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, filterName));
+    
+    % test nix.Filter.type
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.type, filterType);
+    assert(size(filtered, 1) == 2);
+
+    % test nix.Filter.metadata
+    mainName = 'testSubSection';
+    mainSource = ms.create_source(mainName, 'nixSource');
+    subName = 'testSubSection1';
+    s = f.create_section(subName, 'nixSection');
+    mainSource.set_metadata(s);
+    subID = s.id;
+
+    assert(isempty(f.blocks{1}.sources{1}.filter_sources(nix.Filter.metadata, 'Do not exist')));
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.metadata, subID);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, mainName));
+
+    % test nix.Filter.source
+    mainName = 'testSubSource';
+    main = ms.create_source(mainName, 'nixSource');
+    mainID = main.id;
+    subName = 'testSubSource1';
+    s = main.create_source(subName, 'nixSource');
+    subID = s.id;
+
+    assert(isempty(f.blocks{1}.sources{1}.filter_sources(nix.Filter.source, 'Do not exist')));
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.source, subName);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.id, mainID));
+
+    filtered = f.blocks{1}.sources{1}.filter_sources(nix.Filter.source, subID);
+    assert(size(filtered, 1) == 1);
+    assert(strcmp(filtered{1}.name, mainName));
+end