#include <infoout.h>

Inheritance diagram for InfoOut_buffer:

Collaboration diagram for InfoOut_buffer:

Public Member Functions
	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 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

Protected Attributes
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
static const MInt	m_fileFormatVersion = 1

Friends
class	InfoOut

Detailed Description

Definition at line 40 of file infoout.h.

Constructor & Destructor Documentation

◆ InfoOut_buffer()

InfoOut_buffer::InfoOut_buffer ( )

Author: Michael Schlottke

Date: June 2012

Definition at line 72 of file infoout.cpp.

  : m_rootOnly(false),
    m_domainId(0),
    m_noDomains(1),
    m_minFlushSize(0),
    m_prefixMessage(),
    m_suffixMessage(),
    m_tmpBuffer(),
    m_projectName() {
  // Nothing here
}

Member Function Documentation

◆ createPrefixMessage()

void InfoOut_buffer::createPrefixMessage ( )

inlineprotectedvirtual

Author: Michael Schlottke, Andreas Lintermann

Date: 13.08.2012

Makes use of an array attribute filled by the user to gerenate the XML string.

Definition at line 138 of file infoout.cpp.

                                                {
  // Create temporary stream
  ostringstream tmpStream;
 
  // Fill stream with formatted domain id
  tmpStream << "<m d=\"" << m_domainId << "\" ";
 
  for(MInt i = 0; i < (MInt)(m_prefixAttributes.size()); i++)
    tmpStream << m_prefixAttributes[i].first << "=\"" << m_prefixAttributes[i].second << "\" ";
 
  tmpStream << ">";
 
  // Set prefix message to tmpBuffer string
  m_prefixMessage = tmpStream.str();
 
  // Reset buffer
  tmpStream.str("");
}

◆ createSuffixMessage()

void InfoOut_buffer::createSuffixMessage ( )

inlineprotectedvirtual

Author: Michael Schlottke

Date: April 2012

Definition at line 162 of file infoout.cpp.

162{ m_suffixMessage = "</m>\n"; }

◆ encodeXml()

MString InfoOut_buffer::encodeXml ( const std::string & str )

protectedvirtual

Author: Michael Schlottke

Date: April 2012

This method iterates over each character of the given input string str and replaces relevant XML entities with their escaped counterparts. This code is adapted from http://www.mdawson.net/misc/xmlescape.php (Matson Dawson, 2009).

Parameters

[in] str Input string that has characters which need escaping.

Returns: Modified string with XML entities escaped.

Definition at line 95 of file infoout.cpp.

                                                         {
  MChar c;                       // Contains the current character
  ostringstream tmpEncodeBuffer; // Used as a temporary string buffer
 
  // Create a for loop that uses an iterator to traverse the complete string
  for(MString::const_iterator iter = inputStr.begin(); iter < inputStr.end(); iter++) {
    // Get current character
    c = (MChar)*iter;
 
    // Use a switch/case statement for the five XML entities
    switch(c) {
      case '"':
        tmpEncodeBuffer << "&quot;";
        break; // Replace double quotes
      case '&':
        tmpEncodeBuffer << "&amp;";
        break; // Replace ampersand
      case '\'':
        tmpEncodeBuffer << "&apos;";
        break; // Replace single quote
      case '<':
        tmpEncodeBuffer << "&lt;";
        break; // Replace less-than sign
      case '>':
        tmpEncodeBuffer << "&gt;";
        break; // Replace greater-than sign
      default:
        tmpEncodeBuffer << c; // By default just append current character
    }
  }
 
  // Return encoded stream as a string
  return tmpEncodeBuffer.str();
}

◆ flushBuffer()

virtual void InfoOut_buffer::flushBuffer ( )

protectedpure virtual

Implemented in InfoOut_mpiFileBuffer, InfoOut_simpleFileBuffer, and InfoOut_streamBuffer.

◆ getXmlFooter()

MString InfoOut_buffer::getXmlFooter ( )

protectedvirtual

