NewFile.h

Go to the documentation of this file.

// # NewFile: Do checks for a new (non-existent) file
// # Copyright (C) 1996,1999,2002,2004
// # Associated Universities, Inc. Washington DC, USA.
// #
// # This library is free software; you can redistribute it and/or modify it
// # under the terms of the GNU Library General Public License as published by
// # the Free Software Foundation; either version 2 of the License, or (at your
// # option) any later version.
// #
// # This library 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 Library General Public
// # License for more details.
// #
// # You should have received a copy of the GNU Library General Public License
// # along with this library; if not, write to the Free Software Foundation,
// # Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
// #
// # Correspondence concerning AIPS++ should be addressed as follows:
// #        Internet email: casa-feedback@nrao.edu.
// #        Postal address: AIPS++ Project Office
// #                        National Radio Astronomy Observatory
// #                        520 Edgemont Road
// #                        Charlottesville, VA 22903-2475 USA
 
#ifndef TABLES_NEWFILE_H
#define TABLES_NEWFILE_H
 
#include <casacore/casa/aips.h>
#include <casacore/casa/BasicSL/String.h>
 
namespace casacore {  // # NAMESPACE CASACORE - BEGIN
 
// <summary>
// Do checks for a new (non-existent) file.
// </summary>
 
// <use visibility=export>
 
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
//
// <etymology>
// Use this if you want a New File.
// </etymology>
//
// <synopsis>
// NewFile is a class checking if a new file already exists.
// If the file exists, then the user is asked via Choice::choice whether or not
// he or she wants to delete the file before using it.
// </synopsis>
//
// <example>
// NewFile validFile;
// String newFileName("bigone"), error;
// Bool ok = validFile.valueOK(newFileName, error);
// if (!ok) {
//    cout << error << endl;
// }
// </example>
//
// <motivation>
// Output file names are fairly common parameters, this consolidates the error
// checking and "remove if it already exists" logic.
// </motivation>
//
// <todo asof="1996/12/10">
//   <li> We should probably make sure that the file is writable
// </todo>
 
class NewFile {
 public:
  // Currently the deleteIfExists argument has no affect
  NewFile(Bool deleteIfExists = True);
 
  // Copy constructor (copy semantics)
  NewFile(const NewFile &other);
 
  // Assignment (copy semantics)
  NewFile &operator=(const NewFile &other);
 
  // Destructor
  ~NewFile();
 
  // Indicates whether the specified string is a valid new file,
  // invoking the choice GUI.  If it returns False, an error
  // message is returned.
  Bool valueOK(const String &value, String &error) const;
 
 private:
  Bool delete_p;
};
 
}  // namespace casacore
 
#endif