Diag_writer_detail

Classes

class  stk::diag::Writer
 Class Writer implements a runtime selectable diagnostic output writer to aid in the development and diagnostics of massively parallel applications. More...
struct  stk::diag::_setlinemask
 Class _setlinemask is the line mask manipulator. More...
class  stk::diag::c_ptr_< T >
 Class c_ptr_ simply stores a pointer to an object of type T. More...
class  stk::diag::c_ptr_func_< T, R >
 Class c_ptr_func_ simply stores a pointer to an object of type T. More...
struct  stk::diag::_setw
 Class _setw is the width manipulator. More...
struct  stk::diag::_setprecision
 Class _setprecision is the precision manipulator. More...
struct  stk::diag::_setfill
 Class _setfill is the fill character manipulator. More...
struct  stk::diag::_setiosflags
 Class _setiosflags is the flags manipulator. More...
struct  stk::diag::_resetiosflags
 Class _resetiosflags is the reset ios flags reset manipulator. More...

Enumerations

enum  stk::LogMask {
  LOG_ALWAYS = 0x00000000,
  LOG_TRACE = 0x00000001,
  LOG_TRACE_STATS = 0x00000002,
  LOG_TRACE_SUB_CALLS = 0x00000004,
  LOG_MEMBERS = 0x00000008,
  LOG_STREAM_COMMON = LOG_TRACE | LOG_TRACE_STATS
}
 

Enumeration LogMask enumerates global bit assignments.


Functions

Writer & stk::diag::dendl (Writer &dout)
 Writer function dendl calls the Writer::dendl manipulator.
Writer & stk::diag::dflush (Writer &dout)
 Writer function dflush calls the Writer::dflush manipulator.
Writer & stk::diag::push (Writer &dout)
 Function push calls the Writer::push manipulator.
Writer & stk::diag::pop (Writer &dout)
 Member function pop calls the Writer::pop manipulator.
_setlinemask stk::diag::setlinemask (PrintMask line_mask)
 Function setlinemask sets the active line mask bits as a manipulator.
Writer & stk::diag::operator<< (Writer &dout, _setlinemask set_line_mask)
 Function operator<< class the Writer::setLineMask manipulator.
Writer & stk::diag::resetlinemask (Writer &dout)
 Function resetlinemask calls the Writer::resetLineMask manipulator.
Writer & stk::diag::operator<< (Writer &dout, const char *c_str)
 Function operator<< writes the c sytle string to the output stream.
Writer & stk::diag::operator<< (Writer &dout, const std::string &s)
Writer & stk::diag::operator<< (Writer &dout, const void *ptr)
Writer & stk::diag::operator<< (Writer &dout, const float &x)
Writer & stk::diag::operator<< (Writer &dout, const double &x)
Writer & stk::diag::operator<< (Writer &dout, const long double &x)
Writer & stk::diag::operator<< (Writer &dout, const int &x)
Writer & stk::diag::operator<< (Writer &dout, const unsigned int &x)
Writer & stk::diag::operator<< (Writer &dout, const long &x)
Writer & stk::diag::operator<< (Writer &dout, const unsigned long &x)
Writer & stk::diag::operator<< (Writer &dout, const short &x)
Writer & stk::diag::operator<< (Writer &dout, const unsigned short &x)
Writer & stk::diag::operator<< (Writer &dout, const long long &x)
Writer & stk::diag::operator<< (Writer &dout, const unsigned long long &x)
template<class T >
c_ptr_< T > stk::diag::c_ptr (const T *t)
 Member function c_ptr creates a c_ptr_ object of type T ala std::make_pair.
template<class T , typename R >
c_ptr_func_< T, R > stk::diag::c_ptr_func (const T *t, R(T::*pmf)() const)
 Template function c_ptr creates a c_ptr_func_ object of type T ala std::make_pair.
template<class T >
Writer & stk::diag::operator<< (Writer &dout, const c_ptr_< T > &c)
 Template function operator<< dereferences the c_ptr_ object's member m_t if it is not null and writes that to the diagnostic writer.
template<class T , typename R >
Writer & stk::diag::operator<< (Writer &dout, const c_ptr_func_< T, R > &c)
 Template function operator<< dereferences the c_ptr_func_ object's member m_t if it is not null and calls the m_pmf member function and writes the result of that to the diagnostic writer.
Writer & stk::diag::operator<< (Writer &dout, const std::type_info &t)
 Function operator<< wrties a std::type_info name to the diagnostic writer.
