octave_packages/general-1.3.1/@inputParser/createCopy.m

   1 ## Copyright (C) 2011 Carnë Draug <carandraug+dev@gmail.com>
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{new_parser} =} createCopy (@var{parser})
  18 ## Creates a copy @var{new_parser} of the object @var{parser} of the inputParser
  19 ## class.
  20 ##
  21 ## @seealso{inputParser, @@inputParser/addOptional, @@inputParser/addParamValue
  22 ## @@inputParser/addParamValue, @@inputParser/addRequired, @@inputParser/addSwitch,
  23 ## @@inputParser/parse}
  24 ## @end deftypefn
  25
  26 function outPar = createCopy (inPar)
  27
  28   if ( nargin != 1 )
  29     print_usage;
  30   elseif ( !isa (inPar, 'inputParser') )
  31     error ("object must be of the inputParser class but '%s' was used", class (inPar) );
  32   endif
  33
  34   ## yes, it's a ridiculous function but exists for MatLab compatibility. In there
  35   ## the inputParser class is a 'handle class' and this would just return a reference
  36   outPar = inPar;
  37
  38 endfunction