Homec4science
Diffusion Instrument Control (FreqRINCal) Browse

rINSTCONTROL/@MyInstrument/MyInstrument.m
10cb1d0d9b17FreqRINCal

Last Change
Raw File

MyInstrument.m
View Options

classdef MyInstrument < handle
properties (SetAccess=protected, GetAccess=public)
name='';
interface='';
address='';
axes_handle=[];
%Logical for whether gui is enabled
enable_gui=false;
%Contains the GUI handles
Gui;
%Contains the device object
Device;
%Input parser for class constructor
Parser;
%Contains a list of the commands available for the instrument as
%well as the default values and input requirements
CommandList;
%Parses commands using an inputParser object
CommandParser;
end
properties (Dependent=true)
command_names;
command_no;
end
events
NewData;
Deletion;
end
methods
function this=MyInstrument(name, interface, address, varargin)
createParser(this);
parse(this.Parser,name,interface,address,varargin{:});
%Loads parsed variables into class properties
this.name=this.Parser.Results.name;
this.interface=this.Parser.Results.interface;
this.address=this.Parser.Results.address;
this.enable_gui=~ismember('gui',this.Parser.UsingDefaults);
this.axes_handle=this.Parser.Results.axes_handle;
try
openDevice(this);
closeDevice(this);
catch
error(['Failed to open communications with device.',...
' Check that the address and interface is correct'])
end
%If a gui input is given, load the gui
if this.enable_gui
%Loads the gui from the input gui string
this.Gui=guihandles(eval(this.Parser.Results.gui));
%Sets figure close function such that class will know when
%figure is closed
set(this.Gui.figure1, 'CloseRequestFcn',...
@(hObject,eventdata) closeFigure(this, hObject, ...
eventdata));
end
end
%Triggers event for acquired data
function triggerNewData(this)
notify(this,'NewData')
end
%Triggers event for deletion
function triggerDeletion(this)
notify(this,'Deletion');
end
function delete(this)
%Removes close function from figure, prevents infinite loop
if this.enable_gui
set(this.Gui.figure1,'CloseRequestFcn','');
%Deletes the figure
delete(this.Gui.figure1);
%Removes the figure handle to prevent memory leaks
this.Gui=[];
end
%Closes the connection to the device
closeDevice(this);
%Deletes the device object
delete(this.Device);
clear('this.Device');
triggerDeletion(this);
end
end
methods
%Checks if the connection to the device is open
function bool=isopen(this)
bool=strcmp(this.Device.Status, 'open');
end
function createParser(this)
p=inputParser;
addRequired(p,'name',@ischar);
addRequired(p,'interface',@ischar);
addRequired(p,'address',@ischar);
addParameter(p,'gui','placeholder',@ischar);
addParameter(p,'axes_handle',[]);
this.Parser=p;
end
%Sends a read command to the device
function result=read(this,command)
result=query(this.Device, command);
end
%Writes to the device
function write(this, command)
fprintf(this.Device, command);
end
function writeProperty(this, varargin)
%Parses the inputs using the CommandParser
parse(this.CommandParser, varargin{:});
%Finds the commands that are supplied by the user
ind=~ismember(this.CommandParser.Parameters,...
this.CommandParser.UsingDefaults);
%Creates a list of commands to be executed
exec=this.CommandParser.Parameters(ind);
for i=1:length(exec)
command=sprintf(this.CommandList.(exec{i}).command,...
this.CommandParser.Results.(exec{i}));
write(this, command);
end
end
function result=readProperty(this, varargin)
result=struct();
for i=1:length(varargin)
%Finds the index of the % sign which indicates where the value
%to be written is supplied
ind=strfind(this.CommandList.(varargin{i}).command,'%');
if ~any(ind)
error('%s is not a valid tag for a command in %s',...
varargin{i},class(this));
end
%Creates the correct read command
read_command=...
[this.CommandList.(varargin{i}).command(1:(ind-2)),'?'];
%Reads the property from the device and stores it in the
%correct place
result.(varargin{i})=str2double(this.read(read_command));
end
end
%Adds a command to the CommandList
function addCommand(this, tag, command, varargin)
p=inputParser;
addRequired(p,'tag',@ischar);
addRequired(p,'command',@ischar);
addParameter(p,'default','placeholder');
addParameter(p,'attributes','placeholder',@iscell)
%If the write flag is on, it means this command can be used to
%write a parameter to the device
addParameter(p,'write_flag',false,@islogical)
parse(p,tag,command,varargin{:});
if ~isprop(this, tag) && p.Results.write_flag
error('All commands must have a tag matching the property they modify')
end
%Adds the command to be sent to the device
this.CommandList.(tag).command=command;
this.CommandList.(tag).write_flag=p.Results.write_flag;
%Adds a default value and the attributes the inputs must have
if p.Results.write_flag
%Adds the default value
this.CommandList.(tag).default=p.Results.default;
%Adds the necessary attributes for the input to the command
this.CommandList.(tag).attributes=p.Results.attributes;
end
end
%Creates inputParser using the command list
function createCommandParser(this)
%Use input parser
%Requires input of the appropriate class
p=inputParser;
p.StructExpand=0;
for i=1:this.command_no
%Adds optional inputs for each command, with the
%appropriate default value from the command list and the
%required attributes for the command input.
addParameter(p, this.command_names{i},...
this.CommandList.(this.command_names{i}).default),...
@(x) validateattributes(x,...
this.CommandList.(this.command_names{i}).attributes{1:end});
end
this.CommandParser=p;
end
%Connects to the device if it is not connected
function openDevice(this)
if ~isopen(this)
try
fopen(this.Device);
catch
try
instr_list=instrfind('RemoteHost',this.address);
fclose(instr_list);
fopen(this.Device);
warning('Multiple instrument objects of address %s exist',...
this.address);
catch
error('Could not open device')
end
end
end
end
%Closes the connection to the device
function closeDevice(this)
if isopen(this)
try
fclose(this.Device);
catch
error('Could not close device')
end
end
end
%Close figure callback simply calls delete function for class
function closeFigure(this,~,~)
delete(this);
end
function command_names=get.command_names(this)
command_names=fieldnames(this.CommandList);
end
function command_no=get.command_no(this)
command_no=length(this.command_names);
end
end
end
c4science · Help