template<class T >
Writer & stk::diag::operator<< (Writer &dout, const std::auto_ptr< T > &t)
 Template function operator<< writes an std::auto_ptr object address and content to the diagnostic writer.
template<class T , class U >
Writer & stk::diag::operator<< (Writer &dout, const std::pair< T, U > &pair)
 Template function operator<< writes the members of an arbitrary std::pair object to the diagnostic writer.
template<class T >
Writer & stk::diag::dump (Writer &dout, const std::vector< T > &t)
 Template dump prints the object contained within a std::vector object to the diagnostic writer.
template<class T >
Writer & stk::diag::dump (Writer &dout, const std::vector< T * > &t)
 Template function dump prints the object pointed to that are contained within a std::vector object to the diagnostic writer.
template<class T >
Writer & stk::diag::dump (Writer &dout, const std::list< T > &t)
 Template function dump prints the object contained within a std::list object to the diagnostic writer.
template<class T >
Writer & stk::diag::dump (Writer &dout, const std::list< T * > &t)
 Template function dump prints the object pointed to that are contained within a std::list object to the diagnostic writer.
template<class Key , class T , class L >
Writer & stk::diag::dump (Writer &dout, const std::map< Key, T, L > &t)
 Template function dump prints the object contained within a std::map object to the diagnostic writer.
template<class Key , class T , class L >
Writer & stk::diag::dump (Writer &dout, const std::map< Key, T *, L > &t)
 Template function dump prints the object pointed to that are contained within a std::map to the diagnostic writer.
template<class Key , class T , class L >
Writer & stk::diag::dump (Writer &dout, const std::multimap< Key, T, L > &t)
 Template function dump prints the object contained within a std::multimap object to the diagnostic writer.
template<class Key , class T , class L >
Writer & stk::diag::dump (Writer &dout, const std::multimap< Key, T *, L > &t)
 Template function dump prints the object pointed to that are contained within a std::multimap to the diagnostic writer.
template<class Key , class L >
Writer & stk::diag::dump (Writer &dout, const std::set< Key, L > &t)
 Template function dump prints the object contained within a std::set object to the diagnostic writer.
template<class Key , class L >
Writer & stk::diag::dump (Writer &dout, const std::set< Key *, L > &t)
 Template function dump prints the object contained within a std::set object to the diagnostic writer.
template<class Key , class L >
Writer & stk::diag::dump (Writer &dout, const std::multiset< Key, L > &t)
 Template function dump prints the object contained within a std::multiset object to the diagnostic writer.
template<class Key , class L >
Writer & stk::diag::dump (Writer &dout, const std::multiset< Key *, L > &t)
 Template function dump prints the object contained within a std::multiset object to the diagnostic writer.
template<size_t n>
Writer & stk::diag::operator<< (Writer &dout, const std::bitset< n > &t)
 Template dump prints the object contained within a hash_map to the diagnostic writer.
template<class T >
Writer & stk::diag::operator<< (Writer &dout, const std::vector< T > &t)
 Member function operator<< write the std::vector object to the diagnostic writer.
template<class T >
Writer & stk::diag::operator<< (Writer &dout, const std::list< T > &t)
 Template function operator<< write the std::list object to the diagnostic writer.
template<class Key , class T , class L >
Writer & stk::diag::operator<< (Writer &dout, const std::map< Key, T, L > &t)
 Template function operator<< writes the std::map object to the diagnostic writer.
template<class Key , class T , class L >
Writer & stk::diag::operator<< (Writer &dout, const std::multimap< Key, T, L > &t)
 Template function operator<< writes the std::multimap object to the diagnostic writer.
template<class Key , class L >
Writer & stk::diag::operator<< (Writer &dout, const std::set< Key, L > &t)
 Template function operator<< writes the std::set object to the diagnostic writer.
template<class Key , class L >
Writer & stk::diag::operator<< (Writer &dout, const std::multiset< Key, L > &t)
 Template function operator<< writes the std::multiset object to the diagnostic writer.
_setw stk::diag::setw (int width)
 Function setw sets the width for the next field as a manipulator.
Writer & stk::diag::operator<< (Writer &dout, _setw set_width)
_setprecision stk::diag::setprecision (int precision)
 Function setprecision sets the numeric precision as a manipulator.
Writer & stk::diag::operator<< (Writer &dout, _setprecision set_precision)
_setfill stk::diag::setfill (char fill)
 Function setfill sets the fill character as a manipulator.
Writer & stk::diag::operator<< (Writer &dout, _setfill set_fill)
_setiosflags stk::diag::setiosflags (std::ios_base::fmtflags flags)
 Function setiosflags sets the ios flags as a manipulator.
