Skip to content

Commit 73a2fc1

Browse files
mpsonntagmpsonntag
committed
[matlab] Unify function return
- Unifies return value names to r to increase readability. - Always returns empty array when the C++ binding does not return a value. - Cleanup semicolons after control structures.
1 parent 4511b91 commit 73a2fc1

23 files changed

+753
-789
lines changed

‎+nix/Block.m‎

Lines changed: 131 additions & 147 deletions
Original file line numberDiff line numberDiff line change
@@ -13,85 +13,80 @@
1313
% namespace reference for nix-mx functions
1414
alias = 'Block'
1515
end
16-
16+
1717
methods
1818
function obj = Block(h)
1919
[email protected](h);
2020
[email protected]();
21-
21+
2222
% assign relations
2323
nix.Dynamic.add_dyn_relation(obj, 'groups', @nix.Group);
2424
nix.Dynamic.add_dyn_relation(obj, 'dataArrays', @nix.DataArray);
2525
nix.Dynamic.add_dyn_relation(obj, 'sources', @nix.Source);
2626
nix.Dynamic.add_dyn_relation(obj, 'tags', @nix.Tag);
2727
nix.Dynamic.add_dyn_relation(obj, 'multiTags', @nix.MultiTag);
28-
end;
29-
28+
end
29+
3030
% -----------------
3131
% Group methods
3232
% -----------------
33-
34-
function c = group_count(obj)
35-
c = nix_mx('Block::groupCount', obj.nix_handle);
33+
34+
function r = group_count(obj)
35+
r = nix_mx('Block::groupCount', obj.nix_handle);
3636
end
3737

38-
function g = create_group(obj, name, nixtype)
39-
handle = nix_mx('Block::createGroup', obj.nix_handle, ...
40-
name, nixtype);
41-
g = nix.Group(handle);
42-
end;
43-
44-
function hasGroup = has_group(obj, id_or_name)
45-
hasGroup = nix_mx('Block::hasGroup', obj.nix_handle, id_or_name);
46-
end;
38+
function r = create_group(obj, name, nixtype)
39+
h = nix_mx('Block::createGroup', obj.nix_handle, name, nixtype);
40+
r = nix.Group(h);
41+
end
4742

48-
function retObj = get_group(obj, id_or_name)
49-
retObj = nix.Utils.open_entity(obj, ...
50-
'Block::getGroup', id_or_name, @nix.Group);
51-
end;
43+
function r = has_group(obj, id_or_name)
44+
r = nix_mx('Block::hasGroup', obj.nix_handle, id_or_name);
45+
end
5246

53-
function retObj = open_group_idx(obj, idx)
54-
retObj = nix.Utils.open_entity(obj, ...
55-
'Block::openGroupIdx', idx, @nix.Group);
47+
function r = get_group(obj, id_or_name)
48+
r = nix.Utils.open_entity(obj, 'Block::getGroup', id_or_name, @nix.Group);
5649
end
5750

58-
function delCheck = delete_group(obj, del)
59-
delCheck = nix.Utils.delete_entity(obj, ...
60-
del, 'nix.Group', 'Block::deleteGroup');
61-
end;
51+
function r = open_group_idx(obj, idx)
52+
r = nix.Utils.open_entity(obj, 'Block::openGroupIdx', idx, @nix.Group);
53+
end
6254

63-
function filtered = filter_groups(obj, filter, val)
64-
filtered = nix.Utils.filter(obj, filter, val, ...
65-
'Block::groupsFiltered', @nix.Group);
55+
function r = delete_group(obj, del)
56+
r = nix.Utils.delete_entity(obj, del, 'nix.Group', 'Block::deleteGroup');
6657
end
67-
58+
59+
function r = filter_groups(obj, filter, val)
60+
r = nix.Utils.filter(obj, filter, val, 'Block::groupsFiltered', @nix.Group);
61+
end
62+
6863
% -----------------
6964
% DataArray methods
7065
% -----------------
71-
72-
function c = data_array_count(obj)
73-
c = nix_mx('Block::dataArrayCount', obj.nix_handle);
66+
67+
function r = data_array_count(obj)
68+
r = nix_mx('Block::dataArrayCount', obj.nix_handle);
7469
end
7570

