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

Search Toolkit Book for CGraphRanges

Helper class for mapping graphs. More...

#include <objects/seq/seq_loc_mapper_base.hpp>

+ Inheritance diagram for CGraphRanges:
+ Collaboration diagram for CGraphRanges:

Public Types

typedef CRange< TSeqPosTRange
 
typedef vector< TRangeTGraphRanges
 
- 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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CGraphRanges (void)
 
TSeqPos GetOffset (void) const
 
void SetOffset (TSeqPos offset)
 
void IncOffset (TSeqPos inc)
 
const TGraphRangesGetRanges (void) const
 
void AddRange (const TRange &rg)
 
const TRangeGetTotalRange (void) 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
 

Private Attributes

TSeqPos m_Offset
 
TGraphRanges m_Ranges
 
TRange m_TotalRange
 

Additional Inherited Members

- Static Public Member Functions inherited from CObject
static NCBI_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

Helper class for mapping graphs.

Used to collect ranges relative to the graph location and adjust mapped graph data accordingly.

Definition at line 234 of file seq_loc_mapper_base.hpp.

Member Typedef Documentation

Definition at line 240 of file seq_loc_mapper_base.hpp.

Definition at line 239 of file seq_loc_mapper_base.hpp.

Constructor & Destructor Documentation

CGraphRanges::CGraphRanges ( void  )
inline

Definition at line 237 of file seq_loc_mapper_base.hpp.

Member Function Documentation

void CGraphRanges::AddRange ( const TRange rg)
inline
TSeqPos CGraphRanges::GetOffset ( void  ) const
inline
const TGraphRanges& CGraphRanges::GetRanges ( void  ) const
inline

Definition at line 249 of file seq_loc_mapper_base.hpp.

References m_Ranges.

Referenced by CMappedGraph::GetMappedGraphRanges(), and CSeq_loc_Mapper_Base::Map().

const TRange& CGraphRanges::GetTotalRange ( void  ) const
inline

Definition at line 266 of file seq_loc_mapper_base.hpp.

References m_TotalRange.

Referenced by CMappedGraph::GetMappedGraphTotalRange().

void CGraphRanges::IncOffset ( TSeqPos  inc)
inline
void CGraphRanges::SetOffset ( TSeqPos  offset)
inline

Member Data Documentation

TSeqPos CGraphRanges::m_Offset
private

Definition at line 269 of file seq_loc_mapper_base.hpp.

Referenced by AddRange(), GetOffset(), IncOffset(), and SetOffset().

TGraphRanges CGraphRanges::m_Ranges
private

Definition at line 270 of file seq_loc_mapper_base.hpp.

Referenced by AddRange(), and GetRanges().

TRange CGraphRanges::m_TotalRange
private

Definition at line 271 of file seq_loc_mapper_base.hpp.

Referenced by AddRange(), and GetTotalRange().


The documentation for this class was generated from the following file:
Modified on Sun Aug 28 17:59:42 2016 by modify_doxy.py rev. 506947