Writer & stk::diag::operator<< (Writer &dout, _setiosflags set_flags)
_resetiosflags stk::diag::resetiosflags (std::ios_base::fmtflags flags)
 Function resetiosflags clears the ios flags as a manipulator.
Writer & stk::diag::operator<< (Writer &dout, _resetiosflags reset_flags)
Writer & stk::diag::fixed (Writer &dout)
Writer & stk::diag::scientific (Writer &dout)
Writer & stk::diag::dec (Writer &dout)
Writer & stk::diag::hex (Writer &dout)
Writer & stk::diag::oct (Writer &dout)
template<class T >
Writer & stk::diag::operator<< (Writer &dout, const T &t)
 Function operator<< is the catch all std::ostream output put-to operator to Writer put-to operator.

Function Documentation

Writer& stk::diag::dendl ( Writer &  dout  )  [inline]

Writer function dendl calls the Writer::dendl manipulator.

Parameters:
dout a Writer reference to the diagnostic writer to dendl.
Returns:
a Writer reference to this object

Definition at line 505 of file Writer.hpp.

Writer& stk::diag::dflush ( Writer &  dout  )  [inline]

Writer function dflush calls the Writer::dflush manipulator.

Parameters:
dout a Writer reference to the diagnostic writer to flush.
Returns:
a Writer reference to this object

Definition at line 517 of file Writer.hpp.

Writer& stk::diag::push ( Writer &  dout  )  [inline]

Function push calls the Writer::push manipulator.

Parameters:
dout a Writer reference to the diagnostic writer to push.
Returns:
a Writer reference to this object

Definition at line 529 of file Writer.hpp.

Writer& stk::diag::pop ( Writer &  dout  )  [inline]

Member function pop calls the Writer::pop manipulator.

Parameters:
dout a Writer reference to the diagnostic writer to pop.
Returns:
a Writer reference to this object

Definition at line 541 of file Writer.hpp.

_setlinemask stk::diag::setlinemask ( PrintMask  line_mask  )  [inline]

Function setlinemask sets the active line mask bits as a manipulator.

Parameters:
line_mask a PrintMask value of the bits to set.

Definition at line 570 of file Writer.hpp.

Writer& stk::diag::operator<< ( Writer &  dout,
_setlinemask  set_line_mask 
) [inline]

Function operator<< class the Writer::setLineMask manipulator.

Parameters:
dout a Writer reference to the diagnostic writer to set the line mask.
set_line_mask a _setlinemask value of the line mask to set.
Returns:
a Writer reference to this object

Definition at line 584 of file Writer.hpp.

Writer& stk::diag::resetlinemask ( Writer &  dout  )  [inline]

Function resetlinemask calls the Writer::resetLineMask manipulator.

Parameters:
dout a Writer reference to the diagnostic writer to dendl.
Returns:
a Writer reference to this object

Definition at line 596 of file Writer.hpp.

Writer & stk::diag::operator<< ( Writer &  dout,
const char *  c_str 
)

Function operator<< writes the c sytle string to the output stream.

Parameters:
dout a Writer reference to the diagnostic writer to write the c style string to.
c_str a char const pointer to the start of the c style string.
Returns:
a Writer reference to this object
template<class T >
c_ptr_<T> stk::diag::c_ptr ( const T *  t  )  [inline]

Member function c_ptr creates a c_ptr_ object of type T ala std::make_pair.

Parameters:
t a T pointer to an object that is to be dereferenced.
Returns:
a c_ptr_ object which contains the pointer t.

Definition at line 656 of file Writer.hpp.

template<class T , typename R >
c_ptr_func_<T, R> stk::diag::c_ptr_func ( const T *  t,
R(T::*)() const   pmf 
) [inline]

Template function c_ptr creates a c_ptr_func_ object of type T ala std::make_pair.

This T must implement a member function which takes no arguments and returns a value of type R.

Parameters:
t a T pointer to an object that is call the specified member function.
pmf a T::* member function pointer to call
Returns:
a c_ptr_ object which contains the pointer t and a member function whch takes no arguments.

Definition at line 703 of file Writer.hpp.

template<class T >
Writer& stk::diag::operator<< ( Writer &  dout,
const c_ptr_< T > &  c 
) [inline]

Template function operator<< dereferences the c_ptr_ object's member m_t if it is not null and writes that to the diagnostic writer.

If the object's member is null, it writes "<not created>".

Parameters:
dout a Writer reference to the diagnostic writer to write the <T> object to if the pointer to it is not null.
c a c_ptr_ reference with a member to dereference and write to ethe diagnostic writer if not null.
Returns:
a Writer reference to this object

