Customized buffer to facilitate of a regular physical file for each processor within an MPI communicator. More...

#include <infoout.h>

Inheritance diagram for InfoOut_simpleFileBuffer:

Collaboration diagram for InfoOut_simpleFileBuffer:

Public Member Functions
	InfoOut_simpleFileBuffer ()
	Generic constructor is used when no information is provided during declaration. More...

	InfoOut_simpleFileBuffer (const MString &filename, const MString &projectName, MPI_Comm mpiComm=MPI_COMM_WORLD, MBool rootOnlyHardwired=false)
	This constructor yields a new instance that can immediately be used to write messages to a regular file. More...

	~InfoOut_simpleFileBuffer ()
	Destructor calls close() to close the file. More...

void	open (const MString &filename, const MString &projectName, MPI_Comm mpiComm=MPI_COMM_WORLD, MBool rootOnlyHardwired=false)
	Initialization of the file I/O environment. More...

void	close (MBool forceClose=false)
	Closes the file. More...

Public Member Functions inherited from InfoOut_buffer
	InfoOut_buffer ()
	Generic constructor is used when no information is provided during declaration. More...

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

virtual MInt	setMinFlushSize (MInt minFlushSize)
	Sets the minimum buffer length that has to be reached before the buffer is flushed. More...

Protected Member Functions
virtual MInt	sync ()
	Flushes the buffer by writing the contents to the file. More...

virtual void	flushBuffer ()
	Flushes the buffer by writing the contents to the file. More...

Protected Member Functions inherited from InfoOut_buffer
virtual MString	encodeXml (const std::string &str)
	Parses the string input and returns the string with XML entities escaped. More...

virtual MString	getXmlHeader ()
	Return an XML header that should written at the beginning of each log file. More...

virtual MString	getXmlFooter ()
	Return an XML footer that should written at the end of each log file. More...

virtual void	createPrefixMessage ()
	Creates an XML prefix using the domain id that is prepended to each message. More...

virtual void	createSuffixMessage ()
	Creates an XML suffix that is appended to each message. More...

virtual void	flushBuffer ()=0

Private Attributes
MBool	m_isOpen
	Stores whether the file(s) were already opened. More...

MBool	m_rootOnlyHardwired
	If true, only domain 0 opens and uses a file. More...

MString	m_filename
	Filename on disk. More...

std::ofstream	m_file
	File stream tied to physical file on disk. More...

MPI_Comm	m_mpiComm
	MPI communicator group. More...

Additional Inherited Members
Protected Attributes inherited from InfoOut_buffer
MBool	m_rootOnly
	Stores whether only the root domain writes a log file. More...

MInt	m_domainId
	Contains the MPI rank (= domain id) of this process. More...

MInt	m_noDomains
	Contains the MPI rank count (= number of domains) More...

MInt	m_minFlushSize
	Minimum length of the internal buffer before flushing. More...

MString	m_prefixMessage
	Stores the prefix that is prepended to each output. More...

MString	m_suffixMessage
	Stores the suffix that is apended to each output. More...

std::ostringstream	m_tmpBuffer
	Temporary buffer to hold string until flushing. More...

MString	m_projectName
	Name of the current Project. More...

std::vector< std::pair< MString, MString > >	m_prefixAttributes

Static Protected Attributes inherited from InfoOut_buffer
static const MInt	m_fileFormatVersion = 1

Detailed Description

Author: Michael Schlottke

Date: June 2012

This class can be used as a regular string buffer, as it inherits from stringbuf. On flushing the buffer, the contents of the buffer are written to a file using an ofstream. This is mainly for cases where logging speed is crucial, as the implementation is very lightweight and since for each process an individual file is maintained. There is an option to use this buffer but to create only one file for the MPI root domain (see m_rootOnlyHardwired).

Definition at line 152 of file infoout.h.

Constructor & Destructor Documentation

◆ InfoOut_simpleFileBuffer() [1/2]

InfoOut_simpleFileBuffer::InfoOut_simpleFileBuffer ( )

Author: Michael Schlottke

Date: June 2012

Definition at line 331 of file infoout.cpp.

  : m_isOpen(false), m_rootOnlyHardwired(false), m_filename(), m_file(), m_mpiComm() {
  // Nothing here
}

◆ InfoOut_simpleFileBuffer() [2/2]

InfoOut_simpleFileBuffer::InfoOut_simpleFileBuffer	(	const MString &	filename,
		const MString &	projectName,
		MPI_Comm	mpiComm = `MPI_COMM_WORLD`,
		MBool	rootOnlyHardwired = `false`
	)

Author: Michael Schlottke

Date: June 2012

Internally, this constructor just passes the parameters to open() (see open() for more details).

Parameters

[in]	filename	Filename that should be used for the file.
[in]	mpiComm	MPI communicator which is used to determine rank/domain information.
[in]	rootOnlyHardwired	If true, only rank 0 creates a file and writes to it. On all other processors, no file is opened and at each flushing of the buffer, the buffer content is discarded.
[in]	projectName	Projectname that should be used for the executed program.

Definition at line 348 of file infoout.cpp.

  : m_isOpen(false), m_rootOnlyHardwired(false), m_filename(), m_file(), m_mpiComm() {
  open(filename, projectName, mpiComm, rootOnlyHardwired);
}

◆ ~InfoOut_simpleFileBuffer()

InfoOut_simpleFileBuffer::~InfoOut_simpleFileBuffer ( )

Author: Michael Schlottke

Date: June 2012

Definition at line 359 of file infoout.cpp.

359{ close(); }

InfoOut_simpleFileBuffer::close

void close(MBool forceClose=false)

Closes the file.

Definition: infoout.cpp:424

Member Function Documentation

◆ close()

void InfoOut_simpleFileBuffer::close ( MBool forceClose = false )

