Use the new preference class. (#54)

* Created @swpref class * Added static properties * Added documentation to @swpref * Pref class (#53) * Created @swpref class * Created @swpref class (#51) * Added static properties * Added documentation to @swpref * cosmetic changes - updated help strings * More cosmetic changes * Fix recursion error
tsdev · Dec 1, 2017 · 611f084 · 611f084
1 parent 46fb74a
commit 611f084
Show file tree

Hide file tree

Showing 63 changed files with 988 additions and 330 deletions.
diff --git a/dev/@spinw/corespec.m b/dev/@spinw/corespec.m
@@ -124,12 +124,13 @@
 % whether the structure is incommensurate
 incomm = any(abs(km-round(km)) > param.tol);
 
-fid = swpref.getpref('fid',true);
+pref = swpref;
+fid = pref.fid;
 
 nHkl    = size(hkl,2);
 
 % use mex file by default?
-useMex = swpref.getpref('usemex',[]);
+useMex = pref.usemex;
 
 % Create the interaction matrix and atomic positions in the extended
 % magnetic unit cell.

diff --git a/dev/@spinw/phonon.m b/dev/@spinw/phonon.m
@@ -98,7 +98,8 @@
 
 % solve the eigenvalue problem
 %[ea,om2] = eigenshuffle(Dab);
-[ea,om2] = eigorth(Dab, param.omega_tol, swpref.getpref('usemex',[]));
+pref = swpref;
+[ea,om2] = eigorth(Dab, param.omega_tol, pref.usemex);
 
 om = sqrt(real(om2));
 

diff --git a/dev/@spinw/scga.m b/dev/@spinw/scga.m
@@ -61,8 +61,10 @@
     spectra.datestart = datestr(now);
 end
 
+pref = swpref;
+
 if param.fid == -1
-    fid  = swpref.getpref('fid',true);
+    fid  = pref.fid;
 else
     fid = param.fid;
 end

diff --git a/dev/@spinw/scga3.m b/dev/@spinw/scga3.m
@@ -41,7 +41,9 @@
     param.plot = false;
 end
 
-fid  = swpref.getpref('fid',true);
+pref = swpref;
+fid  = pref.fid;
+
 
 kBT  = param.T*obj.unit.kB;
 beta = 1./kBT;

diff --git a/docs/docgenerator/docgen.m b/docs/docgenerator/docgen.m
@@ -1,13 +1,13 @@
 %% setup help generator options
 
-swPath  = {'swfiles/@spinw' 'swfiles' 'swfiles/+swplot' 'swfiles/+swpref' 'swfiles/+swsym' 'swfiles/+swfunc' 'swfiles/+ndbase'};
+swPath  = {'swfiles/@spinw' 'swfiles' 'swfiles/+swplot' 'swfiles/@swpref' 'swfiles/+swsym' 'swfiles/+swfunc' 'swfiles/+ndbase'};
 swr     = sw_rootdir;
 swPath  = cellfun(@(C)[swr C],swPath,'UniformOutput',false);
 swver   = sw_version;
 outPath = '~/spinwdoc_git';
 docPath = '~/spinw_git/docs';
-upload  = true;
-recalc  = true;
+upload  = false;
+recalc  = false;
 
 %% generate help
 

diff --git a/swfiles/+ndbase/pso.m b/swfiles/+ndbase/pso.m
@@ -126,9 +126,10 @@
 inpForm.size   = [inpForm.size   {[1 1]     [1 1]            [1 Np]     [1 Np]  [1 1]     [1 1]}];
 
 param = sw_readparam(inpForm, varargin{:});
+pref = swpref;
 
 if param.tid == -1
-    param.tid = swpref.getpref('tid',[]);
+    param.tid = pref.tid;
 end
 
 % parameter boundaries

diff --git a/swfiles/+swplot/activefigure.m b/swfiles/+swplot/activefigure.m
@@ -54,7 +54,8 @@
 end
 
 % tag for active figure
-activeTag = swpref.getpref('tag',[]);
+pref = swpref;
+activeTag = pref.tag;
 
 % tag for inactive figures
 inactiveTag = ['inactive_' activeTag];

diff --git a/swfiles/+swplot/arrow.m b/swfiles/+swplot/arrow.m
@@ -108,8 +108,10 @@
 
 end
 
+pref = swpref;
+
 if isempty(nPatch)
-    nPatch = swpref.getpref('npatch',[]);
+    nPatch = pref.npatch;
 end
 
 if numel(rStart)==3

diff --git a/swfiles/+swplot/circle.m b/swfiles/+swplot/circle.m
@@ -93,10 +93,12 @@
     argExt  = {varargin{4:end}};
 end
 
+pref = swpref;
+
 if nArgExt > 0
     N = argExt{1};
 else
-    N = swpref.getpref('npatch',[]);
+    N = pref.npatch;
 end
 
 if numel(r0) == 3

diff --git a/swfiles/+swplot/close.m b/swfiles/+swplot/close.m
@@ -23,9 +23,12 @@ function close(varargin)
 % [swplot.figure]
 %
 
+pref = swpref;
+
+
 if nargin == 0
     % check if there is any swplot figure
-    activeTag = swpref.getpref('tag',[]);
+    activeTag = pref.tag;
     inactiveTag = ['inactive_' activeTag];
     if isempty([findobj('tag',activeTag) findobj('tag',inactiveTag)])
         % nothing to close
@@ -45,7 +48,7 @@ function close(varargin)
     close(hFigure);
 else
     % close all swplot figure
-    activeTag = swpref.getpref('tag',[]);
+    activeTag = pref.tag;
     % tag for inactive figures
     inactiveTag = ['inactive_' activeTag];
 

diff --git a/swfiles/+swplot/cylinder.m b/swfiles/+swplot/cylinder.m
@@ -65,6 +65,8 @@
 % [swplot.arrow]
 %
 
+pref = swpref;
+
 if nargin == 0
     swhelp swplot.cylinder
     return
@@ -102,7 +104,7 @@
 end
 
 if isempty(nPatch)
-    nPatch = swpref.getpref('npatch',[]);
+    nPatch = pref.npatch;
 end
 
 if nArgExt > 1

diff --git a/swfiles/+swplot/ellipsoid.m b/swfiles/+swplot/ellipsoid.m
@@ -53,6 +53,7 @@
 % 
 % [matlab.triangulation] \| [swplot.icomesh]
 %
+pref = swpref;
 
 if nargin == 0
     swhelp swplot.ellipsoid
@@ -95,7 +96,7 @@
 
 if isnumeric(mesh)
     % limit the largest mesh to plot to avoid slowing down Matlab too much
-    mesh = min(mesh,swpref.getpref('maxmesh',[]));
+    mesh = min(mesh,pref.maxmesh);
     % generate mesh
     mesh = swplot.icomesh(mesh);
 end

diff --git a/swfiles/+swplot/figure.m b/swfiles/+swplot/figure.m
@@ -35,6 +35,7 @@
 % if ~isempty(get(0,'CurrentFigure'))
 %     oldAxis = get(gcf,'CurrentAxes');
 % end
+pref = swpref;
 
 if nargin == 0
     mode = 'hg';
@@ -76,7 +77,7 @@
     'Name',         'swplot',...
     'DockControls', 'off',...
     'PaperType',    'A4',...
-    'Tag',          swpref.getpref('tag',[]),...
+    'Tag',          pref.tag,...
     'Toolbar',      'figure',...
     'DeleteFcn',    @closeSubFigs...
     );

diff --git a/swfiles/+swplot/legend.m b/swfiles/+swplot/legend.m
@@ -45,6 +45,7 @@
 % : Handle of the swplot figure, default value is the handle of the active
 %   figure.
 %
+pref = swpref;
 
 if nargin == 0
     switch0 = 'on';
@@ -123,7 +124,7 @@
 lColor = lDat.color;
 
 % get the stored fontsize
-fontSize = swpref.getpref('fontsize',[]);
+fontSize = pref.fontsize;
 
 for ii = 1:numel(lType)
     switch lType(ii)

diff --git a/swfiles/+swplot/plot.m b/swfiles/+swplot/plot.m
@@ -151,9 +151,10 @@
 % [swplot.color] \| [swplot.add]
 %
 
-P0 = swpref.getpref('npatch',[]);
-M0 = swpref.getpref('nmesh',[]);
-fontSize0 = swpref.getpref('fontsize',[]);
+pref = swpref;
+P0 = pref.npatch;
+M0 = pref.nmesh;
+fontSize0 = pref.fontsize;
 
 inpForm.fname  = {'type' 'name' 'text' 'position' 'label' 'legend' 'color' 'unit' 'figure' 'lineStyle'};
 inpForm.defval = {[]     []     ''     []         []      []       []      'lu'   []       '-'        };

diff --git a/swfiles/+swplot/plotatom.m b/swfiles/+swplot/plotatom.m
@@ -133,10 +133,12 @@
 % sObject = swplot.findobj(hFigure,'name','atom')`.
 %
 
+pref = swpref;
+
 % default values
-fontSize0 = swpref.getpref('fontsize',[]);
-nMesh0    = swpref.getpref('nmesh',[]);
-nPatch0   = swpref.getpref('npatch',[]);
+fontSize0 = pref.fontsize;
+nMesh0    = pref.nmesh;
+nPatch0   = pref.npatch;
 
 inpForm.fname  = {'range' 'legend' 'label' 'dtext' 'fontsize' 'radius0'};
 inpForm.defval = {[]      true     false    0.1     fontSize0  0.3     };

diff --git a/swfiles/+swplot/plotbase.m b/swfiles/+swplot/plotbase.m
@@ -97,10 +97,11 @@
 %
 
 % default values
+pref = swpref;
 col0    = swplot.color({'red' 'green' 'blue'});
 d0      = ones(1,3);
-nMesh0  = swpref.getpref('nmesh',[]);
-nPatch0 = swpref.getpref('npatch',[]);
+nMesh0  = pref.nmesh;
+nPatch0 = pref.npatch;
 
 inpForm.fname  = {'range' 'mode'    'figure' 'color' 'R'   'alpha' 'lhead' 'shift'};
 inpForm.defval = {[]      'abc'     []       col0    0.06  30      0.5     [0;0;0]};

diff --git a/swfiles/+swplot/plotbond.m b/swfiles/+swplot/plotbond.m
@@ -222,8 +222,9 @@
 
 % default values
 %fontSize0 = swpref.getpref('fontsize',[]);
-nMesh0    = swpref.getpref('nmesh',[]);
-nPatch0   = swpref.getpref('npatch',[]);
+pref = swpref;
+nMesh0    = pref.nmesh;
+nPatch0   = pref.npatch;
 
 inpForm.fname  = {'range' 'legend' 'label' 'zero' 'scale' 'radius0' 'mode2' 'linewidth'};
 inpForm.defval = {[]      true     true    true   1/3     0.05      []      'fix'      };

diff --git a/swfiles/+swplot/plotcell.m b/swfiles/+swplot/plotcell.m
@@ -119,8 +119,9 @@
 %
 
 % default values
-nMesh0    = swpref.getpref('nmesh',[]);
-nPatch0   = swpref.getpref('npatch',[]);
+pref = swpref;
+nMesh0    = pref.nmesh;
+nPatch0   = pref.npatch;
 
 inpForm.fname  = {'range' 'mode'   'figure' 'color' 'linestyle' 'linewidth'};
 inpForm.defval = {[]      'single' []       'auto'  '--'         1         };

diff --git a/swfiles/+swplot/plotchem.m b/swfiles/+swplot/plotchem.m
@@ -148,8 +148,9 @@
 %
 
 % default values
-nMesh0    = swpref.getpref('nmesh',[]);
-nPatch0   = swpref.getpref('npatch',[]);
+pref = swpref;
+nMesh0    = pref.nmesh;
+nPatch0   = pref.npatch;
 
 inpForm.fname  = {'range' 'legend' 'label' 'unit' 'mode' 'atom1' 'atom2' 'copy'};
 inpForm.defval = {[]      true     true    'lu'   'poly' 1       2       false };

diff --git a/swfiles/+swplot/plotion.m b/swfiles/+swplot/plotion.m
@@ -128,8 +128,9 @@
 
 % default values
 %fontSize0 = swpref.getpref('fontsize',[]);
-nMesh0    = swpref.getpref('nmesh',[]);
-nPatch0   = swpref.getpref('npatch',[]);
+pref = swpref;
+nMesh0    = pref.nmesh;
+nPatch0   = pref.npatch;
 
 inpForm.fname  = {'range' 'legend' 'label' 'scale' 'linewidth' 'alpha'};
 inpForm.defval = {[]      true     true    1/3     0.5         0.3    };

diff --git a/swfiles/+swplot/plotmag.m b/swfiles/+swplot/plotmag.m
@@ -143,9 +143,10 @@
 
 
 % default values
-fontSize0 = swpref.getpref('fontsize',[]);
-nMesh0    = swpref.getpref('nmesh',[]);
-nPatch0   = swpref.getpref('npatch',[]);
+pref = swpref;
+fontSize0 = pref.fontsize;
+nMesh0    = pref.nmesh;
+nPatch0   = pref.npatch;
 
 inpForm.fname  = {'range' 'legend' 'label' 'dtext' 'fontsize' 'radius0' };
 inpForm.defval = {[]      true     true    0.1     fontSize0  0.06      };

diff --git a/swfiles/+swplot/text.m b/swfiles/+swplot/text.m
@@ -44,6 +44,7 @@
 end
 
 fontSize = [];
+pref = swpref;
 
 if numel(varargin{1}) == 1
     % first input figure handle
@@ -73,7 +74,7 @@
 end
 
 if isempty(fontSize)
-    fontSize = swpref.getpref('fontsize',[]);
+    fontSize = pref.fontsize;
 end
 
 hText = gobjects(1,nText);

diff --git a/swfiles/+swplot/tooltip.m b/swfiles/+swplot/tooltip.m
@@ -59,8 +59,8 @@
 if nargin == 0
     text0 = 'on';
 end
-
-fontSize = swpref.getpref('fontsize',[]);
+pref = swpref;
+fontSize = pref.fontsize;
 
 if nargin < 2 || isempty(hFigure)
     % find active figure

diff --git a/swfiles/+swpref/getpref.m b/swfiles/+swpref/getpref.m