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

Search Toolkit Book for CComments

#include "comments.hpp"
(Private to src/serial/datatool.)

Public Types

enum  {
  eAlwaysMultiline = 1 , eDoNotWriteBlankLine = 2 , eNoEOL = 4 , eOneLine = eDoNotWriteBlankLine | eNoEOL ,
  eMultiline = eDoNotWriteBlankLine | eAlwaysMultiline
}
 

Public Member Functions

 CComments (void)
 
 ~CComments (void)
 
CCommentsoperator= (const CComments &other)
 
void Add (const string &s)
 
bool Empty (void) const
 
bool OneLine (void) const
 
CNcbiOstreamPrint (CNcbiOstream &out, const string &before, const string &between, const string &after) const
 
bool PrintSchemaComments (CNcbiOstream &out, int indent, int flags=0) const
 
CNcbiOstreamPrintDTD (CNcbiOstream &out, int flags=0) const
 
CNcbiOstreamPrintASN (CNcbiOstream &out, int indent, int flags=0) const
 
CNcbiOstreamPrintHPPEnum (CNcbiOstream &out) const
 
CNcbiOstreamPrintHPPClass (CNcbiOstream &out) const
 
CNcbiOstreamPrintHPPMember (CNcbiOstream &out) const
 

Private Types

typedef list< stringTComments
 

Private Attributes

TComments m_Comments
 

Detailed Description

Definition at line 43 of file comments.hpp.

Member Typedef Documentation

◆ TComments

typedef list<string> CComments::TComments
private

Definition at line 75 of file comments.hpp.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
eAlwaysMultiline 
eDoNotWriteBlankLine 
eNoEOL 
eOneLine 
eMultiline 

Definition at line 52 of file comments.hpp.

Constructor & Destructor Documentation

◆ CComments()

CComments::CComments ( void  )

Definition at line 41 of file comments.cpp.

◆ ~CComments()

CComments::~CComments ( void  )

Definition at line 45 of file comments.cpp.

Member Function Documentation

◆ Add()

void CComments::Add ( const string s)

◆ Empty()

bool CComments::Empty ( void  ) const
inline

◆ OneLine()

bool CComments::OneLine ( void  ) const
inline

Definition at line 95 of file comments.hpp.

References m_Comments, and SizeIsOne().

◆ operator=()

CComments & CComments::operator= ( const CComments other)

Definition at line 49 of file comments.cpp.

References m_Comments.

◆ Print()

CNcbiOstream & CComments::Print ( CNcbiOstream out,
const string before,
const string between,
const string after 
) const

Definition at line 60 of file comments.cpp.

References i, ITERATE, m_Comments, and out().

Referenced by XSDParser::ParseTypeDefinition(), PrintHPPClass(), PrintHPPEnum(), and PrintHPPMember().

◆ PrintASN()

CNcbiOstream & CComments::PrintASN ( CNcbiOstream out,
int  indent,
int  flags = 0 
) const

◆ PrintDTD()

CNcbiOstream & CComments::PrintDTD ( CNcbiOstream out,
int  flags = 0 
) const

◆ PrintHPPClass()

CNcbiOstream & CComments::PrintHPPClass ( CNcbiOstream out) const

Definition at line 81 of file comments.cpp.

References Empty(), out(), and Print().

Referenced by CTypeStrings::BeginClassDeclaration(), and CTypeStrings::PrintHPPComments().

◆ PrintHPPEnum()

CNcbiOstream & CComments::PrintHPPEnum ( CNcbiOstream out) const

Definition at line 76 of file comments.cpp.

References Empty(), kEmptyStr, out(), and Print().

Referenced by CChoiceTypeStrings::GenerateClassCode().

◆ PrintHPPMember()

CNcbiOstream & CComments::PrintHPPMember ( CNcbiOstream out) const

Definition at line 86 of file comments.cpp.

References Empty(), out(), and Print().

◆ PrintSchemaComments()

bool CComments::PrintSchemaComments ( CNcbiOstream out,
int  indent,
int  flags = 0 
) const

Definition at line 91 of file comments.cpp.

References Empty(), and n.

Referenced by CStaticDataType::PrintXMLSchemaContents().

Member Data Documentation

◆ m_Comments

TComments CComments::m_Comments
private

Definition at line 77 of file comments.hpp.

Referenced by Add(), Empty(), OneLine(), operator=(), and Print().


The documentation for this class was generated from the following files:
Modified on Fri Jul 12 16:21:49 2024 by modify_doxy.py rev. 669887