NCBI C++ ToolKit
|
Search Toolkit Book for IFormatter
#include <objtools/format/formatter.hpp>
Public Member Functions | |
virtual void | Start (IFlatTextOStream &text_os)=0 |
virtual void | StartSection (const CStartSectionItem &ssec, IFlatTextOStream &text_os)=0 |
virtual void | EndSection (const CEndSectionItem &esec, IFlatTextOStream &text_os)=0 |
virtual void | End (IFlatTextOStream &text_os)=0 |
virtual void | Format (const IFlatItem &item, IFlatTextOStream &text_os)=0 |
virtual void | FormatLocus (const CLocusItem &locus, IFlatTextOStream &text_os)=0 |
virtual void | FormatDefline (const CDeflineItem &defline, IFlatTextOStream &text_os)=0 |
virtual void | FormatAccession (const CAccessionItem &acc, IFlatTextOStream &text_os)=0 |
virtual void | FormatVersion (const CVersionItem &version, IFlatTextOStream &text_os)=0 |
virtual void | FormatKeywords (const CKeywordsItem &keys, IFlatTextOStream &text_os)=0 |
virtual void | FormatSource (const CSourceItem &keys, IFlatTextOStream &text_os)=0 |
virtual void | FormatReference (const CReferenceItem &keys, IFlatTextOStream &text_os)=0 |
virtual void | FormatCache (const CCacheItem &csh, IFlatTextOStream &text_os)=0 |
virtual void | FormatComment (const CCommentItem &comment, IFlatTextOStream &text_os)=0 |
virtual void | FormatBasecount (const CBaseCountItem &bc, IFlatTextOStream &text_os)=0 |
virtual void | FormatSequence (const CSequenceItem &seq, IFlatTextOStream &text_os)=0 |
virtual void | FormatFeatHeader (const CFeatHeaderItem &fh, IFlatTextOStream &text_os)=0 |
virtual void | FormatFeature (const CFeatureItemBase &feat, IFlatTextOStream &text_os)=0 |
virtual void | FormatAlignment (const CAlignmentItem &aln, IFlatTextOStream &text_os)=0 |
virtual void | FormatSegment (const CSegmentItem &seg, IFlatTextOStream &text_os)=0 |
virtual void | FormatDate (const CDateItem &date, IFlatTextOStream &text_os)=0 |
virtual void | FormatDBSource (const CDBSourceItem &dbs, IFlatTextOStream &text_os)=0 |
virtual void | FormatPrimary (const CPrimaryItem &prim, IFlatTextOStream &text_os)=0 |
virtual void | FormatContig (const CContigItem &contig, IFlatTextOStream &text_os)=0 |
virtual void | FormatWGS (const CWGSItem &wgs, IFlatTextOStream &text_os)=0 |
virtual void | FormatTSA (const CTSAItem &wgs, IFlatTextOStream &text_os)=0 |
virtual void | FormatGenome (const CGenomeItem &genome, IFlatTextOStream &text_os)=0 |
virtual void | FormatOrigin (const COriginItem &origin, IFlatTextOStream &text_os)=0 |
virtual void | FormatGap (const CGapItem &gap, IFlatTextOStream &text_os)=0 |
virtual void | FormatGenomeProject (const CGenomeProjectItem &, IFlatTextOStream &) |
virtual void | FormatHtmlAnchor (const CHtmlAnchorItem &, IFlatTextOStream &) |
virtual | ~IFormatter (void) |
![]() | |
CObject (void) | |
Constructor. More... | |
CObject (const CObject &src) | |
Copy constructor. More... | |
virtual | ~CObject (void) |
Destructor. More... | |
CObject & | operator= (const CObject &src) THROWS_NONE |
Assignment operator. More... | |
bool | CanBeDeleted (void) const THROWS_NONE |
Check if object can be deleted. More... | |
bool | IsAllocatedInPool (void) const THROWS_NONE |
Check if object is allocated in memory pool (not system heap) More... | |
bool | Referenced (void) const THROWS_NONE |
Check if object is referenced. More... | |
bool | ReferencedOnlyOnce (void) const THROWS_NONE |
Check if object is referenced only once. More... | |
void | AddReference (void) const |
Add reference to object. More... | |
void | RemoveReference (void) const |
Remove reference to object. More... | |
void | ReleaseReference (void) const |
Remove reference without deleting object. More... | |
virtual void | DoNotDeleteThisObject (void) |
Mark this object as not allocated in heap – do not delete this object. More... | |
virtual void | DoDeleteThisObject (void) |
Mark this object as allocated in heap – object can be deleted. More... | |
void * | operator new (size_t size) |
Define new operator for memory allocation. More... | |
void * | operator new[] (size_t size) |
Define new[] operator for 'array' memory allocation. More... | |
void | operator delete (void *ptr) |
Define delete operator for memory deallocation. More... | |
void | operator delete[] (void *ptr) |
Define delete[] operator for memory deallocation. More... | |
void * | operator new (size_t size, void *place) |
Define new operator. More... | |
void | operator delete (void *ptr, void *place) |
Define delete operator. More... | |
void * | operator new (size_t size, CObjectMemoryPool *place) |
Define new operator using memory pool. More... | |
void | operator delete (void *ptr, CObjectMemoryPool *place) |
Define delete operator. More... | |
virtual void | DebugDump (CDebugDumpContext ddc, unsigned int depth) const |
Define method for dumping debug information. More... | |
![]() | |
CDebugDumpable (void) | |
virtual | ~CDebugDumpable (void) |
void | DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const |
void | DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const |
void | DumpToConsole (void) const |
Additional Inherited Members | |
![]() | |
enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
Control filling of newly allocated memory. More... | |
typedef CObjectCounterLocker | TLockerType |
Default locker type for CRef. More... | |
typedef atomic< Uint8 > | TCounter |
Counter type is CAtomiCounter. More... | |
typedef Uint8 | TCount |
Alias for value type of counter. More... | |
![]() | |
static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (void) |
Define method to throw null pointer exception. More... | |
static NCBI_XNCBI_EXPORT void | ThrowNullPointerException (const type_info &type) |
static EAllocFillMode | GetAllocFillMode (void) |
static void | SetAllocFillMode (EAllocFillMode mode) |
static void | SetAllocFillMode (const string &value) |
Set mode from configuration parameter value. More... | |
![]() | |
static void | EnableDebugDump (bool on) |
![]() | |
static const TCount | eCounterBitsCanBeDeleted = 1 << 0 |
Define possible object states. More... | |
static const TCount | eCounterBitsInPlainHeap = 1 << 1 |
Heap signature was found. More... | |
static const TCount | eCounterBitsPlaceMask |
Mask for 'in heap' state flags. More... | |
static const int | eCounterStep = 1 << 2 |
Skip over the "in heap" bits. More... | |
static const TCount | eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2) |
Minimal value for valid objects (reference counter is zero) Must be a single bit value. More... | |
static const TCount | eCounterStateMask |
Valid object, and object in heap. More... | |
![]() | |
virtual void | DeleteThis (void) |
Virtual method "deleting" this object. More... | |
Definition at line 77 of file formatter.hpp.
|
inlinevirtual |
Definition at line 117 of file formatter.hpp.
|
pure virtual |
Implemented in CFlatItemFormatter, and CGBSeqFormatter.
|
pure virtual |
Implemented in CGenbankFormatter, CEmblFormatter, CFlatItemFormatter, and CGBSeqFormatter.
|
pure virtual |
Implemented in CFlatItemFormatter.
Referenced by CFormatItemOStream::AddItem().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CAccessionItem::Format().
|
pure virtual |
Implemented in CFlatItemFormatter.
Referenced by CAlignmentItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CBaseCountItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CCacheItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CCommentItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, and CFlatItemFormatter.
Referenced by CContigItem::Format().
|
pure virtual |
Implemented in CEmblFormatter, and CFlatItemFormatter.
Referenced by CDateItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, and CFlatItemFormatter.
Referenced by CDBSourceItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CDeflineItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CFtableFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CFeatHeaderItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CFtableFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CFeatureItemBase::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, and CFlatItemFormatter.
Referenced by CGapItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, and CFlatItemFormatter.
Referenced by CGenomeItem::Format().
|
inlinevirtual |
Reimplemented in CFlatItemFormatter, CGenbankFormatter, and CGBSeqFormatter.
Definition at line 114 of file formatter.hpp.
Referenced by CGenomeProjectItem::Format().
|
inlinevirtual |
Reimplemented in CGenbankFormatter.
Definition at line 115 of file formatter.hpp.
Referenced by CHtmlAnchorItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CKeywordsItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CLocusItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, and CFlatItemFormatter.
Referenced by COriginItem::Format().
|
pure virtual |
Implemented in CGBSeqFormatter, CGenbankFormatter, and CFlatItemFormatter.
Referenced by CPrimaryItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CFtableFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CReferenceItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, and CFlatItemFormatter.
Referenced by CSegmentItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CSequenceItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CSourceItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, and CFlatItemFormatter.
Referenced by CTSAItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, CEmblFormatter, and CFlatItemFormatter.
Referenced by CVersionItem::Format().
|
pure virtual |
Implemented in CGenbankFormatter, CGBSeqFormatter, and CFlatItemFormatter.
Referenced by CWGSItem::Format().
|
pure virtual |
Implemented in CFlatItemFormatter, and CGBSeqFormatter.
|
pure virtual |
Implemented in CFlatItemFormatter, and CGBSeqFormatter.