[Matlab] Final renaming cleanup

- Refactor 'nix.Filter.accept_all' filter.
- Refactor 'DataArray.openDimensionIdx' dimension_type.
- Final cleanup of nix.File variable names and Primer usage.
- CONTRIBUTING.md content rephrasing.

Author: mpsonntag

+nix/Block.m

@@ -178,7 +178,7 @@
 
         % maxdepth is an index
         function r = findSources(obj, maxDepth)
-            r = obj.filterFindSources(maxDepth, nix.Filter.accept_all, '');
+            r = obj.filterFindSources(maxDepth, nix.Filter.acceptall, '');
         end
 
         % maxdepth is an index

+nix/DataArray.m

@@ -86,7 +86,7 @@
         % instead of 0 compared to all other index functions.
             fname = strcat(obj.alias, '::openDimensionIdx');
             dim = nix_mx(fname, obj.nixhandle, idx);
-            switch (dim.dimension_type)
+            switch (dim.dimensionType)
                 case 'set'
                     r = nix.Utils.createEntity(dim.handle, @nix.SetDimension);
                 case 'sampled'

+nix/File.m

@@ -57,12 +57,12 @@
             r = nix.Utils.fetchEntityCount(obj, 'blockCount');
         end
 
-        function r = hasBlock(obj, id_or_name)
-            r = nix.Utils.fetchHasEntity(obj, 'hasBlock', id_or_name);
+        function r = hasBlock(obj, idName)
+            r = nix.Utils.fetchHasEntity(obj, 'hasBlock', idName);
         end
 
-        function r = openBlock(obj, id_or_name)
-            r = nix.Utils.openEntity(obj, 'openBlock', id_or_name, @nix.Block);
+        function r = openBlock(obj, idName)
+            r = nix.Utils.openEntity(obj, 'openBlock', idName, @nix.Block);
         end
 
         function r = openBlockIdx(obj, index)
@@ -92,12 +92,12 @@
             r = nix.Utils.fetchEntityCount(obj, 'sectionCount');
         end
 
-        function r = hasSection(obj, id_or_name)
-            r = nix.Utils.fetchHasEntity(obj, 'hasSection', id_or_name);
+        function r = hasSection(obj, idName)
+            r = nix.Utils.fetchHasEntity(obj, 'hasSection', idName);
         end
 
-        function r = openSection(obj, id_or_name)
-            r = nix.Utils.openEntity(obj, 'openSection', id_or_name, @nix.Section);
+        function r = openSection(obj, idName)
+            r = nix.Utils.openEntity(obj, 'openSection', idName, @nix.Section);
         end
 
         function r = openSectionIdx(obj, index)
@@ -114,13 +114,13 @@
         end
 
         % maxdepth is an index
-        function r = findSections(obj, max_depth)
-            r = obj.filterFindSections(max_depth, nix.Filter.accept_all, '');
+        function r = findSections(obj, maxDepth)
+            r = obj.filterFindSections(maxDepth, nix.Filter.acceptall, '');
         end
 
         % maxdepth is an index
-        function r = filterFindSections(obj, max_depth, filter, val)
-            r = nix.Utils.find(obj, 'findSections', max_depth, filter, val, @nix.Section);
+        function r = filterFindSections(obj, maxDepth, filter, val)
+            r = nix.Utils.find(obj, 'findSections', maxDepth, filter, val, @nix.Section);
         end
     end
 

+nix/Filter.m

@@ -2,7 +2,7 @@
     % FILTER available nix custom filters
 
     enumeration
-        accept_all (0); % requires an empty value
+        acceptall (0); % requires an empty value
         id (1);
         ids (2); % requires a cell array
         type (3);

+nix/Section.m

@@ -97,7 +97,7 @@
 
         % maxDepth is handled like an index
         function r = findSections(obj, maxDepth)
-            r = obj.FilterFindSections(maxDepth, nix.Filter.accept_all, '');
+            r = obj.FilterFindSections(maxDepth, nix.Filter.acceptall, '');
         end
 
         % maxDepth is handled like an index

+nix/Source.m

@@ -76,7 +76,7 @@
 
         % maxdepth is an index where idx = 0 corresponds to the calling source
         function r = findSources(obj, maxDepth)
-            r = obj.filterFindSources(maxDepth, nix.Filter.accept_all, '');
+            r = obj.filterFindSources(maxDepth, nix.Filter.acceptall, '');
         end
 
         % maxdepth is an index where idx = 0 corresponds to the calling source

CONTRIBUTING.md

@@ -67,9 +67,9 @@ Style guide
 Adhere to the MATLAB Style Guidelines 2.0 as suggested by Richard Johnson.
 
 Furthermore, adhere to these additional guidelines for the nix-mx project:
-
-- keep line length at 90 max.
-- use `r` as return variable name of simple (2-3 line) functions.
-- always use ';' to terminate proper statements, never for terminating control structures.
+- Keep line length at a maximum of 90 characters.
+- Use `r` as return variable name of simple (2-3 line) functions.
+- Always terminate proper statements with a semicolon.
+- Never terminate control structures with a semicolon.
 - Structure names should start with a capital letter.
 - Structure field names should be camel case and start with a lower case letter.

examples/Primer.m

@@ -24,8 +24,8 @@
     b = f.blocks{i};
 
     % fetch trial indexes of a certain type = 'nix.trial'
-    trial_idx = cellfun(@(x) strcmp(x.type, 'nix.trial'), b.tags);
-    disp([10 b.name ': ' num2str(length(nonzeros(trial_idx))) ' trials']);
+    trialIdx = cellfun(@(x) strcmp(x.type, 'nix.trial'), b.tags);
+    disp([10 b.name ': ' num2str(length(nonzeros(trialIdx))) ' trials']);
 
     % display source names
     for j = 1:length(b.sources)
@@ -53,7 +53,7 @@
 
 % get actual data
 d1 = selection2{1};
-dataset = d1.read_all();
+dataset = d1.readAllData();
 
 % understand dimensions
 dim1 = d1.dimensions{1};
@@ -79,5 +79,5 @@
 value = sec.properties{1}.values{1};
 
 % or by name
-value = sec.open_property('Name').values{1}.value;
+value = sec.openProperty('Name').values{1}.value;
 

src/nixdataarray.cc

@@ -151,7 +151,7 @@ namespace nixdataarray {
 
         nix::Dimension d = currObj.getDimension(idx);
 
-        struct_builder sb({ 1 }, { "dimension_type", "handle" });
+        struct_builder sb({ 1 }, { "dimensionType", "handle" });
 
         switch (d.dimensionType()) {
         case nix::DimensionType::Set:

tests/RunTests.m

@@ -20,24 +20,24 @@
 %--     id: 7b59c0b9-b200-4b53-951d-6851dbd1cdc8
 %--     name: joe097
 
-all_tests = {};
-all_tests{end+1} = struct('name', 'FILE', 'tests', {TestFile()});
-all_tests{end+1} = struct('name', 'BLOCK', 'tests', {TestBlock()});
-all_tests{end+1} = struct('name', 'GROUP', 'tests', {TestGroup()});
-all_tests{end+1} = struct('name', 'SOURCE', 'tests', {TestSource()});
-all_tests{end+1} = struct('name', 'DATAARRAY', 'tests', {TestDataArray()});
-all_tests{end+1} = struct('name', 'TAG', 'tests', {TestTag()});
-all_tests{end+1} = struct('name', 'MULTITAG', 'tests', {TestMultiTag()});
-all_tests{end+1} = struct('name', 'SECTION', 'tests', {TestSection()});
-all_tests{end+1} = struct('name', 'FEATURE', 'tests', {TestFeature()});
-all_tests{end+1} = struct('name', 'PROPERTY', 'tests', {TestProperty()});
-all_tests{end+1} = struct('name', 'DIMENSIONS', 'tests', {TestDimensions()});
-
-for i = 1:length(all_tests)
-    fprintf([10 'Execute ' all_tests{i}.name ' tests:\n\n']);
+all = {};
+all{end+1} = struct('name', 'FILE', 'tests', {TestFile()});
+all{end+1} = struct('name', 'BLOCK', 'tests', {TestBlock()});
+all{end+1} = struct('name', 'GROUP', 'tests', {TestGroup()});
+all{end+1} = struct('name', 'SOURCE', 'tests', {TestSource()});
+all{end+1} = struct('name', 'DATAARRAY', 'tests', {TestDataArray()});
+all{end+1} = struct('name', 'TAG', 'tests', {TestTag()});
+all{end+1} = struct('name', 'MULTITAG', 'tests', {TestMultiTag()});
+all{end+1} = struct('name', 'SECTION', 'tests', {TestSection()});
+all{end+1} = struct('name', 'FEATURE', 'tests', {TestFeature()});
+all{end+1} = struct('name', 'PROPERTY', 'tests', {TestProperty()});
+all{end+1} = struct('name', 'DIMENSIONS', 'tests', {TestDimensions()});
+
+for i = 1:length(all)
+    fprintf([10 'Execute ' all{i}.name ' tests:\n\n']);
 
-    for j = 1:length(all_tests{i}.tests)
-        stats = wrapper(all_tests{i}.tests{j}, stats);
+    for j = 1:length(all{i}.tests)
+        stats = wrapper(all{i}.tests{j}, stats);
     end
 end;