Author: Michael Schlottke

Date: June 2012

Returns: The XML footer.

Definition at line 299 of file infoout.cpp.

                                     {
  // Create timestamp
  MChar tmpDateTime[128];
  tm* timeInfo;
  time_t rawTime;
 
  // Get the current time and write it to rawTime
  time(&rawTime);
 
  // Convert to time struct
  timeInfo = localtime(&rawTime);
 
  // Format time to string and save to buffer
  strftime(tmpDateTime, 128, "%Y-%m-%d %H:%M:%S", timeInfo);
 
  // Create temporary buffer
  ostringstream tmpBuffer;
 
  // Write XML footer to buffer
  tmpBuffer << "<meta name=\"dateClosing\" content=\"" << tmpDateTime << "\" />\n";
  tmpBuffer << "</root>\n";
 
  // Return XML footer
  return tmpBuffer.str();
}

◆ getXmlHeader()

MString InfoOut_buffer::getXmlHeader ( )

protectedvirtual

Author: Michael Schlottke

Date: June 2012

Returns: The XML header.

Definition at line 199 of file infoout.cpp.

                                     {
  const MInt maxNoChars = 1024;
 
  // Gets the current hostname
  MChar host[maxNoChars];
  gethostname(host, maxNoChars - 1);
  host[maxNoChars - 1] = '\0';
 
  // Gets the current username
  MString user;
#if defined(MAIA_MS_COMPILER)
  constexpr MInt INFO_BUFFER_SIZE = 32767;
  TCHAR infoBuf[INFO_BUFFER_SIZE];
  DWORD bufCharCount = INFO_BUFFER_SIZE;
  if(!GetUserName(infoBuf, &bufCharCount)) {
    user = "n/a";
  } else {
    user = infoBuf;
  }
#else
  passwd* p;
  p = getpwuid(getuid());
  if(p) {
    user = MString(p->pw_name);
  } else {
    user = "n/a";
  }
#endif
 
  // Gets the current directory
  MChar dir[maxNoChars];
#if defined(MAIA_MS_COMPILER)
  _getcwd(dir, maxNoChars - 1);
#else
  if(!getcwd(dir, maxNoChars - 1)) {
    TERM(-1);
  }
#endif
  dir[maxNoChars - 1] = '\0';
 
  // Gets the current executionCommand
  stringstream executionCommand;
  executionCommand.str("");
  // m_argv and m_argc additionaly described in maia.cpp
#ifndef PVPLUGIN
  executionCommand << Environment::m_argv[0];
  for(MInt n = 1; n < Environment::m_argc; n++) {
    executionCommand << " " << Environment::m_argv[n];
  }
#else
  executionCommand << "paraview plugin was started --> no execution command";
#endif
 
 
  // Create start timestamp
  MChar tmpDateTime[128];
  tm* timeInfo;
  time_t rawTime;
 
  // Get the current time and write it to rawTime
  time(&rawTime);
 
  // Convert to time struct
  timeInfo = localtime(&rawTime);
 
  // Format time to string and save to buffer
  strftime(tmpDateTime, 128, "%Y-%m-%d %H:%M:%S", timeInfo);
 
  // Create temporary buffer
  ostringstream tmpBuffer;
 
  // Write XML header information to buffer
  tmpBuffer << "<?xml version=\"1.0\" standalone=\"yes\" ?>\n";
  tmpBuffer << "<root>\n";
  tmpBuffer << "<meta name=\"noDomains\" content=\"" << m_noDomains << "\" />\n";
  tmpBuffer << "<meta name=\"dateCreation\" content=\"" << tmpDateTime << "\" />\n";
  tmpBuffer << "<meta name=\"fileFormatVersion\" content=\"" << m_fileFormatVersion << "\" />\n";
  tmpBuffer << "<meta name=\"projectName\" content=\"" << m_projectName << "\" />\n";
  tmpBuffer << "<meta name=\"user\" content=\"" << user << "\" />\n";
  tmpBuffer << "<meta name=\"host\" content=\"" << host << " (" << XSTRINGIFY(MAIA_HOST_STRING) << ")"
            << "\" />\n";
  tmpBuffer << "<meta name=\"dir\" content=\"" << dir << "\" />\n";
  tmpBuffer << "<meta name=\"executionCommand\" content=\"" << executionCommand.str() << "\" />\n";
  tmpBuffer << "<meta name=\"revision\" content=\"" << XSTRINGIFY(MAIA_VERSION_STRING) << "\" />\n";
  tmpBuffer << "<meta name=\"build\" content=\"" << XSTRINGIFY(MAIA_COMPILER_STRING) << " "
            << XSTRINGIFY(MAIA_BUILD_TYPE_STRING) << " (" << MString(XSTRINGIFY(MAIA_COMPILER_VERSION_STRING)) << ")"
            << "\" />\n";
 
 
  // Return XML header
  return tmpBuffer.str();
}

