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

Search Toolkit Book for CSeq_loc_mix

#include <objects/seqloc/Seq_loc_mix.hpp>

+ Inheritance diagram for CSeq_loc_mix:
+ Collaboration diagram for CSeq_loc_mix:

Public Types

enum  ENullSegType { eNullSegAllow , eNullSegSkip }
 
- Public Types inherited from CSeq_loc_mix_Base
typedef list< CRef< CSeq_loc > > Tdata
 
- 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 Member Functions

 CSeq_loc_mix (void)
 
 ~CSeq_loc_mix (void)
 
bool IsPartialStart (ESeqLocExtremes ext) const
 
bool IsPartialStop (ESeqLocExtremes ext) const
 
void SetPartialStart (bool val, ESeqLocExtremes ext)
 
void SetPartialStop (bool val, ESeqLocExtremes ext)
 
bool IsTruncatedStart (ESeqLocExtremes ext) const
 check if parts of the seq-loc are missing More...
 
bool IsTruncatedStop (ESeqLocExtremes ext) const
 
void SetTruncatedStart (bool val, ESeqLocExtremes ext)
 set / remove e_Lim fuzz on start or stop (tl/tr - indicating removed parts of the seq-loc) More...
 
void SetTruncatedStop (bool val, ESeqLocExtremes ext)
 
void AddSeqLoc (const CSeq_loc &other)
 
void AddSeqLoc (CSeq_loc &other)
 
void AddInterval (const CSeq_id &id, TSeqPos from, TSeqPos to, ENa_strand strand=eNa_strand_unknown)
 
bool IsSetStrand (EIsSetStrand flag=eIsSetStrand_Any) const
 
ENa_strand GetStrand (void) const
 
bool IsReverseStrand (void) const
 
TSeqPos GetStart (ESeqLocExtremes ext) const
 
TSeqPos GetStop (ESeqLocExtremes ext) const
 
const CSeq_locGetFirstLoc (ENullSegType null_seg=eNullSegAllow) const
 
const CSeq_locGetLastLoc (ENullSegType null_seg=eNullSegAllow) const
 
CSeq_locSetFirstLoc (ENullSegType null_seg=eNullSegAllow)
 
CSeq_locSetLastLoc (ENullSegType null_seg=eNullSegAllow)
 
const CSeq_locGetStartLoc (ESeqLocExtremes ext, ENullSegType null_seg=eNullSegAllow) const
 
const CSeq_locGetStopLoc (ESeqLocExtremes ext, ENullSegType null_seg=eNullSegAllow) const
 
CSeq_locSetStartLoc (ESeqLocExtremes ext, ENullSegType null_seg=eNullSegAllow)
 
CSeq_locSetStopLoc (ESeqLocExtremes ext, ENullSegType null_seg=eNullSegAllow)
 
void SetStrand (ENa_strand strand)
 Set the strand for all of the location's ranges. More...
 
void ResetStrand (void)
 Reset the strand to 'not set'. More...
 
void FlipStrand (void)
 Flip the strand (e.g. plus to minus) More...
 
- Public Member Functions inherited from CSeq_loc_mix_Base
 CSeq_loc_mix_Base (void)
 
virtual ~CSeq_loc_mix_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSet (void) const
 Check if a value has been assigned to data member. More...
 
bool CanGet (void) const
 Check if it is safe to call Get method. More...
 
void Reset (void)
 Reset data member. More...
 
const TdataGet (void) const
 Get the member data. More...
 
TdataSet (void)
 Assign a value to data member. More...
 
 operator const Tdata & (void) const
 Conversion operator to 'const Tdata' type. More...
 
 operator Tdata & (void)
 Conversion operator to 'Tdata' type. 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
 

Private Types

typedef CSeq_loc_mix_Base Tparent
 

Private Member Functions

 CSeq_loc_mix (const CSeq_loc_mix &)
 
CSeq_loc_mixoperator= (const CSeq_loc_mix &)
 

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 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 54 of file Seq_loc_mix.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 56 of file Seq_loc_mix.hpp.

Member Enumeration Documentation

◆ ENullSegType

Enumerator
eNullSegAllow 
eNullSegSkip 

Definition at line 104 of file Seq_loc_mix.hpp.

Constructor & Destructor Documentation

◆ CSeq_loc_mix() [1/2]

CSeq_loc_mix::CSeq_loc_mix ( void  )

Definition at line 47 of file Seq_loc_mix.cpp.

◆ ~CSeq_loc_mix()

CSeq_loc_mix::~CSeq_loc_mix ( void  )

Definition at line 53 of file Seq_loc_mix.cpp.

◆ CSeq_loc_mix() [2/2]

CSeq_loc_mix::CSeq_loc_mix ( const CSeq_loc_mix )
private

Member Function Documentation

◆ AddInterval()

void CSeq_loc_mix::AddInterval ( const CSeq_id id,
TSeqPos  from,
TSeqPos  to,
ENa_strand  strand = eNa_strand_unknown 
)

◆ AddSeqLoc() [1/2]

void CSeq_loc_mix::AddSeqLoc ( const CSeq_loc other)

◆ AddSeqLoc() [2/2]

void CSeq_loc_mix::AddSeqLoc ( CSeq_loc other)

◆ FlipStrand()

void CSeq_loc_mix::FlipStrand ( void  )

Flip the strand (e.g. plus to minus)

