ProtoMol - an object-oriented component based framework for Molecular Dynamics simulations.

---

ProtoMol::Report::MyStreamer Class Reference

#include <Report.h>

List of all members.

Public Member Functions
	MyStreamer (std::ostream *)
std::ostream *	setStream (std::ostream *)
void	setAbort (bool)
void	setQuit (bool)
void	setAllNodes (bool)
void	setReportLevel (short level)
void	setLevel (short level)
void	setIAmMaster (bool master)
void	setf (std::ios::fmtflags flag)
void	setf (std::ios::fmtflags flag, std::ios::fmtflags mask)
void	precision (int prec)
void	width (int wide)
void	reset ()
MyStreamer &	operator<< (bool)
MyStreamer &	operator<< (char)
MyStreamer &	operator<< (unsigned char)
MyStreamer &	operator<< (signed char)
MyStreamer &	operator<< (char *)
MyStreamer &	operator<< (const char *)
MyStreamer &	operator<< (unsigned char *)
MyStreamer &	operator<< (signed char *)
MyStreamer &	operator<< (short)
MyStreamer &	operator<< (unsigned short)
MyStreamer &	operator<< (int)
MyStreamer &	operator<< (unsigned int)
MyStreamer &	operator<< (long long)
MyStreamer &	operator<< (unsigned long long)
MyStreamer &	operator<< (long)
MyStreamer &	operator<< (unsigned long)
MyStreamer &	operator<< (float)
MyStreamer &	operator<< (double)
MyStreamer &	operator<< (const std::string &)
MyStreamer &	operator<< (const std::ostream &)
MyStreamer &	operator<< (std::ostream *)
MyStreamer &	operator<< (std::ostream &(*f)(std::ostream &))
MyStreamer &	operator<< (std::ios &(*f)(std::ios &))
MyStreamer &	operator<< (MyStreamer &(*f)(MyStreamer &))
Private Member Functions
bool	print () const
Private Attributes
std::ostream *	myStream
std::ios::fmtflags	myResetFlags
bool	myAbort
bool	myQuit
bool	myAllNodes
bool	myAllNodesSerial
bool	myAllSlavesSerial
bool	myIAmMaster
bool	myDoHint
short	mySilentHint
short	myReportLevel
short	myLevel
Friends
MyStreamer &	allnodes (MyStreamer &stream)
MyStreamer &	plain (MyStreamer &stream)
MyStreamer &	hint (MyStreamer &stream)
MyStreamer &	quit (MyStreamer &stream)
MyStreamer &	aborting (MyStreamer &stream)
MyStreamer &	warning (MyStreamer &stream)
MyStreamer &	recoverable (MyStreamer &stream)
MyStreamer &	error (MyStreamer &stream)
MyStreamer &	allnodesserial (MyStreamer &stream)
MyStreamer &	allslavesserial (MyStreamer &stream)
MyStreamer &	endr (MyStreamer &stream)
MyStreamer &	dohint (MyStreamer &stream)
MyStreamer &	donthint (MyStreamer &stream)

---

Detailed Description

MyStreamer wraps the output to a given stream and provides different manipulators a la std::cout and std::cerr. report is a global instance of MyStreamer and acts as std::cout and std::cerr. In parallel environment, by default, only output from the master is passed to the actual stream. One can also pipe the putput to a file.
It handles different report levels. Production code will by default suppress all debug output (print if level <= 0, reportlevel=0), where as debug compilation will by default print all information with level <= 1, reportlevel=1.
NB! Do not put debug(<int>) inside forces, ok if it is inside initialization, otherwise use a type from oneAtomContraints.h to debug pair wise potentials

report << debug(1) << "This is only debug inforamtion"<< endr

report << quit << plain << "Well, this story gonna end soon ... " <<endr

• plain : -4
• error : -3
• recoverable : -2
• warning : -1
• hint : 0
• debug(1) : 1 important debug information
• debug(2) : 2 less important
• debug(10) : 10 really not important
• aborting : does an abort (MPI_Abort)
• quit : does an exit (MPI_Finalize)
• endr : end of report/MyStreamer output
• allnodesserial : output synchronized node by node including the master
• allslavesserial : output synchronized node by node, only slaves
• allnodes : output unsynchronized from all nodes
• donthint : suppress all hint output
• dohint : enable hint output

---

Constructor & Destructor Documentation

