MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
FortranTypes_f_open_file.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef F_OPEN_FILE_H
43 #define F_OPEN_FILE_H
44 
45 #include "Moocho_ConfigDefs.hpp"
46 #include "Teuchos_F77_wrappers.h"
47 
48 namespace FortranTypes {
49 
53 
56  , OPEN_UNKNOWN = 3 };
60 enum EOpenBlank { OPEN_NULL = 0, OPEN_ZERO = 1 };
63 
83 void f_open_file( const f_int iunit, const char file[]
86  , f_int recl = -1 );
87 
107 void f_close_file( const f_int iunit, bool keep = true );
108 
110 
112 class InvalidFileNameException : public std::logic_error
113 {public: InvalidFileNameException(const std::string& what_arg) : std::logic_error(what_arg) {}};
114 
116 class OpenException : public std::logic_error
117 {public: OpenException(const std::string& what_arg) : std::logic_error(what_arg) {}};
118 
119 } // end namespace FortranTypes
120 
121 #endif // F_OPEN_FILE_H
void f_close_file(const f_int iunit, bool keep=true)
FortranTypes::f_int f_int
Thrown if the open operation fails.
OpenException(const std::string &what_arg)
void f_open_file(const f_int iunit, const char file[], EOpenStatus status=OPEN_UNKNOWN, EOpenForm form=OPEN_FORMATTED, EOpenBlank blank=OPEN_NULL, EOpenAccess access=OPEN_SEQUENTIAL, f_int recl=-1)
Thrown if the file name is not a valid ASCII string.
InvalidFileNameException(const std::string &what_arg)