A Discrete-Event Network Simulator
API
output-stream-wrapper.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2010 University of Washington
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18 
19 #include "output-stream-wrapper.h"
20 #include "ns3/log.h"
21 #include "ns3/fatal-impl.h"
22 #include "ns3/abort.h"
23 #include <fstream>
24 
25 namespace ns3 {
26 
27 NS_LOG_COMPONENT_DEFINE ("OutputStreamWrapper");
28 
29 OutputStreamWrapper::OutputStreamWrapper (std::string filename, std::ios::openmode filemode)
30  : m_destroyable (true)
31 {
32  NS_LOG_FUNCTION (this << filename << filemode);
33  std::ofstream* os = new std::ofstream ();
34  os->open (filename.c_str (), filemode);
35  m_ostream = os;
36  FatalImpl::RegisterStream (m_ostream);
37  NS_ABORT_MSG_UNLESS (os->is_open (), "AsciiTraceHelper::CreateFileStream(): " <<
38  "Unable to Open " << filename << " for mode " << filemode);
39 }
40 
41 OutputStreamWrapper::OutputStreamWrapper (std::ostream* os)
42  : m_ostream (os), m_destroyable (false)
43 {
44  NS_LOG_FUNCTION (this << os);
45  FatalImpl::RegisterStream (m_ostream);
46  NS_ABORT_MSG_UNLESS (m_ostream->good (), "Output stream is not valid for writing.");
47 }
48 
49 OutputStreamWrapper::~OutputStreamWrapper ()
50 {
51  NS_LOG_FUNCTION (this);
52  FatalImpl::UnregisterStream (m_ostream);
53  if (m_destroyable) delete m_ostream;
54  m_ostream = 0;
55 }
56 
57 std::ostream *
58 OutputStreamWrapper::GetStream (void)
59 {
60  NS_LOG_FUNCTION (this);
61  return m_ostream;
62 }
63 
64 } // namespace ns3
ns3::OutputStreamWrapper::GetStream
std::ostream * GetStream(void)
Return a pointer to an ostream previously set in the wrapper.
Definition: output-stream-wrapper.cc:58
ns3::OutputStreamWrapper::OutputStreamWrapper
OutputStreamWrapper(std::string filename, std::ios::openmode filemode)
Constructor.
Definition: output-stream-wrapper.cc:29
ns3::OutputStreamWrapper::m_destroyable
bool m_destroyable
Can be destroyed.
Definition: output-stream-wrapper.h:97
ns3::OutputStreamWrapper::m_ostream
std::ostream * m_ostream
The output stream.
Definition: output-stream-wrapper.h:96
NS_ABORT_MSG_UNLESS
#define NS_ABORT_MSG_UNLESS(cond, msg)
Abnormal program termination if a condition is false, with a message.
Definition: abort.h:144
ns3::FatalImpl::UnregisterStream
void UnregisterStream(std::ostream *stream)
Unregister a stream for flushing on abnormal exit.
Definition: fatal-impl.cc:107
ns3::FatalImpl::RegisterStream
void RegisterStream(std::ostream *stream)
Register a stream to be flushed on abnormal exit.
Definition: fatal-impl.cc:100
NS_LOG_COMPONENT_DEFINE
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
NS_LOG_FUNCTION
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
Definition: log-macros-enabled.h:244
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.