ProtoMol::Report::MyStreamer::MyStreamer (  std::ostream *   )

---

Member Function Documentation

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  MyStreamer &(*  f)(MyStreamer &)  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  std::ios &(*  f)(std::ios &)  )

MyStreamer& ProtoMol::Report::MyStreamer::operator<< (  std::ostream &(*  f)(std::ostream &)  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  std::ostream *   )

MyStreamer& ProtoMol::Report::MyStreamer::operator<< (  const std::ostream &   )

MyStreamer& ProtoMol::Report::MyStreamer::operator<< (  const std::string &   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  double   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  float   )

MyStreamer& ProtoMol::Report::MyStreamer::operator<< (  unsigned  long  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  long   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  unsigned long  long  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  long  long  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  unsigned  int  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  int   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  unsigned  short  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  short   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  signed char *   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  unsigned char *   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  const char *   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  char *   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  signed  char  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  unsigned  char  )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  char   )

MyStreamer & ProtoMol::Report::MyStreamer::operator<< (  bool   )

void ProtoMol::Report::MyStreamer::precision (  int  prec  )

bool ProtoMol::Report::MyStreamer::print (   )  const [inline, private]

void ProtoMol::Report::MyStreamer::reset (   )

void ProtoMol::Report::MyStreamer::setAbort (  bool   )

void ProtoMol::Report::MyStreamer::setAllNodes (  bool   )

void ProtoMol::Report::MyStreamer::setf (  std::ios::fmtflags  flag, std::ios::fmtflags  mask )

void ProtoMol::Report::MyStreamer::setf (  std::ios::fmtflags  flag  )

void ProtoMol::Report::MyStreamer::setIAmMaster (  bool  master  )  [inline]

void ProtoMol::Report::MyStreamer::setLevel (  short  level  )  [inline]

void ProtoMol::Report::MyStreamer::setQuit (  bool   )

void ProtoMol::Report::MyStreamer::setReportLevel (  short  level  )  [inline]

ostream * ProtoMol::Report::MyStreamer::setStream (  std::ostream *   )

void ProtoMol::Report::MyStreamer::width (  int  wide  )

---

Friends And Related Function Documentation

MyStreamer& aborting (  MyStreamer &  stream  )  [friend]

MyStreamer& allnodes (  MyStreamer &  stream  )  [friend]

MyStreamer& allnodesserial (  MyStreamer &  stream  )  [friend]

MyStreamer& allslavesserial (  MyStreamer &  stream  )  [friend]

MyStreamer& dohint (  MyStreamer &  stream  )  [friend]

MyStreamer& donthint (  MyStreamer &  stream  )  [friend]

MyStreamer& endr (  MyStreamer &  stream  )  [friend]

MyStreamer& error (  MyStreamer &  stream  )  [friend]

Error, abort.

MyStreamer& hint (  MyStreamer &  stream  )  [friend]

Hint, can be suppressed by donthint/dohint.

MyStreamer& plain (  MyStreamer &  stream  )  [friend]

Plain output.

MyStreamer& quit (  MyStreamer &  stream  )  [friend]

MyStreamer& recoverable (  MyStreamer &  stream  )  [friend]

Recoverable error.

MyStreamer& warning (  MyStreamer &  stream  )  [friend]

Warning.

---

Member Data Documentation

bool ProtoMol::Report::MyStreamer::myAbort [private]

bool ProtoMol::Report::MyStreamer::myAllNodes [private]

bool ProtoMol::Report::MyStreamer::myAllNodesSerial [private]

bool ProtoMol::Report::MyStreamer::myAllSlavesSerial [private]

bool ProtoMol::Report::MyStreamer::myDoHint [private]

bool ProtoMol::Report::MyStreamer::myIAmMaster [private]

short ProtoMol::Report::MyStreamer::myLevel [private]

bool ProtoMol::Report::MyStreamer::myQuit [private]

short ProtoMol::Report::MyStreamer::myReportLevel [private]

std::ios::fmtflags ProtoMol::Report::MyStreamer::myResetFlags [private]

short ProtoMol::Report::MyStreamer::mySilentHint [private]

std::ostream* ProtoMol::Report::MyStreamer::myStream [private]

---

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

• Report.h
• Report.cpp

Last update: . GNU GENERAL PUBLIC LICENSE, copyrighted by the University of Notre Dame and the University of Bergen, Norway.