Definition at line 345 of file Seq_loc_mix.cpp.

References NON_CONST_ITERATE, and CSeq_loc_mix_Base::Set().

Referenced by CSeq_loc::FlipStrand().

◆ GetFirstLoc()

const CSeq_loc * CSeq_loc_mix::GetFirstLoc ( ENullSegType  null_seg = eNullSegAllow) const

◆ GetLastLoc()

const CSeq_loc * CSeq_loc_mix::GetLastLoc ( ENullSegType  null_seg = eNullSegAllow) const

◆ GetStart()

TSeqPos CSeq_loc_mix::GetStart ( ESeqLocExtremes  ext) const

◆ GetStartLoc()

const CSeq_loc * CSeq_loc_mix::GetStartLoc ( ESeqLocExtremes  ext,
ENullSegType  null_seg = eNullSegAllow 
) const

◆ GetStop()

TSeqPos CSeq_loc_mix::GetStop ( ESeqLocExtremes  ext) const

◆ GetStopLoc()

const CSeq_loc * CSeq_loc_mix::GetStopLoc ( ESeqLocExtremes  ext,
ENullSegType  null_seg = eNullSegAllow 
) const

◆ GetStrand()

ENa_strand CSeq_loc_mix::GetStrand ( void  ) const

◆ IsPartialStart()

bool CSeq_loc_mix::IsPartialStart ( ESeqLocExtremes  ext) const

◆ IsPartialStop()

bool CSeq_loc_mix::IsPartialStop ( ESeqLocExtremes  ext) const

◆ IsReverseStrand()

bool CSeq_loc_mix::IsReverseStrand ( void  ) const
inline

Definition at line 142 of file Seq_loc_mix.hpp.

References GetStrand(), and IsReverse().

Referenced by GetStartLoc(), GetStopLoc(), SetStartLoc(), SetStopLoc(), and SplitLocationForGap().

◆ IsSetStrand()

bool CSeq_loc_mix::IsSetStrand ( EIsSetStrand  flag = eIsSetStrand_Any) const

◆ IsTruncatedStart()

bool CSeq_loc_mix::IsTruncatedStart ( ESeqLocExtremes  ext) const

check if parts of the seq-loc are missing

Definition at line 168 of file Seq_loc_mix.cpp.

References ctll::empty(), CSeq_loc_mix_Base::Get(), GetStartLoc(), and CSeq_loc::IsTruncatedStart().

Referenced by CSeq_loc::IsTruncatedStart(), and SetTruncatedStart().

◆ IsTruncatedStop()

bool CSeq_loc_mix::IsTruncatedStop ( ESeqLocExtremes  ext) const

◆ operator=()

CSeq_loc_mix& CSeq_loc_mix::operator= ( const CSeq_loc_mix )
private

◆ ResetStrand()

void CSeq_loc_mix::ResetStrand ( void  )

Reset the strand to 'not set'.

Definition at line 337 of file Seq_loc_mix.cpp.

References NON_CONST_ITERATE, and CSeq_loc_mix_Base::Set().

Referenced by CSeq_loc::ResetStrand().

◆ SetFirstLoc()

CSeq_loc * CSeq_loc_mix::SetFirstLoc ( ENullSegType  null_seg = eNullSegAllow)

◆ SetLastLoc()

CSeq_loc * CSeq_loc_mix::SetLastLoc ( ENullSegType  null_seg = eNullSegAllow)

◆ SetPartialStart()

void CSeq_loc_mix::SetPartialStart ( bool  val,
ESeqLocExtremes  ext 
)

◆ SetPartialStop()

void CSeq_loc_mix::SetPartialStop ( bool  val,
ESeqLocExtremes  ext 
)

◆ SetStartLoc()

CSeq_loc * CSeq_loc_mix::SetStartLoc ( ESeqLocExtremes  ext,
ENullSegType  null_seg = eNullSegAllow 
)

◆ SetStopLoc()

CSeq_loc * CSeq_loc_mix::SetStopLoc ( ESeqLocExtremes  ext,
ENullSegType  null_seg = eNullSegAllow 
)

Definition at line 126 of file Seq_loc_mix.cpp.

References eExtreme_Positional, IsReverseStrand(), SetFirstLoc(), and SetLastLoc().

Referenced by SetPartialStop(), and SetTruncatedStop().

◆ SetStrand()

void CSeq_loc_mix::SetStrand ( ENa_strand  strand)

Set the strand for all of the location's ranges.

Definition at line 329 of file Seq_loc_mix.cpp.

References NON_CONST_ITERATE, and CSeq_loc_mix_Base::Set().

Referenced by CSeq_loc::SetStrand().

◆ SetTruncatedStart()

void CSeq_loc_mix::SetTruncatedStart ( bool  val,
ESeqLocExtremes  ext 
)

set / remove e_Lim fuzz on start or stop (tl/tr - indicating removed parts of the seq-loc)

Definition at line 185 of file Seq_loc_mix.cpp.

References ctll::empty(), IsTruncatedStart(), CSeq_loc_mix_Base::Set(), SetStartLoc(), CSeq_loc::SetTruncatedStart(), and val.

Referenced by CSeq_loc::SetTruncatedStart().

◆ SetTruncatedStop()

void CSeq_loc_mix::SetTruncatedStop ( bool  val,
ESeqLocExtremes  ext 
)

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