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

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

Search Toolkit Book for CEntrez2_id_list

#include <objects/entrez2/Entrez2_id_list.hpp>

+ Inheritance diagram for CEntrez2_id_list:
+ Collaboration diagram for CEntrez2_id_list:

Public Types

typedef TIntId TUid
 
typedef CConstResizingIterator< TUids, TUidTConstUidIterator
 
typedef CResizingIterator< TUids, TUidTUidIterator
 
- Public Types inherited from CEntrez2_id_list_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_db , e_num , e_uids }
 
typedef CEntrez2_db_id TDb
 
typedef int TNum
 
typedef vector< char > TUids
 
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

 CEntrez2_id_list (void)
 
 ~CEntrez2_id_list (void)
 
TUidIterator GetUidIterator ()
 
TConstUidIterator GetConstUidIterator () const
 
void Resize (size_t size)
 
void AssignUids (const vector< TUid > &uids)
 
size_t GetUidSizeBits (void) const
 
size_t GetUidSizeBytes (void) const
 
void PackUids (void)
 
- Public Member Functions inherited from CEntrez2_id_list_Base
 CEntrez2_id_list_Base (void)
 
virtual ~CEntrez2_id_list_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetDb (void) const
 the database Check if a value has been assigned to Db data member. More...
 
bool CanGetDb (void) const
 Check if it is safe to call GetDb method. More...
 
void ResetDb (void)
 Reset Db data member. More...
 
const TDbGetDb (void) const
 Get the Db member data. More...
 
void SetDb (const TDb &value)
 Assign a value to Db data member. More...
 
TDbSetDb (void)
 Assign a value to Db data member. More...
 
bool IsSetNum (void) const
 number of uids Check if a value has been assigned to Num data member. More...
 
bool CanGetNum (void) const
 Check if it is safe to call GetNum method. More...
 
void ResetNum (void)
 Reset Num data member. More...
 
TNum GetNum (void) const
 Get the Num member data. More...
 
void SetNum (TNum value)
 Assign a value to Num data member. More...
 
TNumSetNum (void)
 Assign a value to Num data member. More...
 
bool IsSetUids (void) const
 coded uids Check if a value has been assigned to Uids data member. More...
 
bool CanGetUids (void) const
 Check if it is safe to call GetUids method. More...
 
void ResetUids (void)
 Reset Uids data member. More...
 
const TUidsGetUids (void) const
 Get the Uids member data. More...
 
TUidsSetUids (void)
 Assign a value to Uids 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
 

Static Public Attributes

static const size_t sm_UidSize = sizeof(CEntrez2_id_list::TUid)
 
- 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...
 

Private Types

typedef CEntrez2_id_list_Base Tparent
 

Private Member Functions

void x_SetNativeUidSize (void)
 
 CEntrez2_id_list (const CEntrez2_id_list &value)
 
CEntrez2_id_listoperator= (const CEntrez2_id_list &value)
 

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)
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 

Detailed Description

Definition at line 52 of file Entrez2_id_list.hpp.

Member Typedef Documentation

◆ TConstUidIterator

Definition at line 57 of file Entrez2_id_list.hpp.

◆ Tparent

Definition at line 54 of file Entrez2_id_list.hpp.

◆ TUid

Definition at line 56 of file Entrez2_id_list.hpp.

◆ TUidIterator

Definition at line 58 of file Entrez2_id_list.hpp.

Constructor & Destructor Documentation

◆ CEntrez2_id_list() [1/2]

CEntrez2_id_list::CEntrez2_id_list ( void  )
inline

Definition at line 99 of file Entrez2_id_list.hpp.

◆ ~CEntrez2_id_list()

CEntrez2_id_list::~CEntrez2_id_list ( void  )

Definition at line 74 of file Entrez2_id_list.cpp.

◆ CEntrez2_id_list() [2/2]

CEntrez2_id_list::CEntrez2_id_list ( const CEntrez2_id_list value)
private

Member Function Documentation

◆ AssignUids()

void CEntrez2_id_list::AssignUids ( const vector< TUid > &  uids)

◆ GetConstUidIterator()

CEntrez2_id_list::TConstUidIterator CEntrez2_id_list::GetConstUidIterator ( ) const

◆ GetUidIterator()

CEntrez2_id_list::TUidIterator CEntrez2_id_list::GetUidIterator ( )

◆ GetUidSizeBits()

size_t CEntrez2_id_list::GetUidSizeBits ( void  ) const

Definition at line 98 of file Entrez2_id_list.cpp.

References GetUidSizeBytes().

Referenced by GetConstUidIterator(), and GetUidIterator().

◆ GetUidSizeBytes()

size_t CEntrez2_id_list::GetUidSizeBytes ( void  ) const

◆ operator=()

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

◆ PackUids()

void CEntrez2_id_list::PackUids ( void  )

◆ Resize()

void CEntrez2_id_list::Resize ( size_t  size)

◆ x_SetNativeUidSize()

void CEntrez2_id_list::x_SetNativeUidSize ( void  )
private

Member Data Documentation

◆ sm_UidSize

const size_t CEntrez2_id_list::sm_UidSize = sizeof(CEntrez2_id_list::TUid)
static

Definition at line 77 of file Entrez2_id_list.hpp.


The documentation for this class was generated from the following files:
Modified on Sun Apr 14 05:25:48 2024 by modify_doxy.py rev. 669887