Sierra Toolkit  Version of the Day
Diag_writer_detail

Classes

class  stk_classic::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_classic::diag::_setlinemask
 Class _setlinemask is the line mask manipulator. More...
 
class  stk_classic::diag::c_ptr_< T >
 Class c_ptr_ simply stores a pointer to an object of type T. This allows pointers which want to be deferenced if they are not null to be output using operator<< on a c_ptr function. More...
 
class  stk_classic::diag::c_ptr_func_< T, R >
 Class c_ptr_func_ simply stores a pointer to an object of type T. This allows pointers which want to call the specified member function if they are not null to be output using operator<< on a c_ptr_func function. More...
 
struct  stk_classic::diag::_setw
 Class _setw is the width manipulator. More...
 
struct  stk_classic::diag::_setprecision
 Class _setprecision is the precision manipulator. More...
 
struct  stk_classic::diag::_setfill
 Class _setfill is the fill character manipulator. More...
 
struct  stk_classic::diag::_setiosflags
 Class _setiosflags is the flags manipulator. More...
 
struct  stk_classic::diag::_resetiosflags
 Class _resetiosflags is the reset ios flags reset manipulator. More...
 

Enumerations

enum  stk_classic::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,
  LOG_PARAMETERS = 0x00000100
}
 Enumeration LogMask enumerates global bit assignments.
 

Functions

Writerstk_classic::diag::dendl (Writer &dout)
 Writer function dendl calls the Writer::dendl manipulator. More...
 
Writerstk_classic::diag::dflush (Writer &dout)
 Writer function dflush calls the Writer::dflush manipulator. More...
 
Writerstk_classic::diag::push (Writer &dout)
 Function push calls the Writer::push manipulator. More...
 
Writerstk_classic::diag::pop (Writer &dout)
 Member function pop calls the Writer::pop manipulator. More...
 
_setlinemask stk_classic::diag::setlinemask (PrintMask line_mask)
 Function setlinemask sets the active line mask bits as a manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, _setlinemask set_line_mask)
 Function operator<< class the Writer::setLineMask manipulator. More...
 
Writerstk_classic::diag::resetlinemask (Writer &dout)
 Function resetlinemask calls the Writer::resetLineMask manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const char *c_str)
 Function operator<< writes the c sytle string to the output stream. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const std::string &s)
 
Writerstk_classic::diag::operator<< (Writer &dout, const void *ptr)
 
Writerstk_classic::diag::operator<< (Writer &dout, const float &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const double &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const long double &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const int &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const unsigned int &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const long &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const unsigned long &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const short &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const unsigned short &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const long long &x)
 
Writerstk_classic::diag::operator<< (Writer &dout, const unsigned long long &x)
 
template<class T >
c_ptr_< T > stk_classic::diag::c_ptr (const T *t)
 
template<class T , typename R >
c_ptr_func_< T, R > stk_classic::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. This T must implement a member function which takes no arguments and returns a value of type R. More...
 
template<class T >
Writerstk_classic::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. If the object's member is null, it writes "<not created>". More...
 
template<class T , typename R >
Writerstk_classic::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. If the object's member is null, it writes "<not created>". More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const std::type_info &t)
 Function operator<< wrties a std::type_info name to the diagnostic writer. More...
 
template<class T >
Writerstk_classic::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. More...
 
template<class T , class U >
Writerstk_classic::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. More...
 
template<class T >
Writerstk_classic::diag::dump (Writer &dout, const std::vector< T > &t)
 Template dump prints the object contained within a std::vector object to the diagnostic writer. More...
 
template<class T >
Writerstk_classic::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. More...
 
template<class T >
Writerstk_classic::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. More...
 
template<class T >
Writerstk_classic::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. More...
 
template<class Key , class T , class L >
Writerstk_classic::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. More...
 
template<class Key , class T , class L >
Writerstk_classic::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. More...
 
template<class Key , class T , class L >
Writerstk_classic::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. More...
 
template<class Key , class T , class L >
Writerstk_classic::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. More...
 
template<class Key , class L >
Writerstk_classic::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. More...
 
template<class Key , class L >
Writerstk_classic::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. More...
 
template<class Key , class L >
Writerstk_classic::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. More...
 
template<class Key , class L >
Writerstk_classic::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. More...
 
template<size_t n>
Writerstk_classic::diag::operator<< (Writer &dout, const std::bitset< n > &t)
 Template dump prints the object contained within a hash_map to the diagnostic writer. More...
 
