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

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

Search Toolkit Book for CEntrez2_docsum_list_Base

CEntrez2_docsum_list_Base –. More...

#include <objects/entrez2/Entrez2_docsum_list_.hpp>

+ Inheritance diagram for CEntrez2_docsum_list_Base:
+ Collaboration diagram for CEntrez2_docsum_list_Base:

Public Types

typedef int TCount
 
typedef list< CRef< CEntrez2_docsum > > TList
 
- 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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CEntrez2_docsum_list_Base (void)
 
virtual ~CEntrez2_docsum_list_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetCount (void) const
 number of docsums Check if a value has been assigned to Count data member. More...
 
bool CanGetCount (void) const
 Check if it is safe to call GetCount method. More...
 
void ResetCount (void)
 Reset Count data member. More...
 
TCount GetCount (void) const
 Get the Count member data. More...
 
void SetCount (TCount value)
 Assign a value to Count data member. More...
 
TCountSetCount (void)
 Assign a value to Count data member. More...
 
bool IsSetList (void) const
 Check if a value has been assigned to List data member. More...
 
bool CanGetList (void) const
 Check if it is safe to call GetList method. More...
 
void ResetList (void)
 Reset List data member. More...
 
const TListGetList (void) const
 Get the List member data. More...
 
TListSetList (void)
 Assign a value to List 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_docsum_list_Base (const CEntrez2_docsum_list_Base &)
 
CEntrez2_docsum_list_Baseoperator= (const CEntrez2_docsum_list_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Count
 
list< CRef< CEntrez2_docsum > > m_List
 

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_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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

CEntrez2_docsum_list_Base –.

Definition at line 76 of file Entrez2_docsum_list_.hpp.

Member Typedef Documentation

Definition at line 89 of file Entrez2_docsum_list_.hpp.

Definition at line 90 of file Entrez2_docsum_list_.hpp.

Definition at line 78 of file Entrez2_docsum_list_.hpp.

Constructor & Destructor Documentation

END_CLASS_INFO CEntrez2_docsum_list_Base::CEntrez2_docsum_list_Base ( void  )

Definition at line 74 of file Entrez2_docsum_list_.cpp.

References m_set_State.

CEntrez2_docsum_list_Base::~CEntrez2_docsum_list_Base ( void  )
virtual

Definition at line 81 of file Entrez2_docsum_list_.cpp.

CEntrez2_docsum_list_Base::CEntrez2_docsum_list_Base ( const CEntrez2_docsum_list_Base )
private

Member Function Documentation

bool CEntrez2_docsum_list_Base::CanGetCount ( void  ) const
inline

Check if it is safe to call GetCount method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 195 of file Entrez2_docsum_list_.hpp.

References IsSetCount().

Referenced by GetCount().

bool CEntrez2_docsum_list_Base::CanGetList ( void  ) const
inline

Check if it is safe to call GetList method.

Returns
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 242 of file Entrez2_docsum_list_.hpp.

CEntrez2_docsum_list_Base::DECLARE_INTERNAL_TYPE_INFO ( )
CEntrez2_docsum_list_Base::TCount CEntrez2_docsum_list_Base::GetCount ( void  ) const
inline

Get the Count member data.

Returns
Copy of the member data.

Definition at line 208 of file Entrez2_docsum_list_.hpp.

References CanGetCount(), m_Count, and CSerialObject::ThrowUnassigned().

Referenced by CId1FetchApp::LookUpGI(), and CSeqFetchApp::xWriteSequence().

const CEntrez2_docsum_list_Base::TList & CEntrez2_docsum_list_Base::GetList ( void  ) const
inline

Get the List member data.

Returns
Reference to the member data.

Definition at line 248 of file Entrez2_docsum_list_.hpp.

References m_List.

Referenced by CAltValidator::QueryAccessions(), and CGeneModelFeatJob::x_ProcessLandMarkFeatures().

bool CEntrez2_docsum_list_Base::IsSetCount ( void  ) const
inline

number of docsums Check if a value has been assigned to Count data member.

Data member Count is mandatory; its type is defined as 'typedef int TCount'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 189 of file Entrez2_docsum_list_.hpp.

References m_set_State.

Referenced by CanGetCount(), and SetCount().

bool CEntrez2_docsum_list_Base::IsSetList ( void  ) const
inline

Check if a value has been assigned to List data member.

Data member List is mandatory; its type is defined as 'typedef list< CRef< CEntrez2_docsum > > TList'

Returns
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 236 of file Entrez2_docsum_list_.hpp.

References m_set_State.

Referenced by CGeneModelFeatJob::x_ProcessLandMarkFeatures().

CEntrez2_docsum_list_Base& CEntrez2_docsum_list_Base::operator= ( const CEntrez2_docsum_list_Base )
private
void CEntrez2_docsum_list_Base::Reset ( void  )
virtual

Reset the whole object.

Definition at line 57 of file Entrez2_docsum_list_.cpp.

References ResetCount(), and ResetList().

void CEntrez2_docsum_list_Base::ResetCount ( void  )
inline

Reset Count data member.

Definition at line 201 of file Entrez2_docsum_list_.hpp.

References m_Count, and m_set_State.

Referenced by Reset().

void CEntrez2_docsum_list_Base::ResetList ( void  )

Reset List data member.

Definition at line 51 of file Entrez2_docsum_list_.cpp.

References m_List, and m_set_State.

Referenced by Reset().

void CEntrez2_docsum_list_Base::SetCount ( TCount  value)

Assign a value to Count data member.

Parameters
valueValue to assign
CEntrez2_docsum_list_Base::TCount & CEntrez2_docsum_list_Base::SetCount ( void  )
inline

Assign a value to Count data member.

Returns
Reference to the data value.

Definition at line 224 of file Entrez2_docsum_list_.hpp.

References IsSetCount(), m_Count, m_set_State, and CSerialObject::UnassignedByte().

CEntrez2_docsum_list_Base::TList & CEntrez2_docsum_list_Base::SetList ( void  )
inline

Assign a value to List data member.

Returns
Reference to the data value.

Definition at line 254 of file Entrez2_docsum_list_.hpp.

References m_List, and m_set_State.

Member Data Documentation

int CEntrez2_docsum_list_Base::m_Count
private

Definition at line 175 of file Entrez2_docsum_list_.hpp.

Referenced by GetCount(), ResetCount(), and SetCount().

list< CRef< CEntrez2_docsum > > CEntrez2_docsum_list_Base::m_List
private

Definition at line 176 of file Entrez2_docsum_list_.hpp.

Referenced by GetList(), ResetList(), and SetList().

Uint4 CEntrez2_docsum_list_Base::m_set_State[1]
private

The documentation for this class was generated from the following files:
Modified on Wed Aug 16 06:04:10 2017 by modify_doxy.py rev. 533848