NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Private Attributes | List of all members
CCategoryConfig Class Reference

Search Toolkit Book for CCategoryConfig

data structure holding configuration for a track. More...

#include <gui/widgets/seq_graphic/layout_conf.hpp>

+ Inheritance diagram for CCategoryConfig:
+ Collaboration diagram for CCategoryConfig:

Classes

struct  SCategorySettings
 

Public Types

typedef map< string, intTGroupMap
 group/subgroup settings from TMS string is group name, int is group order More...
 
typedef pair< string, stringTSubgroupName
 first string is group name, second is subgroups name More...
 
typedef map< TSubgroupName, intTSubgroupMap
 int is subgroup order More...
 
typedef map< string, CRef< objects::CCategory > > TSubcategories
 
typedef map< string, SCategorySettingsTCategories
 
- 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

void AddCategory (const SCategorySettings &cat)
 
void AddSubcategory (const string &cat_name, CRef< objects::CCategory > sub_cat)
 
CRef< objects::CCategory > GetCategory (const string &cat_name)
 
CRef< objects::CCategory > GetSubcategory (const string &cat_name, const string &sub_cat)
 
- 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
 

Private Attributes

TCategories m_Categories
 

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

data structure holding configuration for a track.

Definition at line 220 of file layout_conf.hpp.

Member Typedef Documentation

◆ TCategories

Definition at line 246 of file layout_conf.hpp.

◆ TGroupMap

group/subgroup settings from TMS string is group name, int is group order

Definition at line 225 of file layout_conf.hpp.

◆ TSubcategories

typedef map< string, CRef<objects::CCategory> > CCategoryConfig::TSubcategories

Definition at line 233 of file layout_conf.hpp.

◆ TSubgroupMap

int is subgroup order

Definition at line 231 of file layout_conf.hpp.

◆ TSubgroupName

first string is group name, second is subgroups name

Definition at line 228 of file layout_conf.hpp.

Member Function Documentation

◆ AddCategory()

void CCategoryConfig::AddCategory ( const SCategorySettings cat)
inline

◆ AddSubcategory()

void CCategoryConfig::AddSubcategory ( const string cat_name,
CRef< objects::CCategory >  sub_cat 
)
inline

Definition at line 253 of file layout_conf.hpp.

References m_Categories.

Referenced by CSeqGraphicConfig::InitCategoryConfig().

◆ GetCategory()

CRef<objects::CCategory> CCategoryConfig::GetCategory ( const string cat_name)
inline

◆ GetSubcategory()

CRef<objects::CCategory> CCategoryConfig::GetSubcategory ( const string cat_name,
const string sub_cat 
)
inline

Member Data Documentation

◆ m_Categories

TCategories CCategoryConfig::m_Categories
private

Definition at line 285 of file layout_conf.hpp.

Referenced by AddCategory(), AddSubcategory(), GetCategory(), and GetSubcategory().


The documentation for this class was generated from the following file:
Modified on Sat Jun 22 10:45:10 2024 by modify_doxy.py rev. 669887