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

Inheritance diagram for CFormatQual:

Collaboration diagram for CFormatQual:

Public Types
enum	EStyle { eEmpty , eQuoted , eUnquoted }

enum	FFlags { fFlags_showEvenIfRedund = 1 << 0 }

enum	ETrim { eTrim_Normal , eTrim_WhitespaceOnly }

typedef EStyle	TStyle

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< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...

typedef Uint8	TCount
	Alias for value type of counter. More...

Public Member Functions
	CFormatQual (const CTempString &name, const CTempString &value, const CTempString &prefix, const CTempString &suffix, TStyle style=eQuoted, TFlags flags=0, ETrim trim=eTrim_Normal)

	CFormatQual (const CTempString &name, const CTempString &value, TStyle style=eQuoted, TFlags flags=0, ETrim trim=eTrim_Normal)

const string &	GetName (void) const

const string &	GetValue (void) const

TStyle	GetStyle (void) const

const string &	GetPrefix (void) const

const string &	GetSuffix (void) const

TFlags	GetFlags (void) const

ETrim	GetTrim (void) const

void	SetAddPeriod (bool add=true)

bool	GetAddPeriod (void) const

Public Member Functions inherited from CObject
	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...

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

Private Attributes
string	m_Name

string	m_Value

string	m_Prefix

string	m_Suffix

TStyle	m_Style

TFlags	m_Flags

ETrim	m_Trim

bool	m_AddPeriod

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)

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 67 of file qualifiers.hpp.

Member Typedef Documentation

◆ TFlags

typedef int CFormatQual::TFlags

Definition at line 83 of file qualifiers.hpp.

◆ TStyle

typedef EStyle CFormatQual::TStyle

Definition at line 75 of file qualifiers.hpp.

Member Enumeration Documentation

◆ EStyle

enum CFormatQual::EStyle

Enumerator
eEmpty
eQuoted
eUnquoted

Definition at line 70 of file qualifiers.hpp.

◆ ETrim

enum CFormatQual::ETrim

Enumerator
eTrim_Normal
eTrim_WhitespaceOnly

Definition at line 86 of file qualifiers.hpp.

◆ FFlags

enum CFormatQual::FFlags

Enumerator
fFlags_showEvenIfRedund

Definition at line 77 of file qualifiers.hpp.

Constructor & Destructor Documentation

◆ CFormatQual() [1/2]

CFormatQual::CFormatQual	(	const CTempString &	name,
		const CTempString &	value,
		const CTempString &	prefix,
		const CTempString &	suffix,
		TStyle	style = `eQuoted`,
		TFlags	flags = `0`,
		ETrim	trim = `eTrim_Normal`
	)

Definition at line 309 of file qualifiers.cpp.

References CleanAndCompress(), m_Value, and value.

◆ CFormatQual() [2/2]

CFormatQual::CFormatQual	(	const CTempString &	name,
		const CTempString &	value,
		TStyle	style = `eQuoted`,
		TFlags	flags = `0`,
		ETrim	trim = `eTrim_Normal`
	)

Definition at line 326 of file qualifiers.cpp.

References CleanAndCompress(), m_Value, and value.

Member Function Documentation

◆ GetAddPeriod()

bool CFormatQual::GetAddPeriod ( void ) const

inline

Definition at line 118 of file qualifiers.hpp.

References m_AddPeriod.

◆ GetFlags()

TFlags CFormatQual::GetFlags ( void ) const

inline

Definition at line 114 of file qualifiers.hpp.

References m_Flags.

◆ GetName()

const string& CFormatQual::GetName ( void ) const

inline

Definition at line 109 of file qualifiers.hpp.

References m_Name.

◆ GetPrefix()

const string& CFormatQual::GetPrefix ( void ) const

inline

Definition at line 112 of file qualifiers.hpp.

References m_Prefix.

◆ GetStyle()

TStyle CFormatQual::GetStyle ( void ) const

inline

Definition at line 111 of file qualifiers.hpp.

References m_Style.

◆ GetSuffix()

const string& CFormatQual::GetSuffix ( void ) const

inline

Definition at line 113 of file qualifiers.hpp.

References m_Suffix.

◆ GetTrim()

ETrim CFormatQual::GetTrim ( void ) const

inline

Definition at line 115 of file qualifiers.hpp.

References m_Trim.

◆ GetValue()

const string& CFormatQual::GetValue ( void ) const

inline

Definition at line 110 of file qualifiers.hpp.

References m_Value.

◆ SetAddPeriod()

void CFormatQual::SetAddPeriod ( bool add = true )

inline

Definition at line 117 of file qualifiers.hpp.

References m_AddPeriod.

Member Data Documentation

◆ m_AddPeriod

bool CFormatQual::m_AddPeriod

private

Definition at line 125 of file qualifiers.hpp.

Referenced by GetAddPeriod(), and SetAddPeriod().

◆ m_Flags

TFlags CFormatQual::m_Flags

private

Definition at line 123 of file qualifiers.hpp.

Referenced by GetFlags().

◆ m_Name

string CFormatQual::m_Name

private

Definition at line 121 of file qualifiers.hpp.

Referenced by GetName().

◆ m_Prefix

string CFormatQual::m_Prefix

private

Definition at line 121 of file qualifiers.hpp.

Referenced by GetPrefix().

◆ m_Style

TStyle CFormatQual::m_Style

private

Definition at line 122 of file qualifiers.hpp.

Referenced by GetStyle().

◆ m_Suffix

string CFormatQual::m_Suffix

private

Definition at line 121 of file qualifiers.hpp.

Referenced by GetSuffix().

◆ m_Trim

ETrim CFormatQual::m_Trim

private

Definition at line 124 of file qualifiers.hpp.

Referenced by GetTrim().

◆ m_Value

string CFormatQual::m_Value

private

Definition at line 121 of file qualifiers.hpp.

Referenced by CFormatQual(), and GetValue().

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

include/objtools/format/items/qualifiers.hpp
src/objtools/format/qualifiers.cpp

Public Types

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TFlags

◆ TStyle

Member Enumeration Documentation

◆ EStyle

◆ ETrim

◆ FFlags

Constructor & Destructor Documentation

◆ CFormatQual() [1/2]

◆ CFormatQual() [2/2]

Member Function Documentation

◆ GetAddPeriod()

◆ GetFlags()

◆ GetName()

◆ GetPrefix()

◆ GetStyle()

◆ GetSuffix()

◆ GetTrim()

◆ GetValue()

◆ SetAddPeriod()

Member Data Documentation

◆ m_AddPeriod

◆ m_Flags

◆ m_Name

◆ m_Prefix

◆ m_Style

◆ m_Suffix

◆ m_Trim

◆ m_Value