Add ErrorID and warningID for all user-facing code (#617)

* Add warning IDs for where missing

* Add errorID where missing

* Add errorIDs to class generators and update regenerate types with errorIDs

* Add errorID to checkCustomConstraint method of TimeSeries

Author: ehennestad

+file/Dataset.m

@@ -121,15 +121,19 @@
 
             %constrained
             % error unless it defines the object.
-            
-            if isempty(obj.type)
-                error('You shouldn''t be calling getProps on an untyped dataset');
-            end
-            
-            if obj.isConstrainedSet && ~obj.definesType
-                error('You shouldn''t be calling getProps on a constrained dataset');
-            end
-            
+
+            assert(...
+                ~isempty(obj.type), ...
+                'NWB:Dataset:UnsupportedOperation', ...
+                'The method `getProps` should not be called on an untyped dataset.' ...
+                );
+            
+            assert( ...
+                ~obj.isConstrainedSet || obj.definesType, ...
+                'NWB:Dataset:UnsupportedOperation', ...
+                'The method `getProps` should not be called on constrained dataset.' ...
+                );
+
             if ~isempty(obj.dtype)
                 props('data') = obj.dtype;
             end

+file/Group.m

@@ -146,8 +146,14 @@
             %should never happen
 
             if obj.isConstrainedSet && ~obj.definesType
-                error('getProps shouldn''t be called on a constrained set.');
+                error('NWB:Group:UnsupportedOperation', ...
+                      'The method `getProps` should not be called on a constrained dataset.');
             end
+            assert( ...
+                ~obj.isConstrainedSet || obj.definesType, ...
+                'NWB:Group:UnsupportedOperation', ...
+                'The method `getProps` should not be called on a constrained group.' ...
+                );
 
             %datasets
             for i=1:length(obj.datasets)

+file/fillConstructor.m

@@ -100,7 +100,8 @@
         end
     end
 
-    %warn for missing namespaces/property types
+    % warn for missing namespaces/property types
+    warningId = 'NWB:ClassGenerator:NamespaceOrTypeNotFound';
     warnmsg = ['`' parentName '`''s constructor is unable to check for type `%1$s` ' ...
         'because its namespace or type specifier could not be found.  Try generating ' ...
         'the namespace or class definition for type `%1$s` or fix its schema.'];
@@ -109,7 +110,7 @@
     invalidWarn = invalid & (dynamicConstrained | isAnonymousType) & ~isAttribute;
     invalidVars = varnames(invalidWarn);
     for i=1:length(invalidVars)
-        warning(warnmsg, invalidVars{i});
+        warning(warningId, warnmsg, invalidVars{i});
     end
     varnames = lower(varnames);
 

+file/fillCustomConstraint.m

@@ -12,9 +12,11 @@
             customConstraintStr = sprintf( [...
                 'function checkCustomConstraint(obj)\n', ...
                 '    assert(~isempty(obj.timestamps) || ~isempty(obj.starting_time), ...\n', ...
+                '        ''NWB:TimeSeries:TimeNotSpecified'', ...\n ', ...
                 '        "''timestamps'' or ''starting_time'' must be specified")\n', ...
                 '    if ~isempty(obj.starting_time)\n', ...
                 '        assert(~isempty(obj.starting_time_rate), ...\n', ...
+                '            ''NWB:TimeSeries:RateMissing'', ...\n', ...
                 '            "''starting_time_rate'' must be specified when ''starting_time'' is specified")\n', ...
                 '    end\n', ...
                 'end'] );

+file/fillProps.m

@@ -58,7 +58,8 @@
                 case 'object'
                     refTypeName = 'Object';
                 otherwise
-                    error('Invalid reftype found whilst filling Constructor prop docs.');
+                    error('NWB:ClassGenerator:InvalidRefType', ...
+                        'Invalid reftype found while filling description for class property "%s".', propName);
             end
             typeStr = sprintf('%s Reference to %s', refTypeName, prop.dtype('target_type'));
         else
@@ -71,7 +72,8 @@
             case 'object'
                 refTypeName = 'object';
             otherwise
-                error('Invalid reftype found whilst filling Constructor prop docs.');
+                error('NWB:ClassGenerator:InvalidRefType', ...
+                    'Invalid reftype found while filling description for class property "%s".', propName);
         end
         typeStr = sprintf('%s Reference to %s', refTypeName, prop('target_type'));
     elseif isa(prop, 'file.interface.HasProps')

+file/fillValidators.m

@@ -240,7 +240,7 @@
             '    return;'...
             'end'...
             'if ~istable(val) && ~isstruct(val) && ~isa(val, ''containers.Map'')'...
-            ['    error(''Property `' name '` must be a table,struct, or containers.Map.'');']...
+            ['    error(''NWB:Type:InvalidPropertyType'', ''Property `' name '` must be a table, struct, or containers.Map.'');']...
             'end'...
             'vprops = struct();'...
             }, newline);
