Class to create an output stream that writes to cout or cerr but prepends each line with the MPI rank. More...

#include <infoout.h>

Inheritance diagram for InfoOutStream:

Collaboration diagram for InfoOutStream:

Public Member Functions
	InfoOutStream ()
	Default construtor creates InfoOutStream that is not (yet) usable. More...

	InfoOutStream (std::ostream *os, MPI_Comm mpiComm=MPI_COMM_WORLD, MBool printDomainId=true)
	Constructor creates InfoOut_streamBuffer buffer and calls ostream constructor with reference to it. More...

	~InfoOutStream ()
	Destructor deletes the internal buffer object. More...

void	initialize (std::ostream *os, MPI_Comm mpiComm=MPI_COMM_WORLD, MBool printDomainId=true)
	Passes the parameters to a call of InfoOut_streamBuffer::initialize(). More...

MBool	setRootOnly (MBool rootOnly=true)
	Sets interal state of whether only the root domain (rank 0) should write to file. Author Michael Schlottke. More...

Public Member Functions inherited from InfoOut
	InfoOut ()

virtual MBool	setRootOnly (MBool rootOnly=true)=0

MInt	addAttribute (std::pair< MString, MString >)
	Adds an attribute to the prefix of the XML string. More...

void	eraseAttribute (MInt)
	Erases an attribute from the prefix of the XML string. More...

void	modifyAttribute (MInt, std::pair< MString, MString >)
	Modifies an attribute of the prefix of the XML string. More...

Private Attributes
MBool	m_isInitialized
	Stores whether a stream was already opened or not. More...

Additional Inherited Members
Protected Attributes inherited from InfoOut
InfoOut_buffer *	m_buffer = nullptr

Detailed Description

Author: Michael Schlottke

Date: June 2012

This class can be used to write to an already existing output stream. The usage and behavior is just like with existing C++ output streams such as cout/cerr, except that it offers the possibility to prepend each line with information about the current MPI domain id. In future implementations it might be worth considering to add even more information to each message.

Definition at line 243 of file infoout.h.

Constructor & Destructor Documentation

◆ InfoOutStream() [1/2]

InfoOutStream::InfoOutStream ( )

Author: Michael Schlottke

Date: April 2012

When this constructor is used, initialize() needs to be called before the stream can be used.

Definition at line 1070 of file infoout.cpp.

                             : m_isInitialized(false) {
  // Nothing here
}

◆ InfoOutStream() [2/2]

InfoOutStream::InfoOutStream	(	std::ostream *	os,
		MPI_Comm	mpiComm = `MPI_COMM_WORLD`,
		MBool	printDomainId = `true`
	)

Author: Michael Schlottke

Date: April 2012

When this constructor is used, the stream is immediately ready to use. For information about the paramters, please have a look at InfoOut_streamBuffer::initialize.

Parameters

[in]	os	Output stream that should be used for output.
[in]	mpiComm	MPI communicator for which the domain information should be gathered.
[in]	printDomainId	Determines whether the domain id should be prepended to each message.

Definition at line 1085 of file infoout.cpp.

                                                                               : m_isInitialized(false) {
  initialize(os, mpiComm, printDomainId);
}

◆ ~InfoOutStream()

InfoOutStream::~InfoOutStream ( )

Author: Michael Schlottke

Date: June 2012

Definition at line 1095 of file infoout.cpp.

                              {
  if(m_isInitialized) {
    delete m_buffer;
    m_isInitialized = false;
  }
}

Member Function Documentation

◆ initialize()

void InfoOutStream::initialize	(	std::ostream *	os,
		MPI_Comm	mpiComm = `MPI_COMM_WORLD`,
		MBool	printDomainId = `true`
	)

Author: Michael Schlottke

Date: April 2012

Parameters

[in]	os	Output stream that should be used for output.
[in]	mpiComm	MPI communicator for which the domain information should be gathered.
[in]	printDomainId	Determines whether the domain id should be prepended to each message.

Definition at line 1112 of file infoout.cpp.

                                                                                 {
  if(!m_isInitialized) {
    m_buffer = new InfoOut_streamBuffer(os, mpiComm, printDomainId);
 
    // Associate the stream with the newly created buffer
    rdbuf(m_buffer);
 
    // Set state variable
    m_isInitialized = true;
  }
}

◆ setRootOnly()

MBool InfoOutStream::setRootOnly ( MBool rootOnly = true )

virtual

Date: June 2012

\params[in] rootOnly If true, only rank 0 of the specified MPI communicator writes to file.

Returns: The previous internal state (may be stored to return to the previous behavior).

Implements InfoOut.

Definition at line 1132 of file infoout.cpp.

1132{ return m_buffer->setRootOnly(rootOnly); }

InfoOut_buffer::setRootOnly

virtual MBool setRootOnly(MBool rootOnly=true)

Sets interal state of whether only the root domain (rank 0) should write to file.

Definition: infoout.cpp:173

Member Data Documentation

◆ m_isInitialized

MBool InfoOutStream::m_isInitialized

private

Definition at line 245 of file infoout.h.

The documentation for this class was generated from the following files:

/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/IO/infoout.h
/home/gitlab-runner/scratch/builds/oxpnswJ6/1/aia/m-AIA/m-AIA/src/IO/infoout.cpp

Public Member Functions

Private Attributes

Additional Inherited Members