Author: Michael Schlottke

Date: June 2012

Any subsequent write statements to the file stream are discarded after this method is called. After close() is called, an XML footer is written to the file. Then the file is closed.

Definition at line 424 of file infoout.cpp.

                                                     {
  // forceClose is not needed here (only kept for interface consistency reasons)
  static_cast<void>(forceClose);
 
  // Only close file if was opened before
  if(m_isOpen) {
    // Force flushing of the internal buffer
    flushBuffer();
 
    // Write XML footer to file and flush stream
    m_file << getXmlFooter() << flush;
 
    // Close file stream
    m_file.close();
 
    // Set state variable
    m_isOpen = false;
  }
}

◆ flushBuffer()

void InfoOut_simpleFileBuffer::flushBuffer ( )

inlineprotectedvirtual

Author: Michael Schlottke

Date: June 2012

Sync is called automatically when an "endl" is sent to the stream. At first the buffer content is wrapped in the prefix and suffix messages, then the entire string is written to the file. Finally, the internal buffers are reset.

Returns: Zero by default.

Implements InfoOut_buffer.

Definition at line 487 of file infoout.cpp.

                                                  {
  // Only write if the file was already opened
  if(m_isOpen) {
    // Write the string to the file and flush the stream
    m_file << m_tmpBuffer.str() << flush;
 
    // Reset temporary buffer
    m_tmpBuffer.str("");
  }
}

◆ open()

void InfoOut_simpleFileBuffer::open	(	const MString &	filename,
		const MString &	projectName,
		MPI_Comm	mpiComm = `MPI_COMM_WORLD`,
		MBool	rootOnlyHardwired = `false`
	)

Author: Michael Schlottke

Date: June 2012

After a successful call to this method the file stream is ready to use. Any previous information written to the buffer is lost when open is called. This function creates a new file as specified in filename (deleting any existing files with the same name), and creates the XML prefixes and suffixes used for each message. It also writes the necessary XML header information to the file.

Parameters

[in]	filename	Filename that should be used for the file.
[in]	mpiComm	MPI communicator which is used to determine rank/domain information.
[in]	rootOnlyHardwired	If true, only rank 0 creates a file and writes to it. On all other processors, no file is opened and at each flushing of the buffer, the buffer content is discarded.
[in]	projectName	Projectname that should be used for the executed program.

Definition at line 376 of file infoout.cpp.

                                                             {
  // Open file only if it was not yet done
  if(!m_isOpen) {
    // Set MPI communicator group
    m_mpiComm = mpiComm;
 
    // Get domain id and number of domains
    MPI_Comm_rank(m_mpiComm, &m_domainId);
    MPI_Comm_size(m_mpiComm, &m_noDomains);
 
    // Set whether only domain 0 should do any writing (including the creation of a file)
    m_rootOnlyHardwired = rootOnlyHardwired;
 
    // Only open the file if m_rootOnlyHardwired was not set as true. Otherwise the file state remains closed.
    if(!(m_rootOnlyHardwired && m_domainId != 0)) {
      // Set filename
      m_filename = filename;
 
      // Set projectName
      m_projectName = projectName;
 
      // Open file
      m_file.open(m_filename.c_str());
 
      // Clear internal buffer in order to dismiss any previous input
      str("");
 
      // Create prefix and suffix messages
      createPrefixMessage();
      createSuffixMessage();
 
      // Write root and meta information to file
      m_file << getXmlHeader() << flush;
 
      // Set state variable
      m_isOpen = true;
    }
  }
}

◆ sync()

MInt InfoOut_simpleFileBuffer::sync ( )

protectedvirtual

Author: Michael Schlottke

Date: June 2012

Sync is called automatically when an "endl" is sent to the stream. At first the buffer content is wrapped in the prefix and suffix messages, then the entire string is written to the file by calling flushBuffer(). Finally, the internal buffers are reset.

Returns: Zero by default.

Definition at line 454 of file infoout.cpp.

                                    {
  // Only write if the file was already opened
  if(m_isOpen) {
    // Create formatted string, escape any XML entities in the message, and save to temporary buffer
    m_tmpBuffer << m_prefixMessage << encodeXml(str()) << m_suffixMessage;
 
    // Only write to file if current buffer length exceeds the minimum size for flushing
    if(m_tmpBuffer.str().length() >= (unsigned)m_minFlushSize) {
      // Write the string to the file and flush the stream
      m_file << m_tmpBuffer.str() << flush;
 
      // Reset temporary buffer
      m_tmpBuffer.str("");
    }
  }
 
  // Reset internal buffer
  str("");
 
  // Default return value for sync()
  return 0;
}

Member Data Documentation

◆ m_file

std::ofstream InfoOut_simpleFileBuffer::m_file

private

Definition at line 157 of file infoout.h.

◆ m_filename

MString InfoOut_simpleFileBuffer::m_filename

private

Definition at line 156 of file infoout.h.

◆ m_isOpen

MBool InfoOut_simpleFileBuffer::m_isOpen

private

Definition at line 154 of file infoout.h.

◆ m_mpiComm

MPI_Comm InfoOut_simpleFileBuffer::m_mpiComm

private

Definition at line 158 of file infoout.h.

◆ m_rootOnlyHardwired

MBool InfoOut_simpleFileBuffer::m_rootOnlyHardwired

private

Definition at line 155 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

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ InfoOut_simpleFileBuffer() [1/2]

◆ InfoOut_simpleFileBuffer() [2/2]

◆ ~InfoOut_simpleFileBuffer()

Member Function Documentation

◆ close()

◆ flushBuffer()

◆ open()

◆ sync()

Member Data Documentation

◆ m_file

◆ m_filename

◆ m_isOpen

◆ m_mpiComm

◆ m_rootOnlyHardwired