Definition at line 721 of file Writer.hpp.

template<class T , typename R >
Writer& stk::diag::operator<< ( Writer &  dout,
const c_ptr_func_< T, R > &  c 
) [inline]

Template function operator<< dereferences the c_ptr_func_ object's member m_t if it is not null and calls the m_pmf member function and writes the result of that to the diagnostic writer.

If the object's member is null, it writes "<not created>".

Parameters:
dout a Writer reference to the diagnostic writer to write the T object to if the pointer to it is not null.
c a c_ptr_func_ reference with a member to dereference and call the member function m_pmt if m_t is not null.
Returns:
a Writer reference to this object

Definition at line 747 of file Writer.hpp.

Writer & stk::diag::operator<< ( Writer &  dout,
const std::type_info &  t 
)

Function operator<< wrties a std::type_info name to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::type_info object to.
t a std::type_info const reference to the std::typeinfo object.
Returns:
a Writer reference to this object
template<class T >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::auto_ptr< T > &  t 
) [inline]

Template function operator<< writes an std::auto_ptr object address and content to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::auto_ptr object.
t a std::auto_ptr const reference to the object.
Returns:
a Writer reference to this object

Definition at line 59 of file WriterExt.hpp.

template<class T , class U >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::pair< T, U > &  pair 
) [inline]

Template function operator<< writes the members of an arbitrary std::pair object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::pair members to.
pair a std::pair const reference to the pair of objects.
Returns:
a Writer reference to this object

Definition at line 80 of file WriterExt.hpp.

template<class T >
Writer& stk::diag::dump ( Writer &  dout,
const std::vector< T > &  t 
) [inline]

Template dump prints the object contained within a std::vector object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::vector to.
t a std::vector of objects.
Returns:
a Writer reference to this object

Definition at line 100 of file WriterExt.hpp.

template<class T >
Writer& stk::diag::dump ( Writer &  dout,
const std::vector< T * > &  t 
) [inline]

Template function dump prints the object pointed to that are contained within a std::vector object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::vector to.
t a std::vector of objects.
Returns:
a Writer reference to this object

Definition at line 137 of file WriterExt.hpp.

template<class T >
Writer& stk::diag::dump ( Writer &  dout,
const std::list< T > &  t 
) [inline]

Template function dump prints the object contained within a std::list object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::list to.
t a std::list of objects.
Returns:
a Writer reference to this object

Definition at line 167 of file WriterExt.hpp.

template<class T >
Writer& stk::diag::dump ( Writer &  dout,
const std::list< T * > &  t 
) [inline]

Template function dump prints the object pointed to that are contained within a std::list object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::list to.
t a std::list of objects.
Returns:
a Writer reference to this object

Definition at line 197 of file WriterExt.hpp.

template<class Key , class T , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::map< Key, T, L > &  t 
) [inline]

Template function dump prints the object contained within a std::map object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::map to.
t a std::map of objects.
Returns:
a Writer reference to this object

Definition at line 227 of file WriterExt.hpp.

template<class Key , class T , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::map< Key, T *, L > &  t 
) [inline]

Template function dump prints the object pointed to that are contained within a std::map to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::map to.
t a std::map of objects.
Returns:
a Writer reference to this object

Definition at line 256 of file WriterExt.hpp.

template<class Key , class T , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::multimap< Key, T, L > &  t 
) [inline]

Template function dump prints the object contained within a std::multimap object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::multimap to.
t a std::multimap of objects.
Returns:
a Writer reference to this object

Definition at line 285 of file WriterExt.hpp.

template<class Key , class T , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::multimap< Key, T *, L > &  t 
) [inline]

Template function dump prints the object pointed to that are contained within a std::multimap to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::multimap to.
t a std::multimap of objects.
Returns:
a Writer reference to this object

Definition at line 314 of file WriterExt.hpp.

template<class Key , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::set< Key, L > &  t 
) [inline]

Template function dump prints the object contained within a std::set object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::set to.
t a std::set of objects.
Returns:
a Writer reference to this object

Definition at line 343 of file WriterExt.hpp.

template<class Key , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::set< Key *, L > &  t 
) [inline]

Template function dump prints the object contained within a std::set object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::set to.
t a std::set of objects.
Returns:
a Writer reference to this object

Definition at line 372 of file WriterExt.hpp.

template<class Key , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::multiset< Key, L > &  t 
) [inline]

