Home > src > validFileNameOrNull.m

validFileNameOrNull

PURPOSE ^

- helper function to validate that a string represents a valid file name or null

SYNOPSIS ^

function flag = validFileNameOrNull(fileName)

DESCRIPTION ^

 - helper function to validate that a string represents a valid file name or null

 copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut

    This file is part of SOS

    SOS is free software: you can redistribute it and/or modify
    it for academic and non-commercial purposes
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.  For commercial or for-profit
    uses, please contact the authors (sos@cnbc.cmu.edu).

    SOS is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:

SOURCE CODE ^

0001 % - helper function to validate that a string represents a valid file name or null
0002 %
0003 % copyright 2009-2012 Blair Armstrong, Christine Watson, David Plaut
0004 %
0005 %    This file is part of SOS
0006 %
0007 %    SOS is free software: you can redistribute it and/or modify
0008 %    it for academic and non-commercial purposes
0009 %    under the terms of the GNU General Public License as published by
0010 %    the Free Software Foundation, either version 3 of the License, or
0011 %    (at your option) any later version.  For commercial or for-profit
0012 %    uses, please contact the authors (sos@cnbc.cmu.edu).
0013 %
0014 %    SOS is distributed in the hope that it will be useful,
0015 %    but WITHOUT ANY WARRANTY; without even the implied warranty of
0016 %    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0017 %    GNU General Public License for more details.
0018 
0019 %    You should have received a copy of the GNU General Public License
0020 %    along with SOS (see COPYING.txt).
0021 %    If not, see <http://www.gnu.org/licenses/>.
0022 
0023 function flag = validFileNameOrNull(fileName)
0024 %   Checks whether <fileName> is a string reference to an existing file.
0025 %   Returns 1 if TRUE, displays problem and generates ERRROR if FALSE
0026 %
0027 %   Example:
0028 %       validFileName('population1.txt'); % returns 1 if exists, specific
0029 %                                         % cause of error otherwise
0030 
0031     if(exist(fileName,'var') == false)
0032         flag = 1;
0033     else
0034         flag = validFileName(fileName);
0035     end
0036   
0037     
0038 end %validFileNameOrNull

Generated on Fri 27-Jan-2012 16:18:41 by m2html © 2005