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

Represents ASN.1 type Entrez2-db-info defined in file entrez2.asn

Search Toolkit Book for CEntrez2_db_info_Base

info for one database More...

#include <objects/entrez2/Entrez2_db_info_.hpp>

+ Inheritance diagram for CEntrez2_db_info_Base:
+ Collaboration diagram for CEntrez2_db_info_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_db_name , e_db_menu , e_db_descr ,
  e_doc_count , e_field_count , e_fields , e_link_count ,
  e_links , e_docsum_field_count , e_docsum_fields
}
 
typedef CEntrez2_db_id TDb_name
 
typedef string TDb_menu
 
typedef string TDb_descr
 
typedef int TDoc_count
 
typedef int TField_count
 
typedef list< CRef< CEntrez2_field_info > > TFields
 
typedef int TLink_count
 
typedef list< CRef< CEntrez2_link_info > > TLinks
 
typedef int TDocsum_field_count
 
typedef list< CRef< CEntrez2_docsum_field_info > > TDocsum_fields
 
typedef Tparent::CMemberIndex< E_memberIndex, 11 > 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

 CEntrez2_db_info_Base (void)
 
virtual ~CEntrez2_db_info_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetDb_name (void) const
 internal name Check if a value has been assigned to Db_name data member. More...
 
bool CanGetDb_name (void) const
 Check if it is safe to call GetDb_name method. More...
 
void ResetDb_name (void)
 Reset Db_name data member. More...
 
const TDb_nameGetDb_name (void) const
 Get the Db_name member data. More...
 
void SetDb_name (const TDb_name &value)
 Assign a value to Db_name data member. More...
 
TDb_nameSetDb_name (void)
 Assign a value to Db_name data member. More...
 
bool IsSetDb_menu (void) const
 short name for menu Check if a value has been assigned to Db_menu data member. More...
 
bool CanGetDb_menu (void) const
 Check if it is safe to call GetDb_menu method. More...
 
void ResetDb_menu (void)
 Reset Db_menu data member. More...
 
const TDb_menuGetDb_menu (void) const
 Get the Db_menu member data. More...
 
void SetDb_menu (const TDb_menu &value)
 Assign a value to Db_menu data member. More...
 
void SetDb_menu (TDb_menu &&value)
 
TDb_menuSetDb_menu (void)
 Assign a value to Db_menu data member. More...
 
bool IsSetDb_descr (void) const
 longer explanatory name Check if a value has been assigned to Db_descr data member. More...
 
bool CanGetDb_descr (void) const
 Check if it is safe to call GetDb_descr method. More...
 
void ResetDb_descr (void)
 Reset Db_descr data member. More...
 
const TDb_descrGetDb_descr (void) const
 Get the Db_descr member data. More...
 
void SetDb_descr (const TDb_descr &value)
 Assign a value to Db_descr data member. More...
 
void SetDb_descr (TDb_descr &&value)
 
TDb_descrSetDb_descr (void)
 Assign a value to Db_descr data member. More...
 
bool IsSetDoc_count (void) const
 total number of records Check if a value has been assigned to Doc_count data member. More...
 
bool CanGetDoc_count (void) const
 Check if it is safe to call GetDoc_count method. More...
 
void ResetDoc_count (void)
 Reset Doc_count data member. More...
 
TDoc_count GetDoc_count (void) const
 Get the Doc_count member data. More...
 
void SetDoc_count (TDoc_count value)
 Assign a value to Doc_count data member. More...
 
TDoc_countSetDoc_count (void)
 Assign a value to Doc_count data member. More...
 
bool IsSetField_count (void) const
 number of field types Check if a value has been assigned to Field_count data member. More...
 
bool CanGetField_count (void) const
 Check if it is safe to call GetField_count method. More...
 
void ResetField_count (void)
 Reset Field_count data member. More...
 
TField_count GetField_count (void) const
 Get the Field_count member data. More...
 
void SetField_count (TField_count value)
 Assign a value to Field_count data member. More...
 
TField_countSetField_count (void)
 Assign a value to Field_count data member. More...
 
bool IsSetFields (void) const
 Check if a value has been assigned to Fields data member. More...
 
bool CanGetFields (void) const
 Check if it is safe to call GetFields method. More...
 
void ResetFields (void)
 Reset Fields data member. More...
 
const TFieldsGetFields (void) const
 Get the Fields member data. More...
 
TFieldsSetFields (void)
 Assign a value to Fields data member. More...
 
bool IsSetLink_count (void) const
 number of link types Check if a value has been assigned to Link_count data member. More...
 
bool CanGetLink_count (void) const
 Check if it is safe to call GetLink_count method. More...
 
void ResetLink_count (void)
 Reset Link_count data member. More...
 
TLink_count GetLink_count (void) const
 Get the Link_count member data. More...
 
void SetLink_count (TLink_count value)
 Assign a value to Link_count data member. More...
 
TLink_countSetLink_count (void)
 Assign a value to Link_count data member. More...
 
bool IsSetLinks (void) const
 Check if a value has been assigned to Links data member. More...
 
bool CanGetLinks (void) const
 Check if it is safe to call GetLinks method. More...
 
void ResetLinks (void)
 Reset Links data member. More...
 
const TLinksGetLinks (void) const
 Get the Links member data. More...
 
TLinksSetLinks (void)
 Assign a value to Links data member. More...
 
bool IsSetDocsum_field_count (void) const
 Check if a value has been assigned to Docsum_field_count data member. More...
 
bool CanGetDocsum_field_count (void) const
 Check if it is safe to call GetDocsum_field_count method. More...
 
void ResetDocsum_field_count (void)
 Reset Docsum_field_count data member. More...
 
TDocsum_field_count GetDocsum_field_count (void) const
 Get the Docsum_field_count member data. More...
 
void SetDocsum_field_count (TDocsum_field_count value)
 Assign a value to Docsum_field_count data member. More...
 
TDocsum_field_countSetDocsum_field_count (void)
 Assign a value to Docsum_field_count data member. More...
 
bool IsSetDocsum_fields (void) const
 Check if a value has been assigned to Docsum_fields data member. More...
 
bool CanGetDocsum_fields (void) const
 Check if it is safe to call GetDocsum_fields method. More...
 
void ResetDocsum_fields (void)
 Reset Docsum_fields data member. More...
 
const TDocsum_fieldsGetDocsum_fields (void) const
 Get the Docsum_fields member data. More...
 
TDocsum_fieldsSetDocsum_fields (void)
 Assign a value to Docsum_fields 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

 CEntrez2_db_info_Base (const CEntrez2_db_info_Base &)
 
CEntrez2_db_info_Baseoperator= (const CEntrez2_db_info_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
CEntrez2_db_id m_Db_name
 
string m_Db_menu
 
string m_Db_descr
 
int m_Doc_count
 
int m_Field_count
 
list< CRef< CEntrez2_field_info > > m_Fields
 
int m_Link_count
 
list< CRef< CEntrez2_link_info > > m_Links
 
int m_Docsum_field_count
 
list< CRef< CEntrez2_docsum_field_info > > m_Docsum_fields
 

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

info for one database

CEntrez2_db_info_Base

Definition at line 81 of file Entrez2_db_info_.hpp.


The documentation for this class was generated from the following files:
Modified on Thu Jul 18 15:59:30 2024 by modify_doxy.py rev. 669887