76-
function retObj = data_array(obj, id_or_name)
77-
retObj = nix.Utils.open_entity(obj, ...
71+
function r = data_array(obj, id_or_name)
72+
r = nix.Utils.open_entity(obj, ...
7873
'Block::openDataArray', id_or_name, @nix.DataArray);
79-
end;
74+
end
8075

81-
function retObj = open_data_array_idx(obj, idx)
82-
retObj = nix.Utils.open_entity(obj, ...
76+
function r = open_data_array_idx(obj, idx)
77+
r = nix.Utils.open_entity(obj, ...
8378
'Block::openDataArrayIdx', idx, @nix.DataArray);
8479
end
8580

86-
function da = create_data_array(obj, name, nixtype, datatype, shape)
81+
function r = create_data_array(obj, name, nixtype, datatype, shape)
8782
%-- Quick fix to enable alias range dimension with
8883
%-- 1D data arrays created with this function.
8984
%-- e.g. size([1 2 3]) returns shape [1 3], which would not
9085
%-- be accepted when trying to add an alias range dimension.
9186
if(shape(1) == 1)
92-
shape(2:size(shape,2));
93-
end;
94-
87+
shape(2:size(shape, 2));
88+
end
89+
9590
errorStruct.identifier = 'Block:unsupportedDataType';
9691
if(~isa(datatype, 'nix.DataType'))
9792
errorStruct.message = 'Please provide a valid nix.DataType';
@@ -100,21 +95,21 @@
10095
errorStruct.message = 'Writing Strings to DataArrays is not supported as of yet.';
10196
error(errorStruct);
10297
else
103-
handle = nix_mx('Block::createDataArray', obj.nix_handle, ...
98+
h = nix_mx('Block::createDataArray', obj.nix_handle, ...
10499
name, nixtype, lower(datatype.char), shape);
105-
da = nix.DataArray(handle);
106-
end;
100+
r = nix.DataArray(h);
101+
end
107102
end
108-
109-
function da = create_data_array_from_data(obj, name, nixtype, data)
103+
104+
function r = create_data_array_from_data(obj, name, nixtype, data)
110105
shape = size(data);
111106
%-- Quick fix to enable alias range dimension with
112107
%-- 1D data arrays created with this function.
113108
%-- e.g. size([1 2 3]) returns shape [1 3], which would not
114109
%-- be accepted when trying to add an alias range dimension.
115110
if(shape(1) == 1)
116111
shape = size(data, 2);
117-
end;
112+
end
118113

119114
errorStruct.identifier = 'Block:unsupportedDataType';
120115
if(ischar(data))
@@ -127,153 +122,142 @@
127122
else
128123
errorStruct.message = 'DataType of provided data is not supported.';
129124
error(errorStruct);
130-
end;
125+
end
126+
127+
r = obj.create_data_array(name, nixtype, dtype, shape);
128+
r.write_all(data);
129+
end
131130

132-
da = obj.create_data_array(name, nixtype, dtype, shape);
133-
da.write_all(data);
131+
function r = has_data_array(obj, id_or_name)
132+
r = nix_mx('Block::hasDataArray', obj.nix_handle, id_or_name);
134133
end
135134

136-
function hasDA = has_data_array(obj, id_or_name)
137-
hasDA = nix_mx('Block::hasDataArray', obj.nix_handle, id_or_name);
138-
end;
139-
140-
function delCheck = delete_data_array(obj, del)
141-
delCheck = nix.Utils.delete_entity(obj, ...
135+
function r = delete_data_array(obj, del)
136+
r = nix.Utils.delete_entity(obj, ...
142137
del, 'nix.DataArray', 'Block::deleteDataArray');
143-
end;
138+
end
144139

145-
function filtered = filter_data_arrays(obj, filter, val)
146-
filtered = nix.Utils.filter(obj, filter, val, ...
140+
function r = filter_data_arrays(obj, filter, val)
141+
r = nix.Utils.filter(obj, filter, val, ...
147142
'Block::dataArraysFiltered', @nix.DataArray);
148143
end
149144

150145
% -----------------
151146
% Sources methods
152147
% -----------------
153-
154-
function c = source_count(obj)
155-
c = nix_mx('Block::sourceCount', obj.nix_handle);
156-
end
157-
158-
function s = create_source(obj, name, type)
159-
s = nix.Source(nix_mx('Block::createSource', ...
160-
obj.nix_handle, name, type));
161-
end;
162-
163-
function hasSource = has_source(obj, id_or_name)
164-
hasSource = nix_mx('Block::hasSource', obj.nix_handle, id_or_name);
165-
end;
166-
167-
function delCheck = delete_source(obj, del)
168-
delCheck = nix.Utils.delete_entity(obj, ...
169-
del, 'nix.Source', 'Block::deleteSource');
170-
end;
171-
172-
function retObj = open_source(obj, id_or_name)
173-
retObj = nix.Utils.open_entity(obj, ...
174-
'Block::openSource', id_or_name, @nix.Source);
175-
end;
176-
177-
function retObj = open_source_idx(obj, idx)
178-
retObj = nix.Utils.open_entity(obj, ...
179-
'Block::openSourceIdx', idx, @nix.Source);
180-
end
181-
182-
function filtered = filter_sources(obj, filter, val)
183-
filtered = nix.Utils.filter(obj, filter, val, ...
184-
'Block::sourcesFiltered', @nix.Source);
148+
149+
function r = source_count(obj)
150+
r = nix_mx('Block::sourceCount', obj.nix_handle);
151+
end
152+
153+
function r = create_source(obj, name, type)
154+
r = nix.Source(nix_mx('Block::createSource', obj.nix_handle, name, type));
155+
end
156+
157+
function r = has_source(obj, id_or_name)
158+
r = nix_mx('Block::hasSource', obj.nix_handle, id_or_name);
159+
end
160+
161+
function r = delete_source(obj, del)
162+
r = nix.Utils.delete_entity(obj, del, 'nix.Source', 'Block::deleteSource');
163+
end
164+
165+
function r = open_source(obj, id_or_name)
166+
r = nix.Utils.open_entity(obj, 'Block::openSource', id_or_name, @nix.Source);
167+
end
168+
169+
function r = open_source_idx(obj, idx)
170+
r = nix.Utils.open_entity(obj, 'Block::openSourceIdx', idx, @nix.Source);
171+
end
172+
173+
function r = filter_sources(obj, filter, val)
174+
r = nix.Utils.filter(obj, filter, val, 'Block::sourcesFiltered', @nix.Source);
185175
end
186176

187177
% maxdepth is an index
188-
function sec = find_sources(obj, max_depth)
189-
sec = obj.find_filtered_sources(max_depth, nix.Filter.accept_all, '');
178+
function r = find_sources(obj, max_depth)
179+
r = obj.find_filtered_sources(max_depth, nix.Filter.accept_all, '');
190180
end
191181

192182
% maxdepth is an index
193-
function sec = find_filtered_sources(obj, max_depth, filter, val)
194-
sec = nix.Utils.find(obj, ...
183+
function r = find_filtered_sources(obj, max_depth, filter, val)
184+
r = nix.Utils.find(obj, ...
195185
max_depth, filter, val, 'Block::findSources', @nix.Source);
196186
end
197187

198188
% -----------------
199189
% Tags methods
200190
% -----------------
201-
202-
function c = tag_count(obj)
203-
c = nix_mx('Block::tagCount', obj.nix_handle);
191+
192+
function r = tag_count(obj)
193+
r = nix_mx('Block::tagCount', obj.nix_handle);
194+
end
195+
196+
function r = has_tag(obj, id_or_name)
197+
r = nix_mx('Block::hasTag', obj.nix_handle, id_or_name);
204198
end
205199

206-
function hasTag = has_tag(obj, id_or_name)
207-
hasTag = nix_mx('Block::hasTag', obj.nix_handle, id_or_name);
208-
end;
209-
210-
function retObj = open_tag(obj, id_or_name)
211-
retObj = nix.Utils.open_entity(obj, ...
212-
'Block::openTag', id_or_name, @nix.Tag);
213-
end;
200+
function r = open_tag(obj, id_or_name)
201+
r = nix.Utils.open_entity(obj, 'Block::openTag', id_or_name, @nix.Tag);
202+
end
214203

215-
function retObj = open_tag_idx(obj, idx)
216-
retObj = nix.Utils.open_entity(obj, ...
217-
'Block::openTagIdx', idx, @nix.Tag);
204+
function r = open_tag_idx(obj, idx)
205+
r = nix.Utils.open_entity(obj, 'Block::openTagIdx', idx, @nix.Tag);
218206
end
219207

220-
function tag = create_tag(obj, name, type, position)
221-
th = nix_mx('Block::createTag', obj.nix_handle, ...
222-
name, type, position);
223-
tag = nix.Tag(th);
224-
end;
208+
function r = create_tag(obj, name, type, position)
209+
h = nix_mx('Block::createTag', obj.nix_handle, name, type, position);
210+
r = nix.Tag(h);
211+
end
225212

226-
function delCheck = delete_tag(obj, del)
227-
delCheck = nix.Utils.delete_entity(obj, ...
228-
del, 'nix.Tag', 'Block::deleteTag');
229-
end;
213+
function r = delete_tag(obj, del)
214+
r = nix.Utils.delete_entity(obj, del, 'nix.Tag', 'Block::deleteTag');
215+
end
230216

231-
function filtered = filter_tags(obj, filter, val)
232-
filtered = nix.Utils.filter(obj, filter, val, ...
233-
'Block::tagsFiltered', @nix.Tag);
217+
function r = filter_tags(obj, filter, val)
218+
r = nix.Utils.filter(obj, filter, val, 'Block::tagsFiltered', @nix.Tag);
234219
end
235220

236221
% -----------------
237222
% MultiTag methods
238223
% -----------------
239-
240-
function c = multi_tag_count(obj)
241-
c = nix_mx('Block::multiTagCount', obj.nix_handle);
224+
225+
function r = multi_tag_count(obj)
226+
r = nix_mx('Block::multiTagCount', obj.nix_handle);
242227
end
243228

244-
function hasMTag = has_multi_tag(obj, id_or_name)
245-
hasMTag = nix_mx('Block::hasMultiTag', obj.nix_handle, id_or_name);
246-
end;
229+
function r = has_multi_tag(obj, id_or_name)
230+
r = nix_mx('Block::hasMultiTag', obj.nix_handle, id_or_name);
231+
end
247232

248-
function retObj = open_multi_tag(obj, id_or_name)
249-
retObj = nix.Utils.open_entity(obj, ...
233+
function r = open_multi_tag(obj, id_or_name)
234+
r = nix.Utils.open_entity(obj, ...
250235
'Block::openMultiTag', id_or_name, @nix.MultiTag);
251-
end;
236+
end
252237

253-
function retObj = open_multi_tag_idx(obj, idx)
254-
retObj = nix.Utils.open_entity(obj, ...
255-
'Block::openMultiTagIdx', idx, @nix.MultiTag);
238+
function r = open_multi_tag_idx(obj, idx)
239+
r = nix.Utils.open_entity(obj, 'Block::openMultiTagIdx', idx, @nix.MultiTag);
256240
end
257241

258242
%-- Creating a multitag requires an already existing data array
259-
function multitag = create_multi_tag(obj, name, type, add_data_array)
243+
function r = create_multi_tag(obj, name, type, add_data_array)
260244
if(strcmp(class(add_data_array), 'nix.DataArray'))
261245
addID = add_data_array.id;
262246
else
263247
addID = add_data_array;
264-
end;
265-
266-
multitag = nix.MultiTag(nix_mx('Block::createMultiTag', ...
267-
obj.nix_handle, name, type, addID));
268-
end;
269-
270-
function delCheck = delete_multi_tag(obj, del)
271-
delCheck = nix.Utils.delete_entity(obj, ...
248+
end
249+
250+
h = nix_mx('Block::createMultiTag', obj.nix_handle, name, type, addID);
251+
r = nix.MultiTag(h);
252+
end
253+
254+
function r = delete_multi_tag(obj, del)
255+
r = nix.Utils.delete_entity(obj, ...
272256
del, 'nix.MultiTag', 'Block::deleteMultiTag');
273-
end;
257+
end
274258

275-
function filtered = filter_multi_tags(obj, filter, val)
276-
filtered = nix.Utils.filter(obj, filter, val, ...
259+
function r = filter_multi_tags(obj, filter, val)
260+
r = nix.Utils.filter(obj, filter, val, ...
277261
'Block::multiTagsFiltered', @nix.MultiTag);
278262
end
279263
end

0 commit comments

Comments
 (0)