NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
IFlatQVal Class Referenceabstract

Search Toolkit Book for IFlatQVal

#include <objtools/format/items/qualifiers.hpp>

+ Inheritance diagram for IFlatQVal:
+ Collaboration diagram for IFlatQVal:

Public Types

enum  EFlags { fIsNote = 0x1 , fIsSource = 0x2 , fAddPeriod = 0x4 , fPrependNewline = 0x8 }
 
typedef int TFlags
 
- 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...
 

Public Member Functions

virtual void Format (TFlatQuals &quals, const CTempString &name, CBioseqContext &ctx, TFlags flags=0) const =0
 
- 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
 

Static Public Attributes

static const string kSemicolon = ";"
 
static const string kSemicolonEOL = ";\n"
 
static const string kComma = ","
 
static const string kEOL = "\n"
 
static const string kSpace = " "
 
- 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 Types

typedef CFormatQual::TStyle TStyle
 
typedef CFormatQual::ETrim ETrim
 

Protected Member Functions

 IFlatQVal (const string *pfx=&kSpace, const string *sfx=&kEmptyStr)
 
TFlatQual x_AddFQ (TFlatQuals &q, const CTempString &n, const CTempString &v, TStyle st=CFormatQual::eQuoted, CFormatQual::TFlags flags=0, ETrim trim=CFormatQual::eTrim_Normal) const
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Protected Attributes

const stringm_Prefix
 
const stringm_Suffix
 

Additional Inherited Members

- 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)
 

Detailed Description

Definition at line 135 of file qualifiers.hpp.

Member Typedef Documentation

◆ ETrim

Definition at line 157 of file qualifiers.hpp.

◆ TFlags

Definition at line 144 of file qualifiers.hpp.

◆ TStyle

Definition at line 156 of file qualifiers.hpp.

Member Enumeration Documentation

◆ EFlags

Enumerator
fIsNote 
fIsSource 
fAddPeriod 
fPrependNewline 

Definition at line 138 of file qualifiers.hpp.

Constructor & Destructor Documentation

◆ IFlatQVal()

IFlatQVal::IFlatQVal ( const string pfx = &kSpace,
const string sfx = &kEmptyStr 
)
inlineprotected

Definition at line 159 of file qualifiers.hpp.

Member Function Documentation

◆ Format()

virtual void IFlatQVal::Format ( TFlatQuals quals,
const CTempString name,
CBioseqContext ctx,
TFlags  flags = 0 
) const
pure virtual

◆ x_AddFQ()

TFlatQual IFlatQVal::x_AddFQ ( TFlatQuals q,
const CTempString n,
const CTempString v,
TStyle  st = CFormatQual::eQuoted,
CFormatQual::TFlags  flags = 0,
ETrim  trim = CFormatQual::eTrim_Normal 
) const
inlineprotected

Member Data Documentation

◆ kComma

const string IFlatQVal::kComma = ","
static

Definition at line 148 of file qualifiers.hpp.

◆ kEOL

const string IFlatQVal::kEOL = "\n"
static

◆ kSemicolon

const string IFlatQVal::kSemicolon = ";"
static

◆ kSemicolonEOL

const string IFlatQVal::kSemicolonEOL = ";\n"
static

Definition at line 147 of file qualifiers.hpp.

Referenced by CFlatOrgModQVal::Format(), and CFlatSubSourceQVal::Format().

◆ kSpace

const string IFlatQVal::kSpace = " "
static

Definition at line 150 of file qualifiers.hpp.

◆ m_Prefix

const string* IFlatQVal::m_Prefix
mutableprotected

Definition at line 171 of file qualifiers.hpp.

Referenced by CFlatOrgModQVal::Format(), CFlatGoQVal::Format(), and x_AddFQ().

◆ m_Suffix

const string* IFlatQVal::m_Suffix
mutableprotected

The documentation for this class was generated from the following files:
Modified on Fri May 24 14:52:04 2024 by modify_doxy.py rev. 669887