1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
|
## Copyright (C) 2019 John D <john.donoghue@ieee.org>
##
## This program is free software; you can redistribute it and/or modify it under
## the terms of the GNU General Public License as published by the Free Software
## Foundation; either version 3 of the License, or (at your option) any later
## version.
##
## This program is distributed in the hope that it will be useful, but WITHOUT
## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
## details.
##
## You should have received a copy of the GNU General Public License along with
## this program; if not, see <http://www.gnu.org/licenses/>.
## -*- texinfo -*-
## @deftypefn {Function File} {@var{struct} = } get (@var{serial})
## @deftypefnx {Function File} {@var{field} = } get (@var{serial}, @var{property})
## Get the properties of serialport object.
##
## @subsubheading Inputs
## @var{serial} - instance of @var{octave_serialport} class.@*
## @var{property} - name of property.@*
##
## @subsubheading Outputs
## When @var{property} was specified, return the value of that property.@*
## otherwise return the values of all properties as a structure.@*
##
## @seealso{@@octave_serial/set}
## @end deftypefn
function retval = get (serial, property)
properties = {'Port', 'BaudRate', 'NumBytesAvailable', 'NumBytesWritten', ...
'ByteOrder', 'DataBits', 'StopBits', 'Parity', 'FlowControl', ...
'Timeout', 'Terminator', 'UserData'};
if (nargin == 1)
property = properties;
elseif (nargin > 2)
# TODO: multi properties ?
error ("Too many arguments.\n");
end
if !iscell (property)
property = {property};
end
valid = ismember (property, properties);
not_found = {property{!valid}};
if !isempty (not_found)
msg = @(x) error("serialport:get:InvalidArgument", ...
"Unknown property '%s'.\n",x);
cellfun (msg, not_found);
end
property = {property{valid}};
retval = {};
for i=1:length(property)
retval{end+1} = __srlp_properties__ (serial, property{i});
endfor
if numel(property) == 1
retval = retval{1};
elseif (nargin == 1)
retval = cell2struct (retval',properties);
end
end
|
