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

Search Toolkit Book for CBiostruc_feature_set_Base

Named model features refer to sets of residues or atoms, or a region in the model space. More...

#include <objects/mmdb3/Biostruc_feature_set_.hpp>

+ Inheritance diagram for CBiostruc_feature_set_Base:
+ Collaboration diagram for CBiostruc_feature_set_Base:

Public Types

enum class  E_memberIndex { e__allMandatory = 0 , e_id , e_descr , e_features }
 
typedef CBiostruc_feature_set_id TId
 
typedef list< CRef< CBiostruc_feature_set_descr > > TDescr
 
typedef list< CRef< CBiostruc_feature > > TFeatures
 
typedef Tparent::CMemberIndex< E_memberIndex, 4 > 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 Member Functions

 CBiostruc_feature_set_Base (void)
 
virtual ~CBiostruc_feature_set_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetId (void) const
 Check if a value has been assigned to Id data member. More...
 
bool CanGetId (void) const
 Check if it is safe to call GetId method. More...
 
void ResetId (void)
 Reset Id data member. More...
 
const TIdGetId (void) const
 Get the Id member data. More...
 
void SetId (const TId &value)
 Assign a value to Id data member. More...
 
TIdSetId (void)
 Assign a value to Id data member. More...
 
bool IsSetDescr (void) const
 Check if a value has been assigned to Descr data member. More...
 
bool CanGetDescr (void) const
 Check if it is safe to call GetDescr method. More...
 
void ResetDescr (void)
 Reset Descr data member. More...
 
const TDescrGetDescr (void) const
 Get the Descr member data. More...
 
TDescrSetDescr (void)
 Assign a value to Descr data member. More...
 
bool IsSetFeatures (void) const
 Check if a value has been assigned to Features data member. More...
 
bool CanGetFeatures (void) const
 Check if it is safe to call GetFeatures method. More...
 
void ResetFeatures (void)
 Reset Features data member. More...
 
const TFeaturesGetFeatures (void) const
 Get the Features member data. More...
 
TFeaturesSetFeatures (void)
 Assign a value to Features 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
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 CBiostruc_feature_set_Base (const CBiostruc_feature_set_Base &)
 
CBiostruc_feature_set_Baseoperator= (const CBiostruc_feature_set_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
CBiostruc_feature_set_id m_Id
 
list< CRef< CBiostruc_feature_set_descr > > m_Descr
 
list< CRef< CBiostruc_feature > > m_Features
 

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

Named model features refer to sets of residues or atoms, or a region in the model space.

A few specific feature types are allowed for compatibility with PDB usage, but the purpose of a named model feature is simply to associate various types of information with a set of atoms or residues, or a spatially-defined region of the model structure. They also support association of various properties with each residue or atom of a set. PDB-derived secondary structure defines a single feature, represented as a sequence of residue motifs, as are the contents of PDB SITE and FTNOTE records. NCBI-assigned core and secondary structure descriptions are also represented as a sequence of residue motifs.

CBiostruc_feature_set_Base

Definition at line 89 of file Biostruc_feature_set_.hpp.


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