template<class T >
Writerstk_classic::diag::operator<< (Writer &dout, const std::vector< T > &t)
 Member function operator<< write the std::vector object to the diagnostic writer. More...
 
template<class T >
Writerstk_classic::diag::operator<< (Writer &dout, const std::list< T > &t)
 Template function operator<< write the std::list object to the diagnostic writer. More...
 
template<class Key , class T , class L >
Writerstk_classic::diag::operator<< (Writer &dout, const std::map< Key, T, L > &t)
 Template function operator<< writes the std::map object to the diagnostic writer. More...
 
template<class Key , class T , class L >
Writerstk_classic::diag::operator<< (Writer &dout, const std::multimap< Key, T, L > &t)
 Template function operator<< writes the std::multimap object to the diagnostic writer. More...
 
template<class Key , class L >
Writerstk_classic::diag::operator<< (Writer &dout, const std::set< Key, L > &t)
 Template function operator<< writes the std::set object to the diagnostic writer. More...
 
template<class Key , class L >
Writerstk_classic::diag::operator<< (Writer &dout, const std::multiset< Key, L > &t)
 Template function operator<< writes the std::multiset object to the diagnostic writer. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::String &s)
 Function operator<< writes a sierra String object to the diagnostic writer. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::Identifier &s)
 Function operator<< writes a sierra Identifier object to the diagnostic writer. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::MPI::Loc< int > &loc)
 Function operator<< writes the MPI::Loc<int> type to the output stream. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::MPI::Loc< double > &loc)
 Function operator<< writes the sierra::MPI::Loc<double> type to the output stream. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::MPI::Loc< float > &loc)
 Function operator<< writes the sierra::MPI::Loc<float> type to the output stream. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::MPI::TempLoc &loc)
 Function operator<< writes the TempLoc type to the output stream. More...
 
template<class T >
c_ptr_func_< T, const sierra::String & > stk_classic::diag::c_ptr_name (const T *t)
 Template function c_ptr_name implements c_ptr_func with the function 'name'. More...
 
template<class ElementType , class Tag0 , class Tag1 , class Tag2 , class Tag3 , class Tag4 , class Tag5 , class Tag6 , class Tag7 >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::Array< ElementType, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &array)
 
template<class ElementType , class Tag0 , class Tag1 , class Tag2 , class Tag3 , class Tag4 , class Tag5 , class Tag6 , class Tag7 >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::ArrayContainer< ElementType, Tag0, Tag1, Tag2, Tag3, Tag4, Tag5, Tag6, Tag7 > &array)
 
template<class ElementType , int Dimension>
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::FArray< ElementType, Dimension > &array)
 
template<class ElementType , int Dimension>
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::FArrayContainer< ElementType, Dimension > &array)
 
template<class T >
Writerstk_classic::diag::dump (Writer &dout, const sierra::Mapv_no_delete< T > &t)
 Template function dump writes a Mapv_no_delete object to the diagnostic writer. More...
 
template<class Key , class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::vecmap< Key, T, U > &t)
 Template function dump writes the vecmap object to the diagnostic writer. More...
 
template<class Key , class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::vecmap< Key, T *, U > &t)
 Template function dump writes a vecmap of pointers object to the diagnostic writer. More...
 
template<class Key , class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::vecmap< Key *, T *, U > &t)
 Template function dump writes a vecmap of pointers object to the dignostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::vecset< T, U > &t)
 Template function dump writes a vecset object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::vecset< T *, U > &t)
 Template function dump writes a vecset of pointers object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::MapvNode< T, U > &t)
 Template dump writes a MapvNode object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::dump (Writer &dout, const sierra::Mapv< T, U > &t)
 Template function dump writes a Mapv object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::vecset< T, U > &t)
 Member function operator<< writer a vecset object the diagnostic writer. More...
 
template<class Key , class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::vecmap< Key, T, U > &t)
 Template function operator<< writes the vecmap object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::vecset< T *, U > &t)
 Member function operator<< writes a vecset of pointers object to the diagnostic writer. More...
 
template<class Key , class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::vecmap< Key *, T *, U > &t)
 Template function operator<< writea a vecmap of pointers with key pointers object to the diagnostic writer. More...
 
template<class T >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::Mapv_no_delete< T > &t)
 Template function operator<< writes a Mpav_no_delete object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::Mapv< T, U > &t)
 Member function operator<< writes a Mapv object to the diagnostic writer. More...
 
template<class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::MapvNode< T, U > &t)
 Template function operator<< writes a MapvNode object to the diagnostic writer. More...
 
