NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | List of all members
CConversionOption Class Reference

Search Toolkit Book for CConversionOption

#include <gui/objutils/convert_feat.hpp>

+ Inheritance diagram for CConversionOption:
+ Collaboration diagram for CConversionOption:

Public Types

enum  E_Choice { e_NotSet = 0 , e_Bool , e_String }
 
- 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

 CConversionOption (const string &label)
 
 ~CConversionOption ()
 
const stringGetLabel () const
 
CRef< CConversionOptionBoolSetBool ()
 
CRef< CConversionOptionStringSetString ()
 
CConstRef< CConversionOptionBoolGetBool () const
 
CConstRef< CConversionOptionStringGetString () const
 
E_Choice Which ()
 
bool IsBool () const
 
bool IsString () const
 
- 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
 

Protected Attributes

string m_Label
 
E_Choice m_Choice
 
CRef< CObjectm_Object
 

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 90 of file convert_feat.hpp.

Member Enumeration Documentation

◆ E_Choice

Enumerator
e_NotSet 
e_Bool 
e_String 

Definition at line 98 of file convert_feat.hpp.

Constructor & Destructor Documentation

◆ CConversionOption()

CConversionOption::CConversionOption ( const string label)
inline

Definition at line 93 of file convert_feat.hpp.

◆ ~CConversionOption()

CConversionOption::~CConversionOption ( )
inline

Definition at line 94 of file convert_feat.hpp.

Member Function Documentation

◆ GetBool()

CConstRef< CConversionOptionBool > CConversionOption::GetBool ( void  ) const

Definition at line 1602 of file convert_feat.cpp.

References e_Bool, CRef< C, Locker >::GetPointer(), m_Choice, m_Object, and NULL.

◆ GetLabel()

const string& CConversionOption::GetLabel ( void  ) const
inline

Definition at line 96 of file convert_feat.hpp.

References m_Label.

◆ GetString()

CConstRef< CConversionOptionString > CConversionOption::GetString ( void  ) const

Definition at line 1624 of file convert_feat.cpp.

References e_String, CRef< C, Locker >::GetPointer(), m_Choice, m_Object, and NULL.

◆ IsBool()

bool CConversionOption::IsBool ( ) const
inline

Definition at line 109 of file convert_feat.hpp.

References e_Bool, and m_Choice.

◆ IsString()

bool CConversionOption::IsString ( void  ) const
inline

Definition at line 110 of file convert_feat.hpp.

References e_String, and m_Choice.

◆ SetBool()

CRef< CConversionOptionBool > CConversionOption::SetBool ( )

Definition at line 1590 of file convert_feat.cpp.

References e_Bool, CRef< C, Locker >::GetPointer(), m_Choice, and m_Object.

◆ SetString()

CRef< CConversionOptionString > CConversionOption::SetString ( void  )

Definition at line 1612 of file convert_feat.cpp.

References e_String, CRef< C, Locker >::GetPointer(), m_Choice, and m_Object.

◆ Which()

E_Choice CConversionOption::Which ( void  )
inline

Definition at line 108 of file convert_feat.hpp.

References m_Choice.

Member Data Documentation

◆ m_Choice

E_Choice CConversionOption::m_Choice
protected

Definition at line 114 of file convert_feat.hpp.

Referenced by GetBool(), GetString(), IsBool(), IsString(), SetBool(), SetString(), and Which().

◆ m_Label

string CConversionOption::m_Label
protected

Definition at line 113 of file convert_feat.hpp.

Referenced by GetLabel().

◆ m_Object

CRef<CObject> CConversionOption::m_Object
protected

Definition at line 115 of file convert_feat.hpp.

Referenced by GetBool(), GetString(), SetBool(), and SetString().


The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:26:14 2024 by modify_doxy.py rev. 669887