-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
OutputDevice_File.h
78 lines (65 loc) · 2.56 KB
/
OutputDevice_File.h
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
/****************************************************************************/
// Eclipse SUMO, Simulation of Urban MObility; see https://eclipse.dev/sumo
// Copyright (C) 2004-2024 German Aerospace Center (DLR) and others.
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// https://www.eclipse.org/legal/epl-2.0/
// This Source Code may also be made available under the following Secondary
// Licenses when the conditions for such availability set forth in the Eclipse
// Public License 2.0 are satisfied: GNU General Public License, version 2
// or later which is available at
// https://www.gnu.org/licenses/old-licenses/gpl-2.0-standalone.html
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-or-later
/****************************************************************************/
/// @file OutputDevice_File.h
/// @author Daniel Krajzewicz
/// @author Michael Behrisch
/// @date 2004
///
// An output device that encapsulates an ofstream
/****************************************************************************/
#pragma once
#include <config.h>
#include <iostream>
#include "OutputDevice.h"
// ===========================================================================
// class definitions
// ===========================================================================
/**
* @class OutputDevice_File
* @brief An output device that encapsulates an ofstream
*
* Please note that the device gots responsible for the stream and deletes
* it (it should not be deleted elsewhere).
*/
class OutputDevice_File : public OutputDevice {
public:
/** @brief Constructor
* @param[in] fullName The name of the output file to use
* @param[in] compressed whether to apply gzip compression
* @exception IOError Should not be thrown by this implementation
*/
OutputDevice_File(const std::string& fullName, const bool compressed = false);
/// @brief Destructor
~OutputDevice_File();
/** @brief returns the information whether the device will discard all output
* @return Whether the device redirects to /dev/null
*/
bool isNull() {
return myAmNull;
}
bool removeSelf() override;
protected:
/// @name Methods that override/implement OutputDevice-methods
/// @{
/** @brief Returns the associated ostream
* @return The used stream
*/
std::ostream& getOStream();
/// @}
private:
/// The wrapped ofstream
std::ostream* myFileStream = nullptr;
/// am I redirecting to /dev/null
bool myAmNull = false;
};