Skip to content
Snippets Groups Projects
Commit 8672bac3 authored by Lemmer, Jan's avatar Lemmer, Jan
Browse files

correct typos

parent 8ec81a67
No related branches found
No related tags found
2 merge requests!43Implements #73, cleans up example file,,!38Dev/example
Pipeline #596266 failed
classdef config < handle classdef config < handle
%CONFIG class handles methoths and attributes related to the config %CONFIG class handles methods and attributes related to the config
%file %file
% Detailed explanation goes here
%handle class used for dynamicy property updates %handle class used for dynamicy property updates
properties (SetAccess = private) properties (SetAccess = private)
...@@ -19,7 +18,8 @@ classdef config < handle ...@@ -19,7 +18,8 @@ classdef config < handle
methods methods
function obj = config(configFileName) function obj = config(configFileName)
%CONFIG Construct an instance of this class %CONFIG Construct an instance of this class
% Detailed explanation goes here % reads config data from config file, if an error occurs the
% wizard is started by the catch block
obj.configFileName = configFileName; obj.configFileName = configFileName;
try try
txt = fileread(obj.configFileName); txt = fileread(obj.configFileName);
...@@ -62,19 +62,13 @@ classdef config < handle ...@@ -62,19 +62,13 @@ classdef config < handle
end end
function configData = addPublishOptions(obj,mode) function configData = addPublishOptions(obj,mode)
%writeConfig writes the config file to path %addPublishOptions adds the publsih options to the config
% TODo; %object depending on the mode
obj.configData.options = obj.plotID_options(mode); obj.configData.options = obj.plotID_options(mode);
cpath = fileparts(obj.configPath); cpath = fileparts(obj.configPath);
obj.writeConfig(cpath); obj.writeConfig(cpath);
end end
function outputArg = method1(obj,inputArg)
%METHOD1 Summary of this method goes here
% Detailed explanation goes here
outputArg = obj.Property1 + inputArg;
end
end end
methods (Static) methods (Static)
......
function [options] = plotID_options(input) function [options] = plotID_options(input)
%PLOTID_OPTIONS Summary of this function goes here %PLOTID_OPTIONS gives you a struct with all the options defined in publish
% Detailed explanation goes here % Two modes are implemented default and debug
options = struct(); options = struct();
switch input switch input
......
...@@ -38,8 +38,7 @@ classdef userDLG ...@@ -38,8 +38,7 @@ classdef userDLG
end end
function obj = set.msg(obj,message) function obj = set.msg(obj,message)
%setmsg Summary of this method goes here %setmsg sets a message text
% Detailed explanation goes here
obj.msg = message; obj.msg = message;
end end
...@@ -83,12 +82,6 @@ classdef userDLG ...@@ -83,12 +82,6 @@ classdef userDLG
error(message); error(message);
end end
end end
function outputArg = method1(obj,inputArg)
%METHOD1 Summary of this method goes here
% Detailed explanation goes here
outputArg = obj.Property1 + inputArg;
end
end end
end end
function [x,y, fpath] = createExampleData(option) function [x,y, fpath] = createExampleData(option)
%CREATEEXAMPLEDATA creates x,y Data needed for all PlotID Examples %CREATEEXAMPLEDATA creates x,y data needed for the PlotID examples
% fpath contains the file path of the example data % fpath contains the file path of the example data
% there are two options, the option 'matlab' creates a matlab file and the
% hdf option a hdf5 file
switch option switch option
case 'hdf' case 'hdf'
...@@ -22,7 +24,7 @@ switch option ...@@ -22,7 +24,7 @@ switch option
h5write(fpath, "/x", x) h5write(fpath, "/x", x)
h5write(fpath, "/y", y) h5write(fpath, "/y", y)
case 'matlab' case 'matlab'
% Creating Random Data to use as data-file % Creating random data to use as data-file
x = linspace(0,7); y = rand(1,100)+2; x = linspace(0,7); y = rand(1,100)+2;
dataset = 'test_data.mat'; dataset = 'test_data.mat';
% Use absolute paths for good practise % Use absolute paths for good practise
......
%% Example Script %% Example Script
% This Script is meant to demonstrate the capabilities of the PlotID tool. % This Script is ment to demonstrate the capabilities of the PlotID tool.
% please run Initilisation.m before first time usage % please run Initilisation.m before first time use
%% Clear an set Environment %% Clear and set Environment
clear; clc; close all; clear; clc; close all;
addpath('Examples'); addpath('Examples');
...@@ -55,7 +55,7 @@ fig2 = figure; plot(x,y,'-k'); box off; set(gca, 'TickDir', 'out', 'YLim', [0,4] ...@@ -55,7 +55,7 @@ fig2 = figure; plot(x,y,'-k'); box off; set(gca, 'TickDir', 'out', 'YLim', [0,4]
scriptPath = [mfilename('fullpath'),'.m']; scriptPath = [mfilename('fullpath'),'.m'];
% file paths of the datasets used for the plot (don't forget the extension) % file paths of the datasets used for the plot (don't forget the extension)
% datapath = test_data.mat % datapath = 'test_data.mat';
locations = datapath; locations = datapath;
%call publish %call publish
...@@ -66,7 +66,7 @@ PlotID.Publish(locations,scriptPath, fig2) ...@@ -66,7 +66,7 @@ PlotID.Publish(locations,scriptPath, fig2)
%% Further examples and help %% Further examples and help
% You find more examples in the Examples folder: % You find more examples in the Examples folder:
% Advanced Usage % Advanced usage
% Working with HDF5-files % Working with HDF5-files
% Using a central data folder % Using a central data folder
% How to use advanced config-files % How to use advanced config-files
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment