NCBI C++ ToolKit
Public Member Functions | Private Member Functions | Private Attributes | List of all members
CDebugDumpContext Class Reference

Search Toolkit Book for CDebugDumpContext

#include <corelib/ddumpable.hpp>

+ Collaboration diagram for CDebugDumpContext:

Public Member Functions

 CDebugDumpContext (CDebugDumpFormatter &formatter, const string &bundle)
 
 CDebugDumpContext (CDebugDumpContext &ddc)
 
 CDebugDumpContext (CDebugDumpContext &ddc, const string &bundle)
 
virtual ~CDebugDumpContext (void)
 
void SetFrame (const string &frame)
 
void Log (const string &name, const char *value, CDebugDumpFormatter::EValueType type=CDebugDumpFormatter::eValue, const string &comment=kEmptyStr)
 
void Log (const string &name, const string &value, CDebugDumpFormatter::EValueType type=CDebugDumpFormatter::eValue, const string &comment=kEmptyStr)
 
void Log (const string &name, bool value, const string &comment=kEmptyStr)
 
void Log (const string &name, short value, const string &comment=kEmptyStr)
 
void Log (const string &name, unsigned short value, const string &comment=kEmptyStr)
 
void Log (const string &name, int value, const string &comment=kEmptyStr)
 
void Log (const string &name, unsigned int value, const string &comment=kEmptyStr)
 
void Log (const string &name, long value, const string &comment=kEmptyStr)
 
void Log (const string &name, unsigned long value, const string &comment=kEmptyStr)
 
void Log (const string &name, Int8 value, const string &comment=kEmptyStr)
 
void Log (const string &name, Uint8 value, const string &comment=kEmptyStr)
 
void Log (const string &name, double value, const string &comment=kEmptyStr)
 
void Log (const string &name, const void *value, const string &comment=kEmptyStr)
 
void Log (const string &name, const CDebugDumpable *value, unsigned int depth)
 

Private Member Functions

void x_VerifyFrameStarted (void)
 
void x_VerifyFrameEnded (void)
 

Private Attributes

CDebugDumpContext & m_Parent
 
CDebugDumpFormatter & m_Formatter
 
unsigned int m_Level
 
bool m_Start_Bundle
 
string m_Title
 
bool m_Started
 

Detailed Description

Definition at line 71 of file ddumpable.hpp.

Constructor & Destructor Documentation

◆ CDebugDumpContext() [1/3]

CDebugDumpContext::CDebugDumpContext ( CDebugDumpFormatter &  formatter,
const string &  bundle 
)

Definition at line 88 of file ddumpable.cpp.

References m_Level, m_Start_Bundle, and m_Started.

◆ CDebugDumpContext() [2/3]

CDebugDumpContext::CDebugDumpContext ( CDebugDumpContext &  ddc)

Definition at line 100 of file ddumpable.cpp.

References m_Level, m_Parent, m_Start_Bundle, m_Started, and x_VerifyFrameStarted().

◆ CDebugDumpContext() [3/3]

CDebugDumpContext::CDebugDumpContext ( CDebugDumpContext &  ddc,
const string &  bundle 
)

Definition at line 111 of file ddumpable.cpp.

References m_Level, m_Parent, m_Start_Bundle, m_Started, and x_VerifyFrameStarted().

◆ ~CDebugDumpContext()

CDebugDumpContext::~CDebugDumpContext ( void  )
virtual

Definition at line 124 of file ddumpable.cpp.

References m_Level, m_Parent, x_VerifyFrameEnded(), and x_VerifyFrameStarted().

Member Function Documentation

◆ Log() [1/14]

void CDebugDumpContext::Log ( const string &  name,
bool  value,
const string &  comment = kEmptyStr 
)

Definition at line 172 of file ddumpable.cpp.

References NStr::BoolToString(), CDebugDumpFormatter::eValue, Log(), and rapidjson::value.

◆ Log() [2/14]

void CDebugDumpContext::Log ( const string &  name,
const CDebugDumpable *  value,
unsigned int  depth 
)

Definition at line 251 of file ddumpable.cpp.

References depth, CDebugDumpFormatter::ePointer, Log(), NStr::PtrToString(), and rapidjson::value.

◆ Log() [3/14]

void CDebugDumpContext::Log ( const string &  name,
const char *  value,
CDebugDumpFormatter::EValueType  type = CDebugDumpFormatter::eValue,
const string &  comment = kEmptyStr 
)

Definition at line 151 of file ddumpable.cpp.

References kEmptyStr, and rapidjson::value.

Referenced by CBLAST_SequenceBlk::DebugDump(), CBlastQueryInfo::DebugDump(), CQuerySetUpOptions::DebugDump(), CLookupTableOptions::DebugDump(), CBlastInitialWordOptions::DebugDump(), CBlastExtensionOptions::DebugDump(), CBlastExtensionParameters::DebugDump(), CBlastHitSavingOptions::DebugDump(), CPSIBlastOptions::DebugDump(), CBlastScoreBlk::DebugDump(), CBlastScoringOptions::DebugDump(), CBlastScoringParameters::DebugDump(), CBlastEffectiveLengthsOptions::DebugDump(), CBlastEffectiveLengthsParameters::DebugDump(), CBlastHSPResults::DebugDump(), CPSIMsa::DebugDump(), CPSIMatrix::DebugDump(), CPSIDiagnosticsRequest::DebugDump(), CPSIDiagnosticsResponse::DebugDump(), CBlastSeqSrcIterator::DebugDump(), CBlast_Message::DebugDump(), CBlastMaskLoc::DebugDump(), CBlastSeqLoc::DebugDump(), CSBlastProgress::DebugDump(), CObject::DebugDump(), CProSplignParams::DebugDump(), CSplignParams::DebugDump(), CSeqDB::DebugDump(), CSerialObject::DebugDump(), CSeqDBAliasFile::DebugDump(), CSeqDB_BitSet::DebugDump(), CSeqDB_AliasMask::DebugDump(), CSeqDBImpl::DebugDump(), CSeqDBOIDList::DebugDump(), DebugDumpPairsCRefCRef(), DebugDumpPairsPtrCRef(), DebugDumpPairsPtrPtr(), DebugDumpPairsValuePtr(), DebugDumpRangeCRef(), DebugDumpRangeObj(), DebugDumpRangePtr(), DebugDumpValue(), and Log().

◆ Log() [4/14]

void CDebugDumpContext::Log ( const string &  name,
const string &  value,
CDebugDumpFormatter::EValueType  type = CDebugDumpFormatter::eValue,
const string &  comment = kEmptyStr 
)

Definition at line 160 of file ddumpable.cpp.

References m_Formatter, m_Level, m_Started, CDebugDumpFormatter::PutValue(), rapidjson::value, and x_VerifyFrameStarted().

◆ Log() [5/14]

void CDebugDumpContext::Log ( const string &  name,
const void *  value,
const string &  comment = kEmptyStr 
)

Definition at line 244 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, Log(), NStr::PtrToString(), and rapidjson::value.

◆ Log() [6/14]

void CDebugDumpContext::Log ( const string &  name,
double  value,
const string &  comment = kEmptyStr 
)

Definition at line 236 of file ddumpable.cpp.

References NStr::DoubleToString(), CDebugDumpFormatter::eValue, Log(), and rapidjson::value.

◆ Log() [7/14]

void CDebugDumpContext::Log ( const string &  name,
int  value,
const string &  comment = kEmptyStr 
)

Definition at line 193 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, NStr::IntToString(), Log(), and rapidjson::value.

◆ Log() [8/14]

void CDebugDumpContext::Log ( const string &  name,
Int8  value,
const string &  comment = kEmptyStr 
)

Definition at line 221 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, NStr::Int8ToString(), Log(), and rapidjson::value.

◆ Log() [9/14]

void CDebugDumpContext::Log ( const string &  name,
long  value,
const string &  comment = kEmptyStr 
)

Definition at line 207 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, Log(), NStr::LongToString(), and rapidjson::value.

◆ Log() [10/14]

void CDebugDumpContext::Log ( const string &  name,
short  value,
const string &  comment = kEmptyStr 
)

Definition at line 179 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, NStr::IntToString(), Log(), and rapidjson::value.

◆ Log() [11/14]

void CDebugDumpContext::Log ( const string &  name,
Uint8  value,
const string &  comment = kEmptyStr 
)

Definition at line 228 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, Log(), NStr::UInt8ToString(), and rapidjson::value.

◆ Log() [12/14]

void CDebugDumpContext::Log ( const string &  name,
unsigned int  value,
const string &  comment = kEmptyStr 
)

Definition at line 200 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, Log(), NStr::UIntToString(), and rapidjson::value.

◆ Log() [13/14]

void CDebugDumpContext::Log ( const string &  name,
unsigned long  value,
const string &  comment = kEmptyStr 
)

Definition at line 214 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, Log(), NStr::ULongToString(), and rapidjson::value.

◆ Log() [14/14]

void CDebugDumpContext::Log ( const string &  name,
unsigned short  value,
const string &  comment = kEmptyStr 
)

Definition at line 186 of file ddumpable.cpp.

References CDebugDumpFormatter::eValue, Log(), NStr::UIntToString(), and rapidjson::value.

◆ SetFrame()

void CDebugDumpContext::SetFrame ( const string &  frame)

Definition at line 137 of file ddumpable.cpp.

References m_Formatter, m_Level, m_Start_Bundle, m_Started, m_Title, CDebugDumpFormatter::StartBundle(), and CDebugDumpFormatter::StartFrame().

Referenced by CBLAST_SequenceBlk::DebugDump(), CBlastQueryInfo::DebugDump(), CQuerySetUpOptions::DebugDump(), CLookupTableOptions::DebugDump(), CLookupTableWrap::DebugDump(), CBlastInitialWordOptions::DebugDump(), CBlastInitialWordParameters::DebugDump(), CBlast_ExtendWord::DebugDump(), CBlastExtensionOptions::DebugDump(), CBlastExtensionParameters::DebugDump(), CBlastHitSavingOptions::DebugDump(), CBlastHitSavingParameters::DebugDump(), CPSIBlastOptions::DebugDump(), CBlastDatabaseOptions::DebugDump(), CBlastScoreBlk::DebugDump(), CBlastScoringOptions::DebugDump(), CBlastScoringParameters::DebugDump(), CBlastEffectiveLengthsOptions::DebugDump(), CBlastEffectiveLengthsParameters::DebugDump(), CBlastGapAlignStruct::DebugDump(), CBlastHSPResults::DebugDump(), CPSIMsa::DebugDump(), CPSIMatrix::DebugDump(), CPSIDiagnosticsRequest::DebugDump(), CPSIDiagnosticsResponse::DebugDump(), CBlastSeqSrc::DebugDump(), CBlastSeqSrcIterator::DebugDump(), CBlast_Message::DebugDump(), CBlastMaskLoc::DebugDump(), CBlastSeqLoc::DebugDump(), CSBlastProgress::DebugDump(), CObject::DebugDump(), CProSplignParams::DebugDump(), CSplignParams::DebugDump(), CSeqDB::DebugDump(), CBlastDbDataLoader::DebugDump(), CRemoteBlastDbDataLoader::DebugDump(), CSerialObject::DebugDump(), CBlastOptionsLocal::DebugDump(), CSeqDBAliasFile::DebugDump(), CSeqDB_BitSet::DebugDump(), CSeqDB_AliasMask::DebugDump(), CSeqDBImpl::DebugDump(), CSeqDBOIDList::DebugDump(), and x_VerifyFrameStarted().

◆ x_VerifyFrameEnded()

void CDebugDumpContext::x_VerifyFrameEnded ( void  )
private

Definition at line 270 of file ddumpable.cpp.

References CDebugDumpFormatter::EndBundle(), CDebugDumpFormatter::EndFrame(), m_Formatter, m_Level, m_Start_Bundle, m_Started, and m_Title.

Referenced by ~CDebugDumpContext().

◆ x_VerifyFrameStarted()

void CDebugDumpContext::x_VerifyFrameStarted ( void  )
private

Definition at line 264 of file ddumpable.cpp.

References m_Title, and SetFrame().

Referenced by CDebugDumpContext(), Log(), and ~CDebugDumpContext().

Member Data Documentation

◆ m_Formatter

CDebugDumpFormatter& CDebugDumpContext::m_Formatter
private

Definition at line 127 of file ddumpable.hpp.

Referenced by Log(), SetFrame(), and x_VerifyFrameEnded().

◆ m_Level

unsigned int CDebugDumpContext::m_Level
private

Definition at line 128 of file ddumpable.hpp.

Referenced by CDebugDumpContext(), Log(), SetFrame(), x_VerifyFrameEnded(), and ~CDebugDumpContext().

◆ m_Parent

CDebugDumpContext& CDebugDumpContext::m_Parent
private

Definition at line 126 of file ddumpable.hpp.

Referenced by CDebugDumpContext(), and ~CDebugDumpContext().

◆ m_Start_Bundle

bool CDebugDumpContext::m_Start_Bundle
private

Definition at line 129 of file ddumpable.hpp.

Referenced by CDebugDumpContext(), SetFrame(), and x_VerifyFrameEnded().

◆ m_Started

bool CDebugDumpContext::m_Started
private

Definition at line 131 of file ddumpable.hpp.

Referenced by CDebugDumpContext(), Log(), SetFrame(), and x_VerifyFrameEnded().

◆ m_Title

string CDebugDumpContext::m_Title
private

Definition at line 130 of file ddumpable.hpp.

Referenced by SetFrame(), x_VerifyFrameEnded(), and x_VerifyFrameStarted().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Fri Sep 20 14:58:23 2024 by modify_doxy.py rev. 669887