template<class Key , class T , class U >
Writerstk_classic::diag::operator<< (Writer &dout, const sierra::vecmap< Key, T *, U > &t)
 Template function operator<< writes a vecmap of pointers object to the dignostic writer. More...
 
_setw stk_classic::diag::setw (int width)
 Function setw sets the width for the next field as a manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, _setw set_width)
 
_setprecision stk_classic::diag::setprecision (int precision)
 Function setprecision sets the numeric precision as a manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, _setprecision set_precision)
 
_setfill stk_classic::diag::setfill (char fill)
 Function setfill sets the fill character as a manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, _setfill set_fill)
 
_setiosflags stk_classic::diag::setiosflags (std::ios_base::fmtflags flags)
 Function setiosflags sets the ios flags as a manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, _setiosflags set_flags)
 
_resetiosflags stk_classic::diag::resetiosflags (std::ios_base::fmtflags flags)
 Function resetiosflags clears the ios flags as a manipulator. More...
 
Writerstk_classic::diag::operator<< (Writer &dout, _resetiosflags reset_flags)
 
Writerstk_classic::diag::fixed (Writer &dout)
 
Writerstk_classic::diag::scientific (Writer &dout)
 
Writerstk_classic::diag::dec (Writer &dout)
 
Writerstk_classic::diag::hex (Writer &dout)
 
Writerstk_classic::diag::oct (Writer &dout)
 
template<class T >
Writerstk_classic::diag::operator<< (Writer &dout, const T &t)
 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. More...
 

Detailed Description

Function Documentation

◆ dendl()

Writer& stk_classic::diag::dendl ( Writer dout)
inline

Writer function dendl calls the Writer::dendl manipulator.

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

Definition at line 520 of file Writer.hpp.

◆ dflush()

Writer& stk_classic::diag::dflush ( Writer dout)
inline

Writer function dflush calls the Writer::dflush manipulator.

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

Definition at line 532 of file Writer.hpp.

◆ push()

Writer& stk_classic::diag::push ( Writer dout)
inline

Function push calls the Writer::push manipulator.

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

Definition at line 544 of file Writer.hpp.

◆ pop()

Writer& stk_classic::diag::pop ( Writer dout)
inline

Member function pop calls the Writer::pop manipulator.

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

Definition at line 556 of file Writer.hpp.

◆ setlinemask()

_setlinemask stk_classic::diag::setlinemask ( PrintMask  line_mask)
inline

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

Parameters
line_maska PrintMask value of the bits to set.

Definition at line 585 of file Writer.hpp.

◆ operator<<() [1/29]

Writer& stk_classic::diag::operator<< ( Writer dout,
_setlinemask  set_line_mask 
)
inline

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

Parameters
douta Writer reference to the diagnostic writer to set the line mask.
set_line_maska _setlinemask value of the line mask to set.
Returns
a Writer reference to this object

Definition at line 600 of file Writer.hpp.

◆ resetlinemask()

Writer& stk_classic::diag::resetlinemask ( Writer dout)
inline

Function resetlinemask calls the Writer::resetLineMask manipulator.

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

Definition at line 613 of file Writer.hpp.

◆ operator<<() [2/29]

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

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

Parameters
douta Writer reference to the diagnostic writer to write the c style string to.
c_stra char const pointer to the start of the c style string.
Returns
a Writer reference to this object

Definition at line 170 of file Writer.cpp.

◆ c_ptr()

template<class T >
c_ptr_<T> stk_classic::diag::c_ptr ( const T *  t)

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

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

Definition at line 675 of file Writer.hpp.

◆ c_ptr_func()

template<class T , typename R >
c_ptr_func_<T, R> stk_classic::diag::c_ptr_func ( const T *  t,
R(T::*)() const  pmf 
)

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
ta T pointer to an object that is call the specified member function.
pmfa 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 724 of file Writer.hpp.

◆ operator<<() [3/29]

template<class T >
Writer& stk_classic::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. If the object's member is null, it writes "<not created>".

Parameters
douta Writer reference to the diagnostic writer to write the <T> object to if the pointer to it is not null.
ca 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 742 of file Writer.hpp.

◆ operator<<() [4/29]

template<class T , typename R >
Writer& stk_classic::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. If the object's member is null, it writes "<not created>".

Parameters
douta Writer reference to the diagnostic writer to write the T object to if the pointer to it is not null.
ca 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 768 of file Writer.hpp.

◆ operator<<() [5/29]

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

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

