NCBI C++ ToolKit: CTable2AsnStructuredCommentsReader Class Reference

NCBI C++ ToolKit

Search Toolkit Book for CTable2AsnStructuredCommentsReader

#include "struc_cmt_reader.hpp"
(Private to src/app/table2asn.)

Inheritance diagram for CTable2AsnStructuredCommentsReader:

Collaboration diagram for CTable2AsnStructuredCommentsReader:

Public Member Functions
	CTable2AsnStructuredCommentsReader (const std::string &filename, objects::ILineErrorListener *logger, bool verbose)

	~CTable2AsnStructuredCommentsReader ()

void	ProcessComments (objects::CSeq_entry &entry) const

Public Member Functions inherited from CStructuredCommentsReader
	CStructuredCommentsReader (objects::ILineErrorListener *logger)

	~CStructuredCommentsReader ()

template<typename _container >
size_t	LoadComments (ILineReader &reader, _container &cont, objects::CSeq_id::TParseFlags seqid_flags=objects::CSeq_id::fParse_Default)

size_t	LoadCommentsByRow (ILineReader &reader, CStructComment &cmt)

Static Private Member Functions
static bool	IsVertical (ILineReader &reader)

static bool	_AddStructuredComments (objects::CSeq_entry &entry, const CStructComment &comments)

static void	_AddStructuredComments (objects::CSeq_descr &descr, const CStructComment &comments)

static void	_CheckStructuredCommentsSuffix (CStructComment &comments)

Private Attributes
list< CStructComment >	m_comments

bool	m_vertical = false

bool	m_verbose = false

Additional Inherited Members
Static Public Member Functions inherited from CStructuredCommentsReader
static bool	SeqIdMatchesCommentId (const objects::CSeq_id &seqID, const objects::CSeq_id &commentID)

Protected Member Functions inherited from CStructuredCommentsReader
void	_LoadHeaderLine (ILineReader &reader, vector< string > &cols)

void	_BuildStructuredComment (CStructComment &cmt, const vector< string > &cols, const vector< CTempString > &values)

objects::CUser_object *	_AddStructuredComment (objects::CUser_object *user_obj, CStructComment &cmt, const CTempString &name, const CTempString &value)

Protected Attributes inherited from CStructuredCommentsReader
objects::ILineErrorListener *	m_logger

Detailed Description

Definition at line 24 of file struc_cmt_reader.hpp.

Constructor & Destructor Documentation

◆ CTable2AsnStructuredCommentsReader()

CTable2AsnStructuredCommentsReader::CTable2AsnStructuredCommentsReader	(	const std::string &	filename,
		objects::ILineErrorListener *	logger,
		bool	verbose
	)

Definition at line 90 of file struc_cmt_reader.cpp.

References _CheckStructuredCommentsSuffix(), CSeq_id::fParse_AnyLocal, IsVertical(), CStructuredCommentsReader::LoadComments(), CStructuredCommentsReader::LoadCommentsByRow(), m_comments, m_vertical, and ILineReader::New().

◆ ~CTable2AsnStructuredCommentsReader()

CTable2AsnStructuredCommentsReader::~CTable2AsnStructuredCommentsReader ( )

Definition at line 108 of file struc_cmt_reader.cpp.

Member Function Documentation

◆ _AddStructuredComments() [1/2]

static void CTable2AsnStructuredCommentsReader::_AddStructuredComments	(	objects::CSeq_descr &	descr,
		const CStructComment &	comments
	)

staticprivate

◆ _AddStructuredComments() [2/2]

static bool CTable2AsnStructuredCommentsReader::_AddStructuredComments	(	objects::CSeq_entry &	entry,
		const CStructComment &	comments
	)

staticprivate

Referenced by ProcessComments().

◆ _CheckStructuredCommentsSuffix()

void CTable2AsnStructuredCommentsReader::_CheckStructuredCommentsSuffix ( CStructComment & comments )

staticprivate

Definition at line 213 of file struc_cmt_reader.cpp.

References data, label, CStructuredCommentsReader::CStructComment::m_descs, prefix, and suffix.

Referenced by CTable2AsnStructuredCommentsReader().

◆ IsVertical()

bool CTable2AsnStructuredCommentsReader::IsVertical ( ILineReader & reader )

staticprivate

Definition at line 236 of file struc_cmt_reader.cpp.

References ILineReader::AtEOF(), ILineReader::GetCurrentLine(), ILineReader::ReadLine(), NStr::Split(), and ILineReader::UngetLine().

Referenced by CTable2AsnStructuredCommentsReader().

◆ ProcessComments()

void CTable2AsnStructuredCommentsReader::ProcessComments ( objects::CSeq_entry & entry ) const

Definition at line 112 of file struc_cmt_reader.cpp.

References _AddStructuredComments(), set< Key, Compare >::end(), set< Key, Compare >::find(), set< Key, Compare >::insert(), CBioseq::IsNa(), m_comments, CStructuredCommentsReader::m_logger, m_verbose, m_vertical, sReportUnappliedStructuredComment(), and objects::VisitAllSeqDesc().

Member Data Documentation

◆ m_comments

list<CStructComment> CTable2AsnStructuredCommentsReader::m_comments

private

Definition at line 49 of file struc_cmt_reader.hpp.

Referenced by CTable2AsnStructuredCommentsReader(), and ProcessComments().

◆ m_verbose

bool CTable2AsnStructuredCommentsReader::m_verbose = false

private

Definition at line 51 of file struc_cmt_reader.hpp.

Referenced by ProcessComments().

◆ m_vertical

bool CTable2AsnStructuredCommentsReader::m_vertical = false

private

Definition at line 50 of file struc_cmt_reader.hpp.

Referenced by CTable2AsnStructuredCommentsReader(), and ProcessComments().

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

src/app/table2asn/struc_cmt_reader.hpp
src/app/table2asn/struc_cmt_reader.cpp

Modified on Tue May 28 05:51:45 2024 by modify_doxy.py rev. 669887