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

Search Toolkit Book for CRangeWithFuzz

+ Inheritance diagram for CRangeWithFuzz:
+ Collaboration diagram for CRangeWithFuzz:

Public Types

typedef CSeq_loc::TRange TParent
 
typedef CConstRef< CInt_fuzzTFuzz
 
- Public Types inherited from CRange< TSeqPos >
typedef COpenRange< TSeqPosTParent
 
typedef TParent::position_type position_type
 
typedef CRange< TSeqPosTThisType
 
- Public Types inherited from CRange_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_from , e_to }
 
typedef int TFrom
 
typedef int TTo
 
typedef Tparent::CMemberIndex< E_memberIndex, 3 > TmemberIndex
 
- 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 COpenRange< TSeqPos >
typedef TSeqPos position_type
 
typedef COpenRange< TSeqPosTThisType
 

Public Member Functions

 CRangeWithFuzz (const TParent &rg)
 
 CRangeWithFuzz (const CSeq_loc_CI &it)
 
void ResetFuzzFrom (void)
 
void ResetFuzzTo (void)
 
bool IsSetFuzzFrom (void) const
 
bool IsSetFuzzTo (void) const
 
const CInt_fuzzGetFuzzFrom (void) const
 
const CInt_fuzzGetFuzzTo (void) const
 
void AddFuzzFrom (const CRangeWithFuzz &rg)
 
void AddFuzzTo (const CRangeWithFuzz &rg)
 
void AddFuzzFrom (const CInt_fuzz &fuzz, ENa_strand strand)
 
void AddFuzzTo (const CInt_fuzz &fuzz, ENa_strand strand)
 
void CopyFrom (const CRangeWithFuzz &rg)
 
void CopyTo (const CRangeWithFuzz &rg)
 
CRangeWithFuzzoperator+= (const CRangeWithFuzz &rg)
 
CRangeWithFuzzoperator+= (const TParent &rg)
 
- Public Member Functions inherited from CRange< TSeqPos >
 CRange (void)
 
 CRange (void)
 
 CRange (position_type from, position_type to)
 
 CRange (const TParent &range)
 
 ~CRange (void)
 
TThisTypeoperator= (const TParent &range)
 
- Public Member Functions inherited from CRange_Base
 CRange_Base (void)
 
virtual ~CRange_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetFrom (void) const
 Beginning of masked range (one-offset) Check if a value has been assigned to From data member. More...
 
bool CanGetFrom (void) const
 Check if it is safe to call GetFrom method. More...
 
void ResetFrom (void)
 Reset From data member. More...
 
TFrom GetFrom (void) const
 Get the From member data. More...
 
void SetFrom (TFrom value)
 Assign a value to From data member. More...
 
TFromSetFrom (void)
 Assign a value to From data member. More...
 
bool IsSetTo (void) const
 End of masked range (one-offset) Check if a value has been assigned to To data member. More...
 
bool CanGetTo (void) const
 Check if it is safe to call GetTo method. More...
 
void ResetTo (void)
 Reset To data member. More...
 
TTo GetTo (void) const
 Get the To member data. More...
 
void SetTo (TTo value)
 Assign a value to To data member. More...
 
TToSetTo (void)
 Assign a value to To data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 
- Public Member Functions inherited from CSerialObject
 CSerialObject (void)
 
virtual ~CSerialObject (void)
 
virtual const CTypeInfoGetThisTypeInfo (void) const =0
 
virtual void Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
 Set object to copy of another one. More...
 
virtual bool Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
 Check if both objects contain the same values. More...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. More...
 
void ThrowUnassigned (TMemberIndex index) const
 
void ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
 
bool HasNamespaceName (void) const
 Check if object data type has namespace name. More...
 
const stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (void) const
 Get namespace prefix. 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...
 
- 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 COpenRange< TSeqPos >
 COpenRange (void)
 
 COpenRange (position_type from, position_type toOpen)
 
position_type GetFrom (void) const
 
position_type GetToOpen (void) const
 
position_type GetTo (void) const
 
bool Empty (void) const
 
bool NotEmpty (void) const
 
position_type GetLength (void) const
 
TThisTypeSetFrom (position_type from)
 
TThisTypeSetToOpen (position_type toOpen)
 
TThisTypeSetTo (position_type to)
 
TThisTypeSetOpen (position_type from, position_type toOpen)
 
TThisTypeSet (position_type from, position_type to)
 
TThisTypeSetLength (position_type length)
 
TThisTypeSetLengthDown (position_type length)
 
bool operator== (const TThisType &r) const
 
bool operator!= (const TThisType &r) const
 
bool operator< (const TThisType &r) const
 
bool operator<= (const TThisType &r) const
 
bool operator> (const TThisType &r) const
 
bool operator>= (const TThisType &r) const
 
bool IsWholeFrom (void) const
 
bool IsWholeTo (void) const
 
bool IsWhole (void) const
 
TThisType IntersectionWith (const TThisType &r) const
 
TThisTypeIntersectWith (const TThisType &r)
 
TThisType operator& (const TThisType &r) const
 
TThisTypeoperator&= (const TThisType &r)
 
bool IntersectingWith (const TThisType &r) const
 
bool AbuttingWith (const TThisType &r) const
 
TThisTypeCombineWith (const TThisType &r)
 
TThisType CombinationWith (const TThisType &r) const
 
TThisTypeoperator+= (const TThisType &r)
 
TThisType operator+ (const TThisType &r) const
 

Private Member Functions

CRef< CInt_fuzzx_SetFuzz (TFuzz &fuzz, const CInt_fuzz *copy_from)
 
void x_AddFuzz (TFuzz &fuzz, const TFuzz &other, ENa_strand other_strand)
 

Private Attributes

TFuzz m_Fuzz_from
 
TFuzz m_Fuzz_to
 
ENa_strand m_Strand
 

Additional Inherited Members

- Static Public Member Functions inherited from CSerialObject
static void SetVerifyDataThread (ESerialVerifyData verify)
 
static void SetVerifyDataGlobal (ESerialVerifyData verify)
 
static string UnassignedString (void)
 
static CStringUTF8 UnassignedStringUTF8 (void)
 
static char UnassignedByte (void)
 
- 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 Member Functions inherited from COpenRange< TSeqPos >
static position_type GetPositionMin (void)
 
static position_type GetPositionMax (void)
 
static position_type GetWholeFrom (void)
 
static position_type GetWholeToOpen (void)
 
static position_type GetWholeTo (void)
 
static position_type GetWholeLength (void)
 
static TThisType GetWhole (void)
 
static position_type GetEmptyFrom (void)
 
static position_type GetEmptyToOpen (void)
 
static position_type GetEmptyTo (void)
 
static position_type GetEmptyLength (void)
 
static TThisType GetEmpty (void)
 
- Static Public Attributes inherited from CSerialObject
static const char * ms_UnassignedStr = "<*unassigned*>"
 
static const char ms_UnassignedByte = char(0xcd)
 
- 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 3996 of file Seq_loc.cpp.

Member Typedef Documentation

◆ TFuzz

Definition at line 4000 of file Seq_loc.cpp.

◆ TParent

Definition at line 3999 of file Seq_loc.cpp.

Constructor & Destructor Documentation

◆ CRangeWithFuzz() [1/2]

CRangeWithFuzz::CRangeWithFuzz ( const TParent rg)
inline

Definition at line 4002 of file Seq_loc.cpp.

References m_Strand.

Referenced by operator+=().

◆ CRangeWithFuzz() [2/2]

CRangeWithFuzz::CRangeWithFuzz ( const CSeq_loc_CI it)
inline

Definition at line 4006 of file Seq_loc.cpp.

References GetFuzzFrom(), GetFuzzTo(), m_Fuzz_from, m_Fuzz_to, and m_Strand.

Member Function Documentation

◆ AddFuzzFrom() [1/2]

void CRangeWithFuzz::AddFuzzFrom ( const CInt_fuzz fuzz,
ENa_strand  strand 
)
inline

Definition at line 4033 of file Seq_loc.cpp.

References ConstRef(), m_Fuzz_from, and x_AddFuzz().

◆ AddFuzzFrom() [2/2]

void CRangeWithFuzz::AddFuzzFrom ( const CRangeWithFuzz rg)
inline