Parameters
douta Writer reference to the diagnostic writer to write the std::type_info object to.
ta std::type_info const reference to the std::typeinfo object.
Returns
a Writer reference to this object

Definition at line 31 of file WriterExt.cpp.

◆ operator<<() [6/29]

template<class T >
Writer& stk_classic::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.

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

Definition at line 74 of file WriterExt.hpp.

◆ operator<<() [7/29]

template<class T , class U >
Writer& stk_classic::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.

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

Definition at line 95 of file WriterExt.hpp.

◆ dump() [1/20]

template<class T >
Writer& stk_classic::diag::dump ( Writer dout,
const std::vector< T > &  t 
)

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

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

Definition at line 115 of file WriterExt.hpp.

◆ dump() [2/20]

template<class T >
Writer& stk_classic::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.

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

Definition at line 152 of file WriterExt.hpp.

◆ dump() [3/20]

template<class T >
Writer& stk_classic::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.

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

Definition at line 182 of file WriterExt.hpp.

◆ dump() [4/20]

template<class T >
Writer& stk_classic::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.

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

Definition at line 212 of file WriterExt.hpp.

◆ dump() [5/20]

template<class Key , class T , class L >
Writer& stk_classic::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.

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

Definition at line 242 of file WriterExt.hpp.

◆ dump() [6/20]

template<class Key , class T , class L >
Writer& stk_classic::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.

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

Definition at line 271 of file WriterExt.hpp.

◆ dump() [7/20]

template<class Key , class T , class L >
Writer& stk_classic::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.

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

Definition at line 300 of file WriterExt.hpp.

◆ dump() [8/20]

template<class Key , class T , class L >
Writer& stk_classic::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.

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

Definition at line 329 of file WriterExt.hpp.

◆ dump() [9/20]

template<class Key , class L >
Writer& stk_classic::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.

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

Definition at line 358 of file WriterExt.hpp.

◆ dump() [10/20]

template<class Key , class L >
Writer& stk_classic::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.

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

Definition at line 387 of file WriterExt.hpp.

◆ dump() [11/20]

template<class Key , class L >
Writer& stk_classic::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.

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

Definition at line 416 of file WriterExt.hpp.

◆ dump() [12/20]

template<class Key , class L >
Writer& stk_classic::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.

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

Definition at line 445 of file WriterExt.hpp.

◆ operator<<() [8/29]

template<size_t n>
Writer& stk_classic::diag::operator<< ( Writer dout,
const std::bitset< n > &  t 
)

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

Parameters
douta Writer reference to the diagnostic writer to write the hash_map to.
ta 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
douta Writer reference to the diagnostic writer to write the hash_map to.
ta hash_map of objects.
Returns
a Writer reference to this object

Definition at line 522 of file WriterExt.hpp.

◆ operator<<() [9/29]

template<class T >
Writer& stk_classic::diag::operator<< ( Writer dout,
const std::vector< T > &  t 
)

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

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

Definition at line 542 of file WriterExt.hpp.

◆ operator<<() [10/29]

template<class T >
Writer& stk_classic::diag::operator<< ( Writer dout,
const std::list< T > &  t 
)

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

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

Definition at line 558 of file WriterExt.hpp.

◆ operator<<() [11/29]

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

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

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

Definition at line 574 of file WriterExt.hpp.

◆ operator<<() [12/29]

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

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

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

Definition at line 590 of file WriterExt.hpp.

◆ operator<<() [13/29]

template<class Key , class L >
Writer& stk_classic::diag::operator<< ( Writer dout,
const std::set< Key, L > &  t 
)

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

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

Definition at line 606 of file WriterExt.hpp.

◆ operator<<() [14/29]

template<class Key , class L >
Writer& stk_classic::diag::operator<< ( Writer dout,
const std::multiset< Key, L > &  t 
)

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

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

Definition at line 622 of file WriterExt.hpp.

◆ operator<<() [15/29]

Writer & stk_classic::diag::operator<< ( Writer dout,
const sierra::String s 
)

Function operator<< writes a sierra String object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the sierra string to.
sa sierra::String const reference to the sierra string to write.
Returns
a Writer reference to this object

Definition at line 42 of file WriterExt.cpp.

◆ operator<<() [16/29]

Writer & stk_classic::diag::operator<< ( Writer dout,
const sierra::Identifier s 
)

Function operator<< writes a sierra Identifier object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the sierra identifier to.
sa sierra::String const reference to the sierra identifier to write.
Returns
a Writer reference to this object

Definition at line 53 of file WriterExt.cpp.

