NCBI C++ ToolKit
Public Member Functions | Private Attributes | List of all members

Search Toolkit Book for CMultiSeqInfo

Contains information about all sequences in a set. More...

+ Inheritance diagram for CMultiSeqInfo:
+ Collaboration diagram for CMultiSeqInfo:

Public Member Functions

 CMultiSeqInfo (TSeqLocVector &seq_vector, EBlastProgramType program, bool dbscan_mode)
 Constructor from a vector of sequence location/scope pairs and a BLAST program type. More...
 
 ~CMultiSeqInfo ()
 Destructor. More...
 
Uint4 GetMaxLength ()
 Setter and getter functions for the private fields. More...
 
void SetMaxLength (Uint4 val)
 Sets maximal length. More...
 
Uint4 GetAvgLength ()
 Returns average length. More...
 
void SetAvgLength (Uint4 val)
 Sets average length. More...
 
Int8 GetTotLength ()
 Returns total length. More...
 
bool GetIsProtein ()
 Answers whether sequences in this object are protein or nucleotide. More...
 
Uint4 GetNumSeqs ()
 Returns number of sequences. More...
 
BLAST_SequenceBlkGetSeqBlk (int index)
 Returns sequence block structure for one of the sequences. More...
 
- 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

bool m_ibIsProt
 Internal fields. More...
 
vector< BLAST_SequenceBlk * > m_ivSeqBlkVec
 Vector of sequence blocks. More...
 
unsigned int m_iMaxLength
 Length of the longest sequence in this set. More...
 
unsigned int m_iAvgLength
 Average length of sequences in this set. More...
 
Int8 m_iTotalLength
 Total length of sequences in this set. More...
 
bool m_DbScanMode
 Database scanning mode (not pairwise) More...
 

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 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

Contains information about all sequences in a set.

Definition at line 52 of file seqsrc_multiseq.cpp.


The documentation for this class was generated from the following file:
Modified on Fri Sep 20 14:57:46 2024 by modify_doxy.py rev. 669887