|
NCBI C++ ToolKit
|
Search Toolkit Book for CPDB_seq_id
#include <objects/seqloc/PDB_seq_id.hpp>
Inheritance diagram for CPDB_seq_id:
Collaboration diagram for CPDB_seq_id:Public Types | |
| enum | EBothUnsetPriority { eBothUnset_Chain , eBothUnset_ChainId } |
| enum | EConflictMode { eConflictMode_default , eConflictMode_legacy } |
Public Types inherited from CPDB_seq_id_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_mol , e_chain , e_rel , e_chain_id } |
| typedef CPDB_mol_id | TMol |
| typedef int | TChain |
| typedef CDate | TRel |
| typedef string | TChain_id |
| typedef Tparent::CMemberIndex< E_memberIndex, 5 > | 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< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
Public Member Functions | |
| CPDB_seq_id (void) | |
| ~CPDB_seq_id (void) | |
| bool | Match (const CPDB_seq_id &psip2) const |
| int | Compare (const CPDB_seq_id &psip2) const |
| ostream & | AsFastaString (ostream &s) const |
| void | ResetChainIdentifiers (void) |
| void | SetChainIdentifiers (TChain chainIdentifier) |
| void | SetChainIdentifiers (const TChain_id &chainIdentifier) |
| string | GetEffectiveChain_id (EBothUnsetPriority bothUnsetPriority=eBothUnset_ChainId) const |
| bool | IsChainConflict (EConflictMode encodingMode=eConflictMode_default) const |
Public Member Functions inherited from CPDB_seq_id_Base | |
| CPDB_seq_id_Base (void) | |
| virtual | ~CPDB_seq_id_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetMol (void) const |
| the molecule name Check if a value has been assigned to Mol data member. More... | |
| bool | CanGetMol (void) const |
| Check if it is safe to call GetMol method. More... | |
| void | ResetMol (void) |
| Reset Mol data member. More... | |
| const TMol & | GetMol (void) const |
| Get the Mol member data. More... | |
| void | SetMol (const TMol &value) |
| Assign a value to Mol data member. More... | |
| TMol & | SetMol (void) |
| Assign a value to Mol data member. More... | |
| bool | IsSetChain (void) const |
| Deprecated: 'chain' can't support multiple character PDB chain identifiers (introduced in 2015). More... | |
| bool | CanGetChain (void) const |
| Check if it is safe to call GetChain method. More... | |
| void | ResetChain (void) |
| Reset Chain data member. More... | |
| void | SetDefaultChain (void) |
| Assign default value to Chain data member. More... | |
| TChain | GetChain (void) const |
| Get the Chain member data. More... | |
| void | SetChain (TChain value) |
| Assign a value to Chain data member. More... | |
| TChain & | SetChain (void) |
| Assign a value to Chain data member. More... | |
| bool | IsSetRel (void) const |
| release date, month and year Check if a value has been assigned to Rel data member. More... | |
| bool | CanGetRel (void) const |
| Check if it is safe to call GetRel method. More... | |
| void | ResetRel (void) |
| Reset Rel data member. More... | |
| const TRel & | GetRel (void) const |
| Get the Rel member data. More... | |
| void | SetRel (TRel &value) |
| Assign a value to Rel data member. More... | |
| TRel & | SetRel (void) |
| Assign a value to Rel data member. More... | |
| bool | IsSetChain_id (void) const |
| chain identifier; length-independent generalization of 'chain' Check if a value has been assigned to Chain_id data member. More... | |
| bool | CanGetChain_id (void) const |
| Check if it is safe to call GetChain_id method. More... | |
| void | ResetChain_id (void) |
| Reset Chain_id data member. More... | |
| const TChain_id & | GetChain_id (void) const |
| Get the Chain_id member data. More... | |
| void | SetChain_id (const TChain_id &value) |
| Assign a value to Chain_id data member. More... | |
| void | SetChain_id (TChain_id &&value) |
| TChain_id & | SetChain_id (void) |
| Assign a value to Chain_id 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 CTypeInfo * | GetThisTypeInfo (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 string & | GetNamespaceName (void) const |
| Get namespace name. More... | |
| bool | HasNamespacePrefix (void) const |
| Check if data type has namespace prefix. More... | |
| const string & | GetNamespacePrefix (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... | |
| CObject & | operator= (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 CPDB_seq_id_Base | Tparent |
Private Member Functions | |
| CPDB_seq_id (const CPDB_seq_id &) | |
| CPDB_seq_id & | operator= (const CPDB_seq_id &) |
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... | |
Definition at line 50 of file PDB_seq_id.hpp.
|
private |
Definition at line 52 of file PDB_seq_id.hpp.
| Enumerator | |
|---|---|
| eBothUnset_Chain | |
| eBothUnset_ChainId | |
Definition at line 83 of file PDB_seq_id.hpp.
| Enumerator | |
|---|---|
| eConflictMode_default | |
| eConflictMode_legacy | |
Definition at line 101 of file PDB_seq_id.hpp.
|
inline |
Definition at line 128 of file PDB_seq_id.hpp.
| CPDB_seq_id::~CPDB_seq_id | ( | void | ) |
Definition at line 46 of file PDB_seq_id.cpp.
|
private |
| ostream & CPDB_seq_id::AsFastaString | ( | ostream & | s | ) | const |
Definition at line 94 of file PDB_seq_id.cpp.
References CAliasBase< TPrim >::Get(), CPDB_seq_id_Base::GetChain(), CPDB_seq_id_Base::GetChain_id(), CPDB_seq_id_Base::GetMol(), and CPDB_seq_id_Base::IsSetChain_id().
Referenced by CSeq_id::x_WriteContentAsFasta().
| int CPDB_seq_id::Compare | ( | const CPDB_seq_id & | psip2 | ) | const |
Definition at line 81 of file PDB_seq_id.cpp.
References CPDB_seq_id_Base::GetChain_id(), CPDB_seq_id_Base::GetMol(), CPDB_seq_id_Base::IsSetChain_id(), and s_GetEffectiveChain_id().
Referenced by CSeq_id::CompareOrdered(), and Match().
| string CPDB_seq_id::GetEffectiveChain_id | ( | EBothUnsetPriority | bothUnsetPriority = eBothUnset_ChainId | ) | const |
Definition at line 116 of file PDB_seq_id.cpp.
References eBothUnset_Chain, CPDB_seq_id_Base::GetChain(), CPDB_seq_id_Base::IsSetChain(), CPDB_seq_id_Base::IsSetChain_id(), s_GetEffectiveChain_id(), and string.
Referenced by ExtractPdbMolChain(), and GetAccessionAndDatabaseSource().
| bool CPDB_seq_id::IsChainConflict | ( | EConflictMode | encodingMode = eConflictMode_default | ) | const |
Definition at line 126 of file PDB_seq_id.cpp.
References eConflictMode_default, eConflictMode_legacy, CPDB_seq_id_Base::GetChain(), CPDB_seq_id_Base::GetChain_id(), isdigit(), islower(), CPDB_seq_id_Base::IsSetChain(), CPDB_seq_id_Base::IsSetChain_id(), isupper(), and NStr::ToUpper().
| bool CPDB_seq_id::Match | ( | const CPDB_seq_id & | psip2 | ) | const |
Definition at line 53 of file PDB_seq_id.cpp.
References Compare(), CPDB_seq_id_Base::GetChain(), CPDB_seq_id_Base::GetChain_id(), CPDB_seq_id_Base::GetMol(), CPDB_seq_id_Base::IsSetChain(), and CPDB_seq_id_Base::IsSetChain_id().
Referenced by CSeq_id::Compare().
|
private |
| void CPDB_seq_id::ResetChainIdentifiers | ( | void | ) |
Definition at line 157 of file PDB_seq_id.cpp.
References CPDB_seq_id_Base::ResetChain(), and CPDB_seq_id_Base::ResetChain_id().
Referenced by SetChainIdentifiers().
Definition at line 163 of file PDB_seq_id.cpp.
References CTempString::empty(), NStr::eTrunc_Both, CTempString::length(), CPDB_seq_id_Base::ResetChain(), ResetChainIdentifiers(), CPDB_seq_id_Base::SetChain(), CPDB_seq_id_Base::SetChain_id(), and NStr::TruncateSpaces_Unsafe().
| void CPDB_seq_id::SetChainIdentifiers | ( | CPDB_seq_id::TChain | chain | ) |
Definition at line 186 of file PDB_seq_id.cpp.