◆ operator<<() [17/29]

Writer & stk_classic::diag::operator<< ( Writer dout,
const sierra::MPI::Loc< int > &  loc 
)

Function operator<< writes the MPI::Loc<int> type to the output stream.

Parameters
douta Writer reference to the diagnostic writer to write the c style string to.
loca MPI::Loc<int> const reference to the MPI::MaxLoc/MPI::MinLoc operator object.
Returns
a Writer reference to this object

Definition at line 65 of file WriterExt.cpp.

◆ operator<<() [18/29]

Writer & stk_classic::diag::operator<< ( Writer dout,
const sierra::MPI::Loc< double > &  loc 
)

Function operator<< writes the sierra::MPI::Loc<double> type to the output stream.

Parameters
douta Writer reference to the diagnostic writer to write the c style string to.
loca sierra::MPI::Loc<int> const reference to the sierra::MPI::MaxLoc/sierra::MPI::MinLoc operator object.
Returns
a Writer reference to this object

Definition at line 76 of file WriterExt.cpp.

◆ operator<<() [19/29]

Writer & stk_classic::diag::operator<< ( Writer dout,
const sierra::MPI::Loc< float > &  loc 
)

Function operator<< writes the sierra::MPI::Loc<float> type to the output stream.

Parameters
douta Writer reference to the diagnostic writer to write the c style string to.
loca sierra::MPI::Loc<int> const reference to the sierra::MPI::MaxLoc/sierra::MPI::MinLoc operator object.
Returns
a Writer reference to this object

Definition at line 87 of file WriterExt.cpp.

◆ operator<<() [20/29]

Writer & stk_classic::diag::operator<< ( Writer dout,
const sierra::MPI::TempLoc &  loc 
)

Function operator<< writes the TempLoc type to the output stream.

Parameters
douta Writer reference to the diagnostic writer to write the c style string to.
loca sierra::MPI::Loc<int> const reference to the sierra::MPI::MaxLoc/sierra::MPI::MinLoc operator object.
Returns
a Writer reference to this object

Definition at line 98 of file WriterExt.cpp.

◆ c_ptr_name()

template<class T >
c_ptr_func_<T, const sierra::String &> stk_classic::diag::c_ptr_name ( const T *  t)

Template function c_ptr_name implements c_ptr_func with the function 'name'.

Parameters
ta T pointer to an object that is call the name member function.
Returns
a c_ptr_func_ object which contains a member function pointer to name();

Definition at line 719 of file WriterExt.hpp.

◆ dump() [13/20]

template<class T >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::Mapv_no_delete< T > &  t 
)

Template function dump writes a Mapv_no_delete object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the Mapv_no_delete to.
ta sierra::String const reference to the Mapv_no_delete to write.
Returns
a Writer reference to this object

Definition at line 812 of file WriterExt.hpp.

◆ dump() [14/20]

template<class Key , class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::vecmap< Key, T, U > &  t 
)

Template function dump writes the vecmap object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecmap to.
ta vecmap const reference to the vecmap.
Returns
a Writer reference to this object

Definition at line 842 of file WriterExt.hpp.

◆ dump() [15/20]

template<class Key , class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::vecmap< Key, T *, U > &  t 
)

Template function dump writes a vecmap of pointers object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecmap of pointers to.
ta vecmap const reference to the vecmap of pointers.
Returns
a Writer reference to this object

Definition at line 871 of file WriterExt.hpp.

◆ dump() [16/20]

template<class Key , class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::vecmap< Key *, T *, U > &  t 
)

Template function dump writes a vecmap of pointers object to the dignostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecmap of pointers to.
ta vecmap const reference to the vecmap of pointers.
Returns
a Writer reference to this object

Definition at line 900 of file WriterExt.hpp.

◆ dump() [17/20]

template<class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::vecset< T, U > &  t 
)

Template function dump writes a vecset object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecset to.
ta vecset const reference to the vecset.
Returns
a Writer reference to this object

Definition at line 929 of file WriterExt.hpp.

◆ dump() [18/20]

template<class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::vecset< T *, U > &  t 
)

Template function dump writes a vecset of pointers object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecset of pointers to.
ta vecset const reference to the vecset of pointers.
Returns
a Writer reference to this object

Definition at line 959 of file WriterExt.hpp.

◆ dump() [19/20]

template<class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::MapvNode< T, U > &  t 
)

Template dump writes a MapvNode object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the Mapvnod to.
ta MapvNode const reference to the MapvNode to write.
Returns
a Writer reference to this object

