/usr/include/openturns/WrapperFile.hxx is in libopenturns-dev 0.15-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 | // -*- C++ -*-
/**
* @file WrapperFile.hxx
* @brief This class provides all the treatments for wrapper file manipulation
*
* (C) Copyright 2005-2011 EDF-EADS-Phimeca
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-06-10 15:15:12 +0200 (Fri, 10 Jun 2011) $
* Id: $Id: WrapperFile.hxx 1935 2011-06-10 13:15:12Z schueller $
*/
#ifndef OPENTURNS_WRAPPERFILE_HXX
#define OPENTURNS_WRAPPERFILE_HXX
#include <iostream> // for std::ostream
#include "OTprivate.hxx"
#include "PersistentObject.hxx"
#include "WrapperData.hxx"
#include "Exception.hxx"
namespace OpenTURNS
{
/**
* @class WrapperFile
* @brief Provides all the treatments for wrapper file manipulation
* @ingroup Wrapper
*
* All the methods needed for wrapper description file reading or writing
* are located in this class. The class handles various file formats (plain text,
* XML, etc.).
*/
class WrapperFile
: public Base::Common::PersistentObject
{
CLASSNAME;
public:
typedef int Version;
typedef Base::Common::NoWrapperFileFoundException NoWrapperFileFoundException;
typedef Base::Common::WrapperFileParsingException WrapperFileParsingException;
/** @brief Find the path of a wrapper file from its name.
* @param name The name of the wrapper expurged of its extension
* @return The absolute path of the corresponding wrapper description file
* @throw NoWrapperFileFoundException
* The method uses Path class to implements its search algorithm.
* @see Path
*/
static FileName FindWrapperPathByName(const String & name)
/* throw(NoWrapperFileFoundException) */;
/** @brief Build a wrapper from a name
* @param name The name of the wrapper expurged of its extension
* @return A structure describing the content of the wrapper description file
* @throw NoWrapperFileFoundException
*/
static WrapperFile FindWrapperByName(const String & name)
/* throw(NoWrapperFileFoundException) */;
/** @brief Build a wrapper from a stream
* @param xmlStream A stream (in XML format) that is the content of a wrapper description file
* @return A structure describing the content of the wrapper description file
* @see toString()
*/
static WrapperFile BuildWrapperFromStream(const String & xmlStream);
protected:
/** The file name extension */
static const String extension_;
public:
/** Default constructor */
WrapperFile();
/** Constructor from file */
explicit WrapperFile(const FileName & pathToFile)
/* throw(WrapperFileParsingException) */;
/* Virtual constructor */
virtual WrapperFile * clone() const;
/* String converter */
virtual String __repr__() const;
virtual String __str__(const String & offset = "") const;
/** Description file path accessor
* @param path The path of the wrapper description file
*/
void setDescriptionFilePath(const FileName & path);
/** Description file path accessor
* @return The path of the wrapper description file
*/
FileName getDescriptionFilePath() const;
/** Wrapper data accessor
* @param data A structure describing the content of the wrapper description file
*/
void setWrapperData(const WrapperData & data);
/** Wrapper data accessor
* @return A structure describing the content of the wrapper description file
*/
const WrapperData & getWrapperData() const;
/** Write the internal data to a wrapper file
* @param pathToFile The path where the wrapper description file must be written
*/
void writeFile(const FileName & pathToFile);
/** Stream out the internal data
* @return A string that can be later used by BuildWrapperFromStream()
*/
String toString() const;
/** Accessor to version number */
Version getVersion() const;
void setVersion(Version v);
protected:
/** Where the description file of the wrapper is located */
FileName descriptionFilePath_;
/** The data that the wrapper may exchange with the platform */
WrapperData data_;
/** The version of DTD used to write the description file */
Version version_;
private:
/** Initialization */
void init() const
/* throw(WrapperFileParsingException) */;
/** Finalization */
void done() const;
/** File parsing function */
void parseFile(const FileName & pathToFile)
/* throw(WrapperFileParsingException) */;
/** Stream parsing function */
void parseStream(const String & stream);
} ; /* class WrapperFile */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_WRAPPERFILE_HXX */
|