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

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

Search Toolkit Book for CEntrez2_docsum

#include <objects/entrez2/Entrez2_docsum.hpp>

+ Inheritance diagram for CEntrez2_docsum:
+ Collaboration diagram for CEntrez2_docsum:

Public Member Functions

 CEntrez2_docsum (void)
 
 ~CEntrez2_docsum (void)
 
const stringGetValue (const string &key) const
 
const CEntrez2_docsum_dataFindValue (const string &key_name) const
 
- Public Member Functions inherited from CEntrez2_docsum_Base
 CEntrez2_docsum_Base (void)
 
virtual ~CEntrez2_docsum_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetUid (void) const
 primary uid (gi, pubmedid) Check if a value has been assigned to Uid data member. More...
 
bool CanGetUid (void) const
 Check if it is safe to call GetUid method. More...
 
void ResetUid (void)
 Reset Uid data member. More...
 
TUid GetUid (void) const
 Get the Uid member data. More...
 
void SetUid (TUid value)
 Assign a value to Uid data member. More...
 
TUidSetUid (void)
 Assign a value to Uid data member. More...
 
bool IsSetDocsum_data (void) const
 Check if a value has been assigned to Docsum_data data member. More...
 
bool CanGetDocsum_data (void) const
 Check if it is safe to call GetDocsum_data method. More...
 
void ResetDocsum_data (void)
 Reset Docsum_data data member. More...
 
const TDocsum_dataGetDocsum_data (void) const
 Get the Docsum_data member data. More...
 
TDocsum_dataSetDocsum_data (void)
 Assign a value to Docsum_data 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 CEntrez2_docsum_Base Tparent
 

Private Member Functions

 CEntrez2_docsum (const CEntrez2_docsum &value)
 
CEntrez2_docsumoperator= (const CEntrez2_docsum &value)
 

Additional Inherited Members

- Public Types inherited from CEntrez2_docsum_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_uid , e_docsum_data }
 
typedef NCBI_NS_NCBI::TEntrezId TUid
 
typedef list< CRef< CEntrez2_docsum_data > > TDocsum_data
 
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...
 
- 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 50 of file Entrez2_docsum.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 52 of file Entrez2_docsum.hpp.

Constructor & Destructor Documentation

◆ CEntrez2_docsum() [1/2]

CEntrez2_docsum::CEntrez2_docsum ( void  )
inline

Definition at line 80 of file Entrez2_docsum.hpp.

◆ ~CEntrez2_docsum()

CEntrez2_docsum::~CEntrez2_docsum ( void  )

Definition at line 51 of file Entrez2_docsum.cpp.

◆ CEntrez2_docsum() [2/2]

CEntrez2_docsum::CEntrez2_docsum ( const CEntrez2_docsum value)
private

Member Function Documentation

◆ FindValue()

const CEntrez2_docsum_data * CEntrez2_docsum::FindValue ( const string key_name) const

◆ GetValue()

const string & CEntrez2_docsum::GetValue ( const string key) const

◆ operator=()

CEntrez2_docsum& CEntrez2_docsum::operator= ( const CEntrez2_docsum value)
private

The documentation for this class was generated from the following files:
Modified on Tue May 28 05:49:53 2024 by modify_doxy.py rev. 669887