createRigPrefs.m

function outStruct = createRigPrefs(additionalSettings)
%CreateRigPrefspdsBeginExperimentcreate preferences stored as matlab preferences
% outStruct=createRigPrefs(additionalSettings) allows to create and change
% existing rig parameters stored iin the matlab preference 'pldaps'.
% These setting override the default parameters of the pldaps class.
% The optional additionalSettings will be loeaded into a a higher hierarchy
% level from where it can be copied over in the parameters viwer.
% outStruct is the final struct of settings that were also stored in the
% matlab preference system.

    fprintf('\n****************************************************************\n')

    %to we already have current settings?
    a = getpref('pldaps');
    if ~isempty(a)
        fprintf('Existing pldaps rigPrefs detected.\n\tIf changes are made, a backup of previous settings will be saved.\n');
    end
    
    % Initialize a PLDAPS object containing class & rig defaults
    p = pldaps('test','nothing');
    
    if nargin>0
        p.defaultParameters.addLevels({additionalSettings}, {'additional Settings'});
        fprintf('User input settings struct %s appended.\n', inputname(1));
    end
    
    p.defaultParameters;
    H = p.defaultParameters.view;
    
    % Print instructions to command window
    fprintf([...
        '\n****************************************************************\n'...
        'INSTRUCTIONS for setting local rig preferences\n'...
        '****************************************************************\n'...
        'There are two ways to change rigPref values using this function:'...
        '\n\nOption 1: Move the value you want as rig default to \n'...
        'pldapsRigPrefs from another set of preferences (e.g. \n'...
        'SessionParameters, PLDAPS3).  Double click on the value and \n'...
        'select move to pldapsRigPrefs from the drop down menu.'...
        '\n\nOption 2: Define the values yourself by clicking on the value\n'...
        'field of pldapsRigPrefs for the parameter you want to change. Type\n'...
        'the new value in the box below (you will have to physically click\n'...
        'on this box with the mouse) and press enter.\n'...
        '\nYour rig preferences are saved within Matlab''s preferences\n'...
        'framework:\t\tgetpref(''pldaps'')\n'...
        'Touching them directly is frowned upon though, and only\n'...
        'interactions through createRigPrefs.m are supported.\n'...
        ]);
    fprintf(2,[...
        '\nVERY IMPORTANT for both options: When you are done adding new \n' ...
        'parameters, type dbcont into the command line and press enter.\n\n'...
        '!If you forget to type dbcont, all your changes will be lost!\n'...
        ]);
    fprintf('****************************************************************\n'...
        );
    

    keyboard
    %make changes in the viewer and press done. move things you want in the
    %pldapsRifPrefs to there (doule click in the right value list on the value you want to move and select to move it to pldapsRigPrefs)
    %when done, click 'done'
    %you can skip this or in addition to this, change parameters by editing
    %p.defaultParameters, this is not a struct, but behaves similarly...
    %if you do not want to use the viewer but want to add parameters
    %manually, you should call 
    %p.defaultParameters.setLevels([1 2]);
    %now, to ensure that you are adding the values at the correct hierarchy
    %level
    
    
    % Save old prefs before removing them from matlab prefs storage
    if ~isempty(a)
        sfn = sprintf('pldaps_prefs_pre%s.mat', datestr(now, 'yyyy-mm-dd_HH-MM-SS'));
        try % to be cleaner
            sfn = fullfile( p.defaultParameters.pldaps.dirs.proot, 'rigPrefs', 'oldPrefs', sfn);
            if ~exist(fileparts(sfn),'dir'), mkdir(fileparts(sfn)); end
        catch
            sfn = fullfile( pwd, sfn);
        end
        fprintf('\nPrior PLDAPS prefs saved to:\n\t%s\n\n', sfn);
        save(sfn, 'a');

        rmpref('pldaps'); %remove current
    end
    
    % Package current prefs for saving
    p.defaultParameters.setLevels(2);
    outStruct=p.defaultParameters.mergeToSingleStruct();
    
    fn=fieldnames(outStruct);
    outStructc=struct2cell(outStruct);

    % Set new prefs
    setpref('pldaps',fn(:),outStructc);
    
    % Close the params structviewer
    close(H);
    
    fprintf('Done. Your new pldaps rig prefs have been saved.\n');
end