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

Search Toolkit Book for CTableDataSUC

#include <gui/widgets/edit/table_data_suc.hpp>

+ Inheritance diagram for CTableDataSUC:
+ Collaboration diagram for CTableDataSUC:

Public Types

enum  EColContents { eBlock = 0 , eCount , eLine , eMaxColNum }
 
- 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 Types inherited from ITableData
enum  ColumnType {
  kNone , kInt , kReal , kString ,
  kBytes , kCommonString , kCommonBytes , kObject
}
 

Public Member Functions

 CTableDataSUC (CSUCResults *results, objects::CScope *scope)
 
virtual ~CTableDataSUC ()
 
ITableData interface implementation
virtual ColumnType GetColumnType (size_t col) const
 
virtual bool IsHtmlColumn (size_t col) const
 
virtual string GetColumnLabel (size_t col) const
 
virtual size_t GetRowsCount () const
 
virtual size_t GetColsCount () const
 
virtual void GetStringValue (size_t row, size_t col, string &value) const
 
virtual string GetHtmlValue (size_t, size_t) const
 
virtual long GetIntValue (size_t row, size_t col) const
 
virtual SConstScopedObject GetObjectValue (size_t row, size_t col) const
 
virtual SConstScopedObject GetRowObject (size_t row) const
 
CRef< objects::CScope > GetScope ()
 
- 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
 
- Public Member Functions inherited from CTableDataBase
virtual string GetTableTypeId () const
 
- Public Member Functions inherited from ITableData
virtual ~ITableData ()
 
virtual string GetRowLabel (size_t) const
 
virtual vector< stringGetColumnCommonStrings (size_t) const
 
virtual vector< vector< char > * > GetColumnCommonBytes (size_t) const
 
virtual double GetRealValue (size_t, size_t) const
 
virtual void SetStringValue (size_t, size_t, const string &)
 
virtual void SetIntValue (size_t, size_t, long)
 
virtual void SetRealValue (size_t, size_t, double)
 
virtual void SetObjectValue (size_t, size_t, SConstScopedObject *)
 
virtual bool AllowEdit (size_t)
 

Static Public Attributes

static const size_t c_MaxRows
 
static const size_t c_BlockWidth
 
static const size_t c_LineWidth
 
- 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...
 

Private Member Functions

CConstRef< CSUCLinex_GetRowData (size_t row) const
 

Private Attributes

CRef< objects::CScope > m_Scope
 
CRef< CSUCResultsm_SUCResults
 

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)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 41 of file table_data_suc.hpp.

Member Enumeration Documentation

◆ EColContents

Enumerator
eBlock 
eCount 
eLine 
eMaxColNum 

Definition at line 45 of file table_data_suc.hpp.

Constructor & Destructor Documentation

◆ CTableDataSUC()

CTableDataSUC::CTableDataSUC ( CSUCResults results,
objects::CScope *  scope 
)

Definition at line 47 of file table_data_suc.cpp.

◆ ~CTableDataSUC()

CTableDataSUC::~CTableDataSUC ( )
virtual

Definition at line 52 of file table_data_suc.cpp.

Member Function Documentation

◆ GetColsCount()

size_t CTableDataSUC::GetColsCount ( ) const
virtual

Implements ITableData.

Definition at line 106 of file table_data_suc.cpp.

References eMaxColNum.

◆ GetColumnLabel()

string CTableDataSUC::GetColumnLabel ( size_t  col) const
virtual

Implements ITableData.

Definition at line 85 of file table_data_suc.cpp.

References CSUCResults::CountLines(), eMaxColNum, kEmptyStr, m_SUCResults, and s_ColNames.

◆ GetColumnType()

ITableData::ColumnType CTableDataSUC::GetColumnType ( size_t  col) const
virtual

◆ GetHtmlValue()

string CTableDataSUC::GetHtmlValue ( size_t  row,
size_t  col 
) const
virtual

◆ GetIntValue()

long CTableDataSUC::GetIntValue ( size_t  row,
size_t  col 
) const
virtual

Reimplemented from ITableData.

Definition at line 183 of file table_data_suc.cpp.

References eCount, GetRowsCount(), row, rapidjson::value, and x_GetRowData().

◆ GetObjectValue()

SConstScopedObject CTableDataSUC::GetObjectValue ( size_t  row,
size_t  col 
) const
virtual

Reimplemented from ITableData.

Definition at line 199 of file table_data_suc.cpp.

References GetRowObject(), and row.

◆ GetRowObject()

SConstScopedObject CTableDataSUC::GetRowObject ( size_t  row) const
virtual

Reimplemented from ITableData.

Definition at line 205 of file table_data_suc.cpp.

References GetRowsCount(), m_Scope, row, rapidjson::value, and x_GetRowData().

Referenced by GetObjectValue().

◆ GetRowsCount()

size_t CTableDataSUC::GetRowsCount ( ) const
virtual

Implements ITableData.

Definition at line 99 of file table_data_suc.cpp.

References CSUCResults::CountLines(), m_SUCResults, and max().

Referenced by GetHtmlValue(), GetIntValue(), GetRowObject(), and GetStringValue().

◆ GetScope()

CRef<objects::CScope> CTableDataSUC::GetScope ( void  )
inline

Definition at line 80 of file table_data_suc.hpp.

References m_Scope.

◆ GetStringValue()

void CTableDataSUC::GetStringValue ( size_t  row,
size_t  col,
string value 
) const
virtual

◆ IsHtmlColumn()

bool CTableDataSUC::IsHtmlColumn ( size_t  col) const
virtual

Reimplemented from ITableData.

Definition at line 80 of file table_data_suc.cpp.

◆ x_GetRowData()

CConstRef< CSUCLine > CTableDataSUC::x_GetRowData ( size_t  row) const
private

Definition at line 218 of file table_data_suc.cpp.

References CSUCResults::GetLine(), m_SUCResults, and row.

Referenced by GetHtmlValue(), GetIntValue(), GetRowObject(), and GetStringValue().

Member Data Documentation

◆ c_BlockWidth

const size_t CTableDataSUC::c_BlockWidth
static

Definition at line 57 of file table_data_suc.hpp.

Referenced by GetHtmlValue().

◆ c_LineWidth

const size_t CTableDataSUC::c_LineWidth
static

Definition at line 58 of file table_data_suc.hpp.

Referenced by GetHtmlValue().

◆ c_MaxRows

const size_t CTableDataSUC::c_MaxRows
static

Definition at line 53 of file table_data_suc.hpp.

Referenced by GetStringValue().

◆ m_Scope

CRef<objects::CScope> CTableDataSUC::m_Scope
private

Definition at line 85 of file table_data_suc.hpp.

Referenced by GetRowObject(), and GetScope().

◆ m_SUCResults

CRef<CSUCResults> CTableDataSUC::m_SUCResults
private

The documentation for this class was generated from the following files:
Modified on Wed Jul 17 13:21:11 2024 by modify_doxy.py rev. 669887