Template function dump prints the object contained within a std::multiset object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::multiset to.
t a std::multiset of objects.
Returns:
a Writer reference to this object

Definition at line 401 of file WriterExt.hpp.

template<class Key , class L >
Writer& stk::diag::dump ( Writer &  dout,
const std::multiset< Key *, L > &  t 
) [inline]

Template function dump prints the object contained within a std::multiset object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::multiset to.
t a std::multiset of objects.
Returns:
a Writer reference to this object

Definition at line 430 of file WriterExt.hpp.

template<size_t n>
Writer& stk::diag::operator<< ( Writer &  dout,
const std::bitset< n > &  t 
) [inline]

Template dump prints the object contained within a hash_map to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the hash_map to.
t a hash_map of objects.
Returns:
a Writer reference to this object Template dump prints the object pointed to that are contained within a hash_map to the diagnostic writer.
Parameters:
dout a Writer reference to the diagnostic writer to write the hash_map to.
t a hash_map of objects.
Returns:
a Writer reference to this object

Definition at line 507 of file WriterExt.hpp.

template<class T >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::vector< T > &  t 
) [inline]

Member function operator<< write the std::vector object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::list to.
t a std::vector const reference to the std::vector.
Returns:
a Writer reference to this object

Definition at line 527 of file WriterExt.hpp.

template<class T >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::list< T > &  t 
) [inline]

Template function operator<< write the std::list object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::list to.
t a std::list const reference to the std::list.
Returns:
a Writer reference to this object

Definition at line 543 of file WriterExt.hpp.

template<class Key , class T , class L >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::map< Key, T, L > &  t 
) [inline]

Template function operator<< writes the std::map object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::map to.
t a std::map const reference to the std::map.
Returns:
a Writer reference to this object

Definition at line 559 of file WriterExt.hpp.

template<class Key , class T , class L >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::multimap< Key, T, L > &  t 
) [inline]

Template function operator<< writes the std::multimap object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::multimap to.
t a std::multimap const reference to the std::multimap.
Returns:
a Writer reference to this object

Definition at line 575 of file WriterExt.hpp.

template<class Key , class L >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::set< Key, L > &  t 
) [inline]

Template function operator<< writes the std::set object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::set to.
t a std::set const reference to the std::set.
Returns:
a Writer reference to this object

Definition at line 591 of file WriterExt.hpp.

template<class Key , class L >
Writer& stk::diag::operator<< ( Writer &  dout,
const std::multiset< Key, L > &  t 
) [inline]

Template function operator<< writes the std::multiset object to the diagnostic writer.

Parameters:
dout a Writer reference to the diagnostic writer to write the std::multiset to.
t a std::multiset const reference to the std::multiset.
Returns:
a Writer reference to this object

Definition at line 607 of file WriterExt.hpp.

_setw stk::diag::setw ( int  width  )  [inline]

Function setw sets the width for the next field as a manipulator.

Parameters:
width a int value for the width of the next field.

Definition at line 44 of file WriterManip.hpp.

_setprecision stk::diag::setprecision ( int  precision  )  [inline]

Function setprecision sets the numeric precision as a manipulator.

Parameters:
precision a int value of the precision.

Definition at line 70 of file WriterManip.hpp.

_setfill stk::diag::setfill ( char  fill  )  [inline]

Function setfill sets the fill character as a manipulator.

Parameters:
fill a char value of the fill character.

Definition at line 96 of file WriterManip.hpp.

_setiosflags stk::diag::setiosflags ( std::ios_base::fmtflags  flags  )  [inline]

Function setiosflags sets the ios flags as a manipulator.

Parameters:
flags a std::ios_base::fmtflags value of the flags.

Definition at line 122 of file WriterManip.hpp.

_resetiosflags stk::diag::resetiosflags ( std::ios_base::fmtflags  flags  )  [inline]

Function resetiosflags clears the ios flags as a manipulator.

Parameters:
flags a std::ios_base::fmtflags value of the flags.

Definition at line 148 of file WriterManip.hpp.

template<class T >
Writer& stk::diag::operator<< ( Writer &  dout,
const T &  t 
) [inline]

Function operator<< is the catch all std::ostream output put-to operator to Writer put-to operator.

When using this, if you attempt to put and object that has no put-to operator to std::ostream, expect to get a list of all opt-to operator defined for the std::ostream.

Parameters:
dout a Writer reference to the writer to put to.
t a T const reference to the object to put.

Definition at line 34 of file WriterOStream.hpp.

Generated on Wed Apr 13 10:05:49 2011 for Sierra Toolkit by  doxygen 1.6.3