Definition at line 988 of file WriterExt.hpp.

◆ dump() [20/20]

template<class T , class U >
Writer& stk_classic::diag::dump ( Writer dout,
const sierra::Mapv< T, U > &  t 
)

Template function dump writes a Mapv object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the Mapv to.
ta std::vector const reference to the Mapv to write.
Returns
a Writer reference to this object

Definition at line 1011 of file WriterExt.hpp.

◆ operator<<() [21/29]

template<class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::vecset< T, U > &  t 
)

Member function operator<< writer a vecset object the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecset to.
ta vecset const reference to the vecset.
Returns
a Writer reference to this object

Definition at line 1040 of file WriterExt.hpp.

◆ operator<<() [22/29]

template<class Key , class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::vecmap< Key, T, U > &  t 
)

Template function operator<< writes the vecmap object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecmap to.
ta vecmap const reference to the vecmap.
Returns
a Writer reference to this object

Definition at line 1056 of file WriterExt.hpp.

◆ operator<<() [23/29]

template<class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::vecset< T *, U > &  t 
)

Member function operator<< writes a vecset of pointers object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecset of pointers to.
ta vecset const reference to the vecset of pointers.
Returns
a Writer reference to this object

Definition at line 1072 of file WriterExt.hpp.

◆ operator<<() [24/29]

template<class Key , class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::vecmap< Key *, T *, U > &  t 
)

Template function operator<< writea a vecmap of pointers with key pointers object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecmap of pointers to.
ta vecmap const reference to the vecmap of pointers.
Returns
a Writer reference to this object

Definition at line 1088 of file WriterExt.hpp.

◆ operator<<() [25/29]

template<class T >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::Mapv_no_delete< T > &  t 
)

Template function operator<< writes a Mpav_no_delete object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the Mapv_no_delete to.
ta vecmap const reference to the Mapv_no_delete.
Returns
a Writer reference to this object

Definition at line 1104 of file WriterExt.hpp.

◆ operator<<() [26/29]

template<class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::Mapv< T, U > &  t 
)

Member function operator<< writes a Mapv object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the Mapv to.
ta vecmap const reference to the Mapv.
Returns
a Writer reference to this object

Definition at line 1120 of file WriterExt.hpp.

◆ operator<<() [27/29]

template<class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::MapvNode< T, U > &  t 
)

Template function operator<< writes a MapvNode object to the diagnostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the MapvNode to.
ta MapvNode const reference to the MapvNode.
Returns
a Writer reference to this object

Definition at line 1136 of file WriterExt.hpp.

◆ operator<<() [28/29]

template<class Key , class T , class U >
Writer& stk_classic::diag::operator<< ( Writer dout,
const sierra::vecmap< Key, T *, U > &  t 
)

Template function operator<< writes a vecmap of pointers object to the dignostic writer.

Parameters
douta Writer reference to the diagnostic writer to write the vecmap of pointers to.
ta vecmap const reference to the vecmap of pointers.
Returns
a Writer reference to this object

Definition at line 1152 of file WriterExt.hpp.

◆ setw()

_setw stk_classic::diag::setw ( int  width)
inline

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

Parameters
widtha int value for the width of the next field.

Definition at line 44 of file WriterManip.hpp.

◆ setprecision()

_setprecision stk_classic::diag::setprecision ( int  precision)
inline

Function setprecision sets the numeric precision as a manipulator.

Parameters
precisiona int value of the precision.

Definition at line 70 of file WriterManip.hpp.

◆ setfill()

_setfill stk_classic::diag::setfill ( char  fill)
inline

Function setfill sets the fill character as a manipulator.

Parameters
filla char value of the fill character.

Definition at line 96 of file WriterManip.hpp.

◆ setiosflags()

_setiosflags stk_classic::diag::setiosflags ( std::ios_base::fmtflags  flags)
inline

Function setiosflags sets the ios flags as a manipulator.

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

Definition at line 122 of file WriterManip.hpp.

◆ resetiosflags()

_resetiosflags stk_classic::diag::resetiosflags ( std::ios_base::fmtflags  flags)
inline

Function resetiosflags clears the ios flags as a manipulator.

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

Definition at line 148 of file WriterManip.hpp.

◆ operator<<() [29/29]

template<class T >
Writer& stk_classic::diag::operator<< ( Writer dout,
const T &  t 
)

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
douta Writer reference to the writer to put to.
ta T const reference to the object to put.

Definition at line 34 of file WriterOStream.hpp.