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

Search Toolkit Book for CSUCBlock

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

+ Inheritance diagram for CSUCBlock:
+ Collaboration diagram for CSUCBlock:

Public Member Functions

 CSUCBlock (objects::CFlatFileConfig::FGenbankBlocks which_block)
 
 ~CSUCBlock ()
 
objects::CFlatFileConfig::FGenbankBlocks GetBlockType () const
 
void AddBlock (const string &block_text, const string &accession, const CObject *obj)
 
void AddLine (const string &line, const string &accession, const CObject *obj, bool can_split)
 
size_t CountLines () const
 
void Print ()
 
CConstRef< CSUCLineGetLine (size_t pos) const
 
void SetExpanded (bool val)
 
bool GetExpanded () const
 
void GetText (wxString &text) const
 
const map< CTempString, CRef< CSUCLine > > & GetLines (void)
 
bool HasSecondLevel (void)
 
const map< string, map< CTempString, pair< bool, CRef< CSUCLine > > > > & GetSecondLevel (void)
 
size_t CountChar (const string &str, const char c)
 
- 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 Member Functions

static const char * GetBlockLabel (objects::CFlatFileConfig::FGenbankBlocks block_type)
 
- 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 Attributes

objects::CFlatFileConfig::FGenbankBlocks m_Block
 
map< CTempString, CRef< CSUCLine > > m_Lines
 
map< string, map< CTempString, pair< bool, CRef< CSUCLine > > > > m_SecondLevel
 
map< CTempString, CRef< CSUCLine > >::const_iterator m_pos_it
 
int m_pos
 
bool m_Expanded
 
string m_label
 

Additional Inherited Members

- 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...
 
- 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 69 of file suc_data.hpp.

Constructor & Destructor Documentation

◆ CSUCBlock()

CSUCBlock::CSUCBlock ( objects::CFlatFileConfig::FGenbankBlocks  which_block)
inline

Definition at line 72 of file suc_data.hpp.

◆ ~CSUCBlock()

CSUCBlock::~CSUCBlock ( )
inline

Definition at line 73 of file suc_data.hpp.

Member Function Documentation

◆ AddBlock()

void CSUCBlock::AddBlock ( const string block_text,
const string accession,
const CObject obj 
)

Definition at line 52 of file suc_data.cpp.

References AddLine(), and m_label.

◆ AddLine()

void CSUCBlock::AddLine ( const string line,
const string accession,
const CObject obj,
bool  can_split 
)

◆ CountChar()

size_t CSUCBlock::CountChar ( const string str,
const char  c 
)

◆ CountLines()

size_t CSUCBlock::CountLines ( ) const
inline

Definition at line 78 of file suc_data.hpp.

References m_Lines, and map_checker< Container >::size().

◆ GetBlockLabel()

const char * CSUCBlock::GetBlockLabel ( objects::CFlatFileConfig::FGenbankBlocks  block_type)
static

◆ GetBlockType()

objects::CFlatFileConfig::FGenbankBlocks CSUCBlock::GetBlockType ( ) const
inline

Definition at line 75 of file suc_data.hpp.

References m_Block.

◆ GetExpanded()

bool CSUCBlock::GetExpanded ( ) const
inline

Definition at line 85 of file suc_data.hpp.

References m_Expanded.

◆ GetLine()

CConstRef< CSUCLine > CSUCBlock::GetLine ( size_t  pos) const

Definition at line 151 of file suc_data.cpp.

References m_Lines, m_pos, and m_pos_it.

◆ GetLines()

const map<CTempString, CRef<CSUCLine> >& CSUCBlock::GetLines ( void  )
inline

Definition at line 88 of file suc_data.hpp.

References m_Lines.

◆ GetSecondLevel()

const map<string, map<CTempString, pair<bool, CRef<CSUCLine> > > >& CSUCBlock::GetSecondLevel ( void  )
inline

Definition at line 90 of file suc_data.hpp.

References m_SecondLevel.

◆ GetText()

void CSUCBlock::GetText ( wxString &  text) const

Definition at line 171 of file suc_data.cpp.

References m_Lines, and text().

◆ HasSecondLevel()

bool CSUCBlock::HasSecondLevel ( void  )

◆ Print()

void CSUCBlock::Print ( void  )

Definition at line 143 of file suc_data.cpp.

References m_Lines.

◆ SetExpanded()

void CSUCBlock::SetExpanded ( bool  val)
inline

Definition at line 84 of file suc_data.hpp.

References m_Expanded, and val.

Member Data Documentation

◆ m_Block

objects::CFlatFileConfig::FGenbankBlocks CSUCBlock::m_Block
protected

Definition at line 93 of file suc_data.hpp.

Referenced by GetBlockType(), and HasSecondLevel().

◆ m_Expanded

bool CSUCBlock::m_Expanded
protected

Definition at line 99 of file suc_data.hpp.

Referenced by GetExpanded(), and SetExpanded().

◆ m_label

string CSUCBlock::m_label
protected

Definition at line 100 of file suc_data.hpp.

Referenced by AddBlock(), and AddLine().

◆ m_Lines

map<CTempString, CRef<CSUCLine> > CSUCBlock::m_Lines
protected

Definition at line 95 of file suc_data.hpp.

Referenced by AddLine(), CountLines(), GetLine(), GetLines(), GetText(), and Print().

◆ m_pos

int CSUCBlock::m_pos
mutableprotected

Definition at line 98 of file suc_data.hpp.

Referenced by AddLine(), and GetLine().

◆ m_pos_it

map<CTempString, CRef<CSUCLine> >::const_iterator CSUCBlock::m_pos_it
mutableprotected

Definition at line 97 of file suc_data.hpp.

Referenced by GetLine().

◆ m_SecondLevel

map<string, map<CTempString, pair<bool, CRef<CSUCLine> > > > CSUCBlock::m_SecondLevel
protected

Definition at line 96 of file suc_data.hpp.

Referenced by AddLine(), and GetSecondLevel().


The documentation for this class was generated from the following files:
Modified on Sat Apr 13 11:43:40 2024 by modify_doxy.py rev. 669887