add Property entity

Author: mpsonntag

+nix/Property.m

@@ -0,0 +1,21 @@
+classdef Property < nix.NamedEntity
+    %PROPERTY Metadata Property class
+    %   NIX metadata property
+    
+    properties(Hidden)
+        % namespace reference for nix-mx functions
+        alias = 'Property'
+    end;
+    
+    methods
+        function obj = Property(h)
+            [email protected](h);
+            
+            % assign dynamic properties
+            nix.Dynamic.add_dyn_attr(obj, 'unit', 'rw');
+            nix.Dynamic.add_dyn_attr(obj, 'mapping', 'rw');
+        end;
+    end
+    
+end
+

+nix/Section.m

@@ -86,7 +86,12 @@
         % ----------------
         % Property methods
         % ----------------
-        
+
+        function retObj = open_property(obj, id_or_name)
+            retObj = nix.Utils.open_entity(obj, ...
+                'Section::openProperty', id_or_name, @nix.Property);
+        end;
+
         function props = get.allProperties(obj)
             [obj.propsCache, props] = nix.Utils.fetchPropList(obj.updatedAt, ...
                 'Section::properties', obj.nix_handle, obj.propsCache);

nix_mx.cc

@@ -13,6 +13,7 @@
 
 #include "nixfile.h"
 #include "nixsection.h"
+#include "nixproperty.h"
 #include "nixblock.h"
 #include "nixdataarray.h"
 #include "nixsource.h"
@@ -224,13 +225,17 @@ void mexFunction(int            nlhs,
             .reg("set_mapping", SETTER(const std::string&, nix::Section, mapping))
             .reg("set_none_mapping", SETTER(const boost::none_t, nix::Section, mapping))
             .reg("createSection", &nix::Section::createSection)
-            .reg("deleteSection", REMOVER(nix::Section, nix::Section, deleteSection));
+            .reg("deleteSection", REMOVER(nix::Section, nix::Section, deleteSection))
+            .reg("openProperty", GETBYSTR(nix::Property, nix::Section, getProperty));
         methods->add("Section::properties", nixsection::properties);
 
         classdef<nix::Feature>("Feature", methods)
             .desc(&nixfeature::describe)
             .reg("openData", GETCONTENT(nix::DataArray, nix::Feature, data));
 
+        classdef<nix::Property>("Property", methods)
+            .desc(&nixproperty::describe);
+
         mexAtExit(on_exit);
     });
 

src/nixproperty.cc

@@ -0,0 +1,24 @@
+#include "nixproperty.h"
+
+#include "mex.h"
+
+#include <nix.hpp>
+
+#include "handle.h"
+#include "arguments.h"
+#include "struct.h"
+
+namespace nixproperty {
+
+    mxArray *describe(const nix::Property &prop)
+    {
+        struct_builder sb({ 1 }, { "id", "name", "definition", "unit", "mapping" });
+        sb.set(prop.id());
+        sb.set(prop.name());
+        sb.set(prop.definition());
+        sb.set(prop.unit());
+        sb.set(prop.mapping());
+        return sb.array();
+    }
+
+} // namespace nixproperty

src/nixproperty.h

@@ -0,0 +1,12 @@
+#ifndef NIX_MX_PROPERTY
+#define NIX_MX_PROPERTY
+
+#include "arguments.h"
+
+namespace nixproperty {
+
+    mxArray *describe(const nix::Property &prop);
+
+} // namespace nixproperty
+
+#endif

src/utils/handle.h

@@ -57,6 +57,12 @@ struct entity_to_id<nix::Section> {
     static const int value = 7;
 };
 
+template<>
+struct entity_to_id<nix::Property> {
+    static const bool is_valid = true;
+    static const int value = 8;
+};
+
 class handle {
 public:
     struct entity {

tests/RunTests.m

@@ -29,9 +29,11 @@
 t7.tests = TestSection();
 t8.name = 'FEATURE';
 t8.tests = TestFeature();
+t9.name = 'PROPERTY';
+t9.tests = TestProperty();
 
 % concatenate all test handles
-all_tests = {t1, t2, t3, t4, t5, t6, t7, t8};
+all_tests = {t1, t2, t3, t4, t5, t6, t7, t8, t9};
 
 for i = 1:length(all_tests)
     fprintf([10 'Execute ' all_tests{i}.name ' tests:\n\n']);

tests/TestProperty.m

@@ -0,0 +1,21 @@
+function funcs = TestProperty
+%TESTPROPERTY % Tests for the nix.Property object
+%   Detailed explanation goes here
+
+    funcs = {};
+    funcs{end+1} = @test_attrs;
+end
+
+%% Test: Access Attributes
+function [] = test_attrs( varargin )
+    f = nix.File(fullfile(pwd, 'tests', 'test.h5'), nix.FileMode.ReadOnly);
+    s = f.sections{2}.sections{2}.sections{1};
+    p = s.open_property(s.allProperties{1}.id);
+
+    assert(~isempty(p.id));
+
+    assert(strcmp(p.name, 'ExperimentalCondition'));
+    assert(isempty(p.definition));
+    assert(isempty(p.unit));
+    assert(isempty(s.mapping));
+end

tests/TestSection.m

@@ -11,6 +11,7 @@
     funcs{end+1} = @test_has_section;
     funcs{end+1} = @test_attrs;
     funcs{end+1} = @test_properties;
+    funcs{end+1} = @test_open_property;
     funcs{end+1} = @test_link;
 end
 
@@ -135,6 +136,15 @@
     assert(isempty(f.sections{3}.allProperties));
 end
 
+%% Test: Open property by ID and name
+function [] = test_open_property( varargin )
+    f = nix.File(fullfile(pwd, 'tests', 'test.h5'), nix.FileMode.ReadOnly);
+    trial = f.sections{2}.sections{2}.sections{1};
+
+    assert(~isempty(trial.open_property(trial.allProperties{1}.id)));
+    assert(~isempty(trial.open_property(trial.allProperties{1}.name)));
+end
+
 %%Test: set, open and remove section link
 function [] = test_link( varargin )
     f = nix.File(fullfile(pwd, 'tests', 'testRW.h5'), nix.FileMode.Overwrite);