NCBI C++ ToolKit
Public Member Functions | List of all members
IFormatter Class Referenceabstract

Search Toolkit Book for IFormatter

#include <objtools/format/formatter.hpp>

+ Inheritance diagram for IFormatter:
+ Collaboration diagram for IFormatter:

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)
 
- Public Member Functions inherited from CObject
 CObject (void)
 Constructor. More...
 
 CObject (const CObject &src)
 Copy constructor. More...
 
virtual ~CObject (void)
 Destructor. More...
 
CObjectoperator= (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...
 
- Public Member Functions inherited from CDebugDumpable
 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

- Public Types inherited from CObject
enum  EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
 Control filling of newly allocated memory. More...
 
typedef CObjectCounterLocker TLockerType
 Default locker type for CRef. More...
 
typedef atomic< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 
- Static Public Member Functions inherited from CObject
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 Public Member Functions inherited from CDebugDumpable
static void EnableDebugDump (bool on)
 
- Static Public Attributes inherited from CObject
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...
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 77 of file formatter.hpp.

Constructor & Destructor Documentation

◆ ~IFormatter()

virtual IFormatter::~IFormatter ( void  )
inlinevirtual

Definition at line 117 of file formatter.hpp.

Member Function Documentation

◆ End()

virtual void IFormatter::End ( IFlatTextOStream text_os)
pure virtual

Implemented in CFlatItemFormatter, and CGBSeqFormatter.

◆ EndSection()

virtual void IFormatter::EndSection ( const CEndSectionItem esec,
IFlatTextOStream text_os 
)
pure virtual

◆ Format()

virtual void IFormatter::Format ( const IFlatItem item,
IFlatTextOStream text_os 
)
pure virtual

Implemented in CFlatItemFormatter.

Referenced by CFormatItemOStream::AddItem().

◆ FormatAccession()

virtual void IFormatter::FormatAccession ( const CAccessionItem acc,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatAlignment()

virtual void IFormatter::FormatAlignment ( const CAlignmentItem aln,
IFlatTextOStream text_os 
)
pure virtual

Implemented in CFlatItemFormatter.

Referenced by CAlignmentItem::Format().

◆ FormatBasecount()

virtual void IFormatter::FormatBasecount ( const CBaseCountItem bc,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatCache()

virtual void IFormatter::FormatCache ( const CCacheItem csh,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatComment()

virtual void IFormatter::FormatComment ( const CCommentItem comment,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatContig()

virtual void IFormatter::FormatContig ( const CContigItem contig,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatDate()

virtual void IFormatter::FormatDate ( const CDateItem date,
IFlatTextOStream text_os 
)
pure virtual

Implemented in CEmblFormatter, and CFlatItemFormatter.

Referenced by CDateItem::Format().

◆ FormatDBSource()

virtual void IFormatter::FormatDBSource ( const CDBSourceItem dbs,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatDefline()

virtual void IFormatter::FormatDefline ( const CDeflineItem defline,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatFeatHeader()

virtual void IFormatter::FormatFeatHeader ( const CFeatHeaderItem fh,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatFeature()

virtual void IFormatter::FormatFeature ( const CFeatureItemBase feat,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatGap()

virtual void IFormatter::FormatGap ( const CGapItem gap,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatGenome()

virtual void IFormatter::FormatGenome ( const CGenomeItem genome,
IFlatTextOStream text_os 
)
pure virtual

Implemented in CGenbankFormatter, and CFlatItemFormatter.

Referenced by CGenomeItem::Format().

◆ FormatGenomeProject()

virtual void IFormatter::FormatGenomeProject ( const CGenomeProjectItem ,
IFlatTextOStream  
)
inlinevirtual

Reimplemented in CFlatItemFormatter, CGenbankFormatter, and CGBSeqFormatter.

Definition at line 114 of file formatter.hpp.

Referenced by CGenomeProjectItem::Format().

◆ FormatHtmlAnchor()

virtual void IFormatter::FormatHtmlAnchor ( const CHtmlAnchorItem ,
IFlatTextOStream  
)
inlinevirtual

Reimplemented in CGenbankFormatter.

Definition at line 115 of file formatter.hpp.

Referenced by CHtmlAnchorItem::Format().

◆ FormatKeywords()

virtual void IFormatter::FormatKeywords ( const CKeywordsItem keys,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatLocus()

virtual void IFormatter::FormatLocus ( const CLocusItem locus,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatOrigin()

virtual void IFormatter::FormatOrigin ( const COriginItem origin,
IFlatTextOStream text_os 
)
pure virtual

Implemented in CGenbankFormatter, and CFlatItemFormatter.

Referenced by COriginItem::Format().

◆ FormatPrimary()

virtual void IFormatter::FormatPrimary ( const CPrimaryItem prim,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatReference()

virtual void IFormatter::FormatReference ( const CReferenceItem keys,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatSegment()

virtual void IFormatter::FormatSegment ( const CSegmentItem seg,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatSequence()

virtual void IFormatter::FormatSequence ( const CSequenceItem seq,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatSource()

virtual void IFormatter::FormatSource ( const CSourceItem keys,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatTSA()

virtual void IFormatter::FormatTSA ( const CTSAItem wgs,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatVersion()

virtual void IFormatter::FormatVersion ( const CVersionItem version,
IFlatTextOStream text_os 
)
pure virtual

◆ FormatWGS()

virtual void IFormatter::FormatWGS ( const CWGSItem wgs,
IFlatTextOStream text_os 
)
pure virtual

◆ Start()

virtual void IFormatter::Start ( IFlatTextOStream text_os)
pure virtual

Implemented in CFlatItemFormatter, and CGBSeqFormatter.

◆ StartSection()

virtual void IFormatter::StartSection ( const CStartSectionItem ssec,
IFlatTextOStream text_os 
)
pure virtual

Implemented in CFlatItemFormatter, and CGBSeqFormatter.


The documentation for this class was generated from the following file:
Modified on Sat Dec 09 04:48:44 2023 by modify_doxy.py rev. 669887