◆ setMinFlushSize()

MInt InfoOut_buffer::setMinFlushSize ( MInt minFlushSize )

inlinevirtual

Author: Michael Schlottke

Date: June 2012

\params[in] minFlushSize Minimum buffer length.

Returns: The previous value of the minimum flush size.

Reimplemented in InfoOut_mpiFileBuffer.

Definition at line 187 of file infoout.cpp.

                                                             {
  MInt previousValue = m_minFlushSize;
  m_minFlushSize = minFlushSize;
  return previousValue;
}

◆ setRootOnly()

MBool InfoOut_buffer::setRootOnly ( MBool rootOnly = true )

inlinevirtual

Author: Michael Schlottke

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).

Definition at line 173 of file infoout.cpp.

                                                       {
  MBool previousValue = m_rootOnly;
  m_rootOnly = rootOnly;
  return previousValue;
}

Friends And Related Function Documentation

◆ InfoOut

friend class InfoOut

friend

Definition at line 41 of file infoout.h.

Member Data Documentation

◆ m_domainId

MInt InfoOut_buffer::m_domainId

protected

Definition at line 47 of file infoout.h.

◆ m_fileFormatVersion

const MInt InfoOut_buffer::m_fileFormatVersion = 1

staticprotected

File format version (increase this by one every time you make changes that could affect postprocessing tools)

Definition at line 44 of file infoout.h.

◆ m_minFlushSize

MInt InfoOut_buffer::m_minFlushSize

protected

Definition at line 49 of file infoout.h.

◆ m_noDomains

MInt InfoOut_buffer::m_noDomains

protected

Definition at line 48 of file infoout.h.

◆ m_prefixAttributes

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

protected

Definition at line 55 of file infoout.h.

◆ m_prefixMessage

MString InfoOut_buffer::m_prefixMessage

protected

Definition at line 50 of file infoout.h.

◆ m_projectName

MString InfoOut_buffer::m_projectName

protected

Definition at line 53 of file infoout.h.

◆ m_rootOnly

MBool InfoOut_buffer::m_rootOnly

protected

Definition at line 46 of file infoout.h.

◆ m_suffixMessage

MString InfoOut_buffer::m_suffixMessage

protected

Definition at line 51 of file infoout.h.

◆ m_tmpBuffer

std::ostringstream InfoOut_buffer::m_tmpBuffer

protected

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

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ InfoOut_buffer()

Member Function Documentation

◆ createPrefixMessage()

◆ createSuffixMessage()

◆ encodeXml()

◆ flushBuffer()

◆ getXmlFooter()

◆ getXmlHeader()

◆ setMinFlushSize()

◆ setRootOnly()

Friends And Related Function Documentation

◆ InfoOut

Member Data Documentation

◆ m_domainId

◆ m_fileFormatVersion

◆ m_minFlushSize

◆ m_noDomains

◆ m_prefixAttributes

◆ m_prefixMessage

◆ m_projectName

◆ m_rootOnly

◆ m_suffixMessage

◆ m_tmpBuffer