OpenWalnut
1.3.1
Main Page
Related Pages
Modules
Namespaces
Classes
Files
File List
src
core
dataHandler
io
WReader.h
1
//---------------------------------------------------------------------------
2
//
3
// Project: OpenWalnut ( http://www.openwalnut.org )
4
//
5
// Copyright 2009 OpenWalnut Community, BSV@Uni-Leipzig and CNCF@MPI-CBS
6
// For more information see http://www.openwalnut.org/copying
7
//
8
// This file is part of OpenWalnut.
9
//
10
// OpenWalnut is free software: you can redistribute it and/or modify
11
// it under the terms of the GNU Lesser General Public License as published by
12
// the Free Software Foundation, either version 3 of the License, or
13
// (at your option) any later version.
14
//
15
// OpenWalnut is distributed in the hope that it will be useful,
16
// but WITHOUT ANY WARRANTY; without even the implied warranty of
17
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
// GNU Lesser General Public License for more details.
19
//
20
// You should have received a copy of the GNU Lesser General Public License
21
// along with OpenWalnut. If not, see <http://www.gnu.org/licenses/>.
22
//
23
//---------------------------------------------------------------------------
24
25
#ifndef WREADER_H
26
#define WREADER_H
27
28
#include <string>
29
30
#include "../exceptions/WDHNoSuchFile.h"
31
#include "../../common/WDefines.h"
32
33
/**
34
* Read some data from a given file. This base class is just for file
35
* management (file exists, etc.) Subclasses may use those mechanisms and
36
* specify their file format which is not the purpose of this base class.
37
* \ingroup dataHandler
38
*/
39
class
WReader
40
{
41
public
:
42
/**
43
* Creates a read object for file reading.
44
*
45
* \param fname path to file which should be loaded
46
* \throws WDHNoSuchFile
47
*/
48
explicit
WReader
( std::string fname )
throw
(
WDHNoSuchFile
);
49
50
/**
51
* Reset the file name and checks if it exists.
52
*
53
* \param fname file name
54
* \throws WDHNoSuchFile
55
* \deprecated use setFilename instead.
56
*/
57
OW_API_DEPRECATED
void
setFileName
( std::string fname )
throw
(
WDHNoSuchFile
);
58
59
/**
60
* Reset the file name and checks if it exists.
61
*
62
* \param fname file name
63
* \throws WDHNoSuchFile
64
*/
65
void
setFilename
( std::string fname )
throw
(
WDHNoSuchFile
);
66
67
protected
:
68
std::string
m_fname
;
//!< Absolute path of the file to read from
69
70
private
:
71
};
72
73
#endif // WREADER_H
Generated by
1.8.4