DebugStream Class Reference

Debug Stream class to output formatted math data. More...

#include <S2_Debug.h>

List of all members.

Standard ostream output operators and friend methods
DebugStream &	operator<< (const bool &val)
DebugStream &	operator<< (const short &val)
DebugStream &	operator<< (const unsigned short &val)
DebugStream &	operator<< (const int &val)
DebugStream &	operator<< (const unsigned int &val)
DebugStream &	operator<< (const long &val)
DebugStream &	operator<< (const unsigned long &val)
DebugStream &	operator<< (const float &val)
DebugStream &	operator<< (const double &val)
DebugStream &	operator<< (const long double &val)
DebugStream &	operator<< (const void *&val)
DebugStream &	operator<< (std::ostream &(*pf)(std::ostream &))
	Redefined to insert tabs for endl.
DebugStream &	operator<< (std::ios &(*pf)(std::ios &))
DebugStream &	operator<< (std::ios_base &(*pf)(std::ios_base &))
DebugStream &	operator<< (DebugStream &ds, char ch)
DebugStream &	operator<< (DebugStream &ds, signed char ch)
DebugStream &	operator<< (DebugStream &ds, unsigned char ch)
DebugStream &	operator<< (DebugStream &ds, const char *str)
DebugStream &	operator<< (DebugStream &ds, const signed char *str)
DebugStream &	operator<< (DebugStream &ds, const unsigned char *str)
Public Member Functions
	DebugStream (const char *file=NULL)
	~DebugStream ()
bool	Open (const char *file)
void	Close ()
bool	IsOpen ()
Nested sections management.
void	BeginSection (const char *title=NULL)
void	EndSection (const char *endtitle=NULL)
S2 types output operators.
DebugStream &	operator<< (const V3D &v)
DebugStream &	operator<< (const Quat &q)
DebugStream &	operator<< (const M3D &m)
Private Attributes
unsigned int	m_TabLevel
	Current level of indentation.
std::ofstream	m_Ofstream
	Internal ofstream used for actual output.

---

Detailed Description

Debug Stream class to output formatted math data.

The DebugStream class defines most of std::ostream output operators (and friend functions) and new ones for the Saphyre2 specific data types.

Uses an std::ofstream internally to do the final output on a file.

---

Constructor & Destructor Documentation

BEGIN_NAMESPACE_S2 DebugStream::DebugStream (  const char *  file = NULL  )

DebugStream::~DebugStream (   )

---

Member Function Documentation

void DebugStream::BeginSection (  const char *  title = NULL  )

void DebugStream::Close (   )

void DebugStream::EndSection (  const char *  endtitle = NULL  )

bool DebugStream::IsOpen (   )

bool DebugStream::Open (  const char *  file  )

DebugStream& DebugStream::operator<< (  std::ios_base &(*  pf)(std::ios_base &)  )  [inline]

DebugStream& DebugStream::operator<< (  std::ios &(*  pf)(std::ios &)  )  [inline]

DebugStream & DebugStream::operator<< (  std::ostream &(*  pf)(std::ostream &)  )

Redefined to insert tabs for endl. Captures std::endl calls and inserts current tabulation at the beginning of the next line.

DebugStream& DebugStream::operator<< (  const void *&  val  )  [inline]

DebugStream& DebugStream::operator<< (  const long double &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const double &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const float &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const unsigned long &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const long &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const unsigned int &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const int &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const unsigned short &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const short &  val  )  [inline]

DebugStream& DebugStream::operator<< (  const bool &  val  )  [inline]

DebugStream & DebugStream::operator<< (  const M3D &  m  )

DebugStream & DebugStream::operator<< (  const Quat &  q  )

DebugStream & DebugStream::operator<< (  const V3D &  v  )

---

Friends And Related Function Documentation

DebugStream& operator<< (  DebugStream &  ds, const unsigned char *  str )  [friend]

DebugStream& operator<< (  DebugStream &  ds, const signed char *  str )  [friend]

DebugStream& operator<< (  DebugStream &  ds, const char *  str )  [friend]

DebugStream& operator<< (  DebugStream &  ds, unsigned char  ch )  [friend]

DebugStream& operator<< (  DebugStream &  ds, signed char  ch )  [friend]

DebugStream& operator<< (  DebugStream &  ds, char  ch )  [friend]

---

Member Data Documentation

std::ofstream DebugStream::m_Ofstream [private]

Internal ofstream used for actual output.

unsigned int DebugStream::m_TabLevel [private]

Current level of indentation.

---

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

• S2_Debug.h
• S2_Debug.cpp

---