Homec4science
Diffusion Instrument Control (FreqRINCal) Browse

rINSTCONTROL/@MyScpiInstrument/MyScpiInstrument.m
eed2ae856a1eFreqRINCal

Last Change
Raw File

MyScpiInstrument.m
View Options

% Class featuring a specialized framework for instruments supporting SCPI
%
% Undefined/dummy methods:
% queryString(this, cmd)
% writeString(this, cmd)
% createCommandList(this)
classdef MyScpiInstrument < MyInstrument
methods (Access = public)
% Extend the functionality of base class method
function addCommand(this, tag, command, varargin)
p = inputParser();
p.KeepUnmatched = true;
addRequired(p,'command',@ischar);
addParameter(p,'access','rw',@ischar);
addParameter(p,'format','%e',@ischar);
% Command ending for reading
addParameter(p,'read_ending','?',@ischar);
% Command ending for writing, e.g. '%10e'
addParameter(p,'write_ending','',@ischar);
parse(p, command, varargin{:});
% Create a list of remaining parameters to be supplied to
% the base class method
sub_varargin = struct2namevalue(p.Unmatched);
% Introduce variables for brevity
format = p.Results.format;
write_ending = p.Results.write_ending;
smb = findReadFormatSymbol(this, format);
if smb == 'b'
% '%b' is a non-MATLAB format specifier that is introduced
% to be used with logical variables
format = replace(format,'%b','%i');
write_ending = replace(write_ending,'%b','%i');
end
this.CommandList.(tag).format = format;
% Add the full read form of the command, e.g. ':FREQ?'
if contains(p.Results.access,'r')
read_command = [p.Results.command, p.Results.read_ending];
readFcn = ...
@()sscanf(queryString(this, read_command), format);
sub_varargin = [sub_varargin, {'readFcn', readFcn}];
else
read_command = '';
end
this.CommandList.(tag).read_command = read_command;
% Add the full write form of the command, e.g. ':FREQ %e'
if contains(p.Results.access,'w')
if ismember('write_ending', p.UsingDefaults)
write_command = [p.Results.command, ' ', format];
else
write_command = [p.Results.command, write_ending];
end
writeFcn = ...
@(x)writeString(this, sprintf(write_command, x));
sub_varargin = [sub_varargin, {'writeFcn', writeFcn}];
else
write_command = '';
end
this.CommandList.(tag).write_command = write_command;
% Execute the base class method
addCommand@MyInstrument(this, tag, sub_varargin{:});
% If the value list contains textual values, extend it with
% short forms and add a postprocessing function
vl = this.CommandList.(tag).value_list;
if ~isempty(vl) && any(cellfun(@ischar, vl))
% Put only unique full-named values in the value list
[long_vl, short_vl] = splitValueList(this, vl);
this.CommandList.(tag).value_list = long_vl;
% For validation, use an extended list made of full and
% abbreviated name forms and case-insensitive comparison
this.CommandList.(tag).validationFcn = ...
createScpiListValidationFcn(this, [long_vl, short_vl]);
this.CommandList.(tag).postSetFcn = ...
createToStdFormFcn(this, tag, long_vl);
end
% Assign validation function based on the value format
if isempty(this.CommandList.(tag).validationFcn)
switch smb
case {'d','f','e','g'}
this.CommandList.(tag).validationFcn = @(x) ...
assert(isnumeric(x), 'Value must be numeric.');
case 'i'
this.CommandList.(tag).validationFcn = @(x) ...
assert(floor(x)==x, 'Value must be integer.');
case 's'
this.CommandList.(tag).validationFcn = @(x) ...
assert(ischar(x), ...
'Value must be character string.');
case 'b'
this.CommandList.(tag).validationFcn = @(x) ...
assert(x==0 || x==1, 'Value must be logical.');
end
end
end
% Redefine the base class method to use a single read operation for
% faster communication
function sync(this)
cns = this.command_names;
ind_r = structfun(@(x) ~isempty(x.read_command), ...
this.CommandList);
read_cns = cns(ind_r); % List of names of readable commands
read_commands = cellfun(...
@(x) this.CommandList.(x).read_command, read_cns,...
'UniformOutput',false);
res_list = queryStrings(this, read_commands{:});
if length(read_cns)==length(res_list)
% Assign outputs to the class properties
for i=1:length(read_cns)
tag = read_cns{i};
val = sscanf(res_list{i}, ...
this.CommandList.(tag).format);
if ~isequal(this.CommandList.(tag).last_value, val)
% Assign value without writing to the instrument
this.CommandList.(tag).Psl.Enabled = false;
this.(tag) = val;
this.CommandList.(tag).Psl.Enabled = true;
end
end
else
warning(['Not all the properties could be read, ',...
'instrument class values are not updated.']);
end
end
%% Write/query
% These methods implement handling multiple SCPI commands. Unless
% overloaded, they rely on write/readString methods for
% communication with the device, which particular subclasses must
% implement or inherit separately.
% Write command strings listed in varargin
function writeStrings(this, varargin)
if ~isempty(varargin)
% Concatenate commands and send to the device
cmd_str = join(varargin,';');
cmd_str = cmd_str{1};
writeString(this, cmd_str);
end
end
% Query commands and return the resut as cell array of strings
function res_list = queryStrings(this, varargin)
if ~isempty(varargin)
% Concatenate commands and send to the device
cmd_str = join(varargin,';');
cmd_str = cmd_str{1};
res_str = queryString(this, cmd_str);
% Drop the end-of-the-string symbol and split
res_list = split(deblank(res_str),';');
else
res_list={};
end
end
end
methods (Access = protected)
%% Misc utility methods
% Split the list of string values into a full-form list and a
% list of abbreviations, where the abbreviated forms are inferred
% based on case. For example, the value that has the full name
% 'AVErage' has the short form 'AVE'.
function [long_vl, short_vl] = splitValueList(~, vl)
short_vl = {}; % Abbreviated forms
% Iterate over the list of values
for i=1:length(vl)
% Short forms exist only for string values
if ischar(vl{i})
idx = isstrprop(vl{i},'upper');
short_form = vl{i}(idx);
if ~isequal(vl{i}, short_form) && ~isempty(short_form)
short_vl{end+1} = short_form; %#ok<AGROW>
end
end
end
% Remove duplicates
short_vl = unique(lower(short_vl));
% Make the list of full forms
long_vl = setdiff(lower(vl), short_vl);
end
% Create a function that returns the long form of value from
% value_list
function f = createToStdFormFcn(this, cmd, value_list)
function std_val = toStdForm(val)
% Standardization is applicable to char-valued properties
% which have value list
if isempty(value_list) || ~ischar(val)
std_val = val;
return
end
% find matching values
n = length(val);
ismatch = cellfun(@(x) strncmpi(val, x, ...
min([n, length(x)])), value_list);
assert(any(ismatch), ...
sprintf(['%s is not present in the list of values ' ...
'of command %s.'], val, cmd));
% out of the matching values pick the longest
mvals = value_list(ismatch);
n_el = cellfun(@(x) length(x), mvals);
std_val = mvals{n_el==max(n_el)};
end
assert(ismember(cmd, this.command_names), ['''' cmd ...
''' is not an instrument command.'])
f = @toStdForm;
end
% Find the format specifier symbol and options
function smb = findReadFormatSymbol(~, fmt_spec)
ind_p = strfind(fmt_spec,'%');
ind = ind_p+find(isletter(fmt_spec(ind_p:end)),1)-1;
smb = fmt_spec(ind);
assert(ind_p+1 == ind, ['Correct reading format must not ' ...
'have characters between ''%'' and format symbol.'])
end
function createMetadata(this)
createMetadata@MyInstrument(this);
% Re-iterate the creation of command parameters to add the
% format specifier
for i = 1:length(this.command_names)
cmd = this.command_names{i};
addObjProp(this.Metadata, this, cmd, ...
'comment', this.CommandList.(cmd).info, ...
'fmt_spec', this.CommandList.(cmd).format);
end
end
% List validation function with case-insensitive comparison
function f = createScpiListValidationFcn(~, value_list)
function listValidationFcn(val)
val = lower(val);
assert( ...
any(cellfun(@(y) isequal(val, y), value_list)), ...
['Value must be one from the following list:', ...
newline, var2str(value_list)]);
end
f = @listValidationFcn;
end
end
end
c4science · Help