Definition at line 4022 of file Seq_loc.cpp.

References m_Fuzz_from, and x_AddFuzz().

Referenced by operator+=().

◆ AddFuzzTo() [1/2]

void CRangeWithFuzz::AddFuzzTo ( const CInt_fuzz fuzz,
ENa_strand  strand 
)
inline

Definition at line 4038 of file Seq_loc.cpp.

References ConstRef(), m_Fuzz_to, and x_AddFuzz().

◆ AddFuzzTo() [2/2]

void CRangeWithFuzz::AddFuzzTo ( const CRangeWithFuzz rg)
inline

Definition at line 4028 of file Seq_loc.cpp.

References m_Fuzz_to, and x_AddFuzz().

Referenced by operator+=().

◆ CopyFrom()

void CRangeWithFuzz::CopyFrom ( const CRangeWithFuzz rg)
inline

Definition at line 4043 of file Seq_loc.cpp.

References m_Fuzz_from, and CRange_Base::SetFrom().

◆ CopyTo()

void CRangeWithFuzz::CopyTo ( const CRangeWithFuzz rg)
inline

Definition at line 4049 of file Seq_loc.cpp.

References m_Fuzz_to, and CRange_Base::SetTo().

◆ GetFuzzFrom()

const CInt_fuzz& CRangeWithFuzz::GetFuzzFrom ( void  ) const
inline

Definition at line 4018 of file Seq_loc.cpp.

References m_Fuzz_from.

Referenced by CRangeWithFuzz().

◆ GetFuzzTo()

const CInt_fuzz& CRangeWithFuzz::GetFuzzTo ( void  ) const
inline

Definition at line 4019 of file Seq_loc.cpp.

References m_Fuzz_to.

Referenced by CRangeWithFuzz().

◆ IsSetFuzzFrom()

bool CRangeWithFuzz::IsSetFuzzFrom ( void  ) const
inline

Definition at line 4016 of file Seq_loc.cpp.

References m_Fuzz_from.

◆ IsSetFuzzTo()

bool CRangeWithFuzz::IsSetFuzzTo ( void  ) const
inline

Definition at line 4017 of file Seq_loc.cpp.

References m_Fuzz_to.

◆ operator+=() [1/2]

CRangeWithFuzz& CRangeWithFuzz::operator+= ( const CRangeWithFuzz rg)
inline

◆ operator+=() [2/2]

CRangeWithFuzz& CRangeWithFuzz::operator+= ( const TParent rg)
inline

◆ ResetFuzzFrom()

void CRangeWithFuzz::ResetFuzzFrom ( void  )
inline

Definition at line 4014 of file Seq_loc.cpp.

References m_Fuzz_from, and CConstRef< C, Locker >::Reset().

Referenced by operator+=().

◆ ResetFuzzTo()

void CRangeWithFuzz::ResetFuzzTo ( void  )
inline

Definition at line 4015 of file Seq_loc.cpp.

References m_Fuzz_to, and CConstRef< C, Locker >::Reset().

Referenced by operator+=().

◆ x_AddFuzz()

void CRangeWithFuzz::x_AddFuzz ( TFuzz fuzz,
const TFuzz other,
ENa_strand  other_strand 
)
inlineprivate

◆ x_SetFuzz()

CRef<CInt_fuzz> CRangeWithFuzz::x_SetFuzz ( TFuzz fuzz,
const CInt_fuzz copy_from 
)
inlineprivate

Definition at line 4092 of file Seq_loc.cpp.

References CSerialObject::Assign(), and CConstRef< C, Locker >::Reset().

Referenced by x_AddFuzz().

Member Data Documentation

◆ m_Fuzz_from

TFuzz CRangeWithFuzz::m_Fuzz_from
private

◆ m_Fuzz_to

TFuzz CRangeWithFuzz::m_Fuzz_to
private

◆ m_Strand

ENa_strand CRangeWithFuzz::m_Strand
private

Definition at line 4233 of file Seq_loc.cpp.

Referenced by CRangeWithFuzz(), and x_AddFuzz().


The documentation for this class was generated from the following file:
Modified on Fri May 03 15:51:56 2024 by modify_doxy.py rev. 669887