@@ -294,8 +294,7 @@
 
     classNameSplit = strsplit(className, '.');
     shortName = classNameSplit{end};
-
-    errorStr = sprintf( 'error(''Unable to set the ''''%s'''' property of class ''''<a href="matlab:doc %s">%s</a>'''' because it is read-only.'')', name, className, shortName);  
+    errorStr = sprintf( 'error(''NWB:Type:ReadOnlyProperty'', ''Unable to set the ''''%s'''' property of class ''''<a href="matlab:doc %s">%s</a>'''' because it is read-only.'')', name, className, shortName);  
 
     if ischar(value)
         condition = strjoin({ ...
@@ -311,7 +310,8 @@
         % Note: According to the documentation for Attribute specification keys
         % (https://schema-language.readthedocs.io/en/latest/description.html#sec-attributes-spec),
         % the above cases should be sufficient.
-        error('Unhandled case')
+        error('NWB:ClassGenerator:ReadOnlyValidatorNotImplemented', ...
+            'Read-only validator is not implemented for values of type "%s"', class(value))
     end
 
     fdvstr = strjoin({...

+io/getBaseType.m

@@ -45,6 +45,7 @@
 
     id = [prefix suffix];
 else
-    error('Type `%s` is not a supported raw type', type);
+    error('NWB:IO:UnsupportedBaseType', ...
+        'Type `%s` is not a supported raw type', type);
 end
 end

+io/parseGroup.m

@@ -116,14 +116,14 @@
         if any(leads)
             %since set has been edited, we bubble up deletion of the old keys.
             subset = elide(pvalue, prop(leads), pvar);
-            elided = [elided; subset];
+            elided = [elided; subset]; %#ok<AGROW>
             if pvalue.Count == 0
                 drop(i) = true;
             elseif any(strcmp(pvar, prop))
                 elided(pvar) = pvalue;
                 drop(i) = true;
             else
-                warning('Unable to match property `%s` under prefix `%s`',...
+                warning('NWB:Parse:UnmatchedProperty', 'Unable to match property `%s` under prefix `%s`',...
                     pvar, prefix);
             end
         end

+io/resolvePath.m

@@ -8,7 +8,6 @@
 
 %process slash tokens
 o = nwb;
-errmsg = 'Could not resolve path `%s`.';
 while ~isempty(tokens)
     if isa(o, 'types.untyped.Set')
         [o, tokens] = resolveSet(o, tokens);
@@ -18,7 +17,7 @@
         [o, tokens] = resolveObj(o, tokens);
     end
     if isempty(o)
-        error(errmsg, path);
+        error('NWB:IO:UnresolvedPath', 'Could not resolve path `%s`.', path);
     end
 end
 end

+io/timestamp2datetime.m

@@ -113,9 +113,8 @@
     elseif ischar(timestamps)
         cells = {timestamps};
     else
-        errorId = "NWB:timestamp2datetime:MustBeCharCellArrayOrString";
-        errorMsg = ['timestamps must be a string, character array, ', ...
-                    'or cell array of strings/character arrays.'];
-        error(errorId, errorMsg);
+        error('NWB:timestamp2datetime:MustBeCharCellArrayOrString', ...
+              [ 'Timestamps must be a string, character array, ', ...
+              'or cell array of strings/character arrays.' ]);
     end
 end