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

Search Toolkit Book for CGB_block

#include <objects/seqblock/GB_block.hpp>

+ Inheritance diagram for CGB_block:
+ Collaboration diagram for CGB_block:

Public Member Functions

 CGB_block (void)
 
 ~CGB_block (void)
 
bool IsEmpty (void) const
 
- Public Member Functions inherited from CGB_block_Base
 CGB_block_Base (void)
 
virtual ~CGB_block_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetExtra_accessions (void) const
 Check if a value has been assigned to Extra_accessions data member. More...
 
bool CanGetExtra_accessions (void) const
 Check if it is safe to call GetExtra_accessions method. More...
 
void ResetExtra_accessions (void)
 Reset Extra_accessions data member. More...
 
const TExtra_accessionsGetExtra_accessions (void) const
 Get the Extra_accessions member data. More...
 
TExtra_accessionsSetExtra_accessions (void)
 Assign a value to Extra_accessions data member. More...
 
bool IsSetSource (void) const
 source line Check if a value has been assigned to Source data member. More...
 
bool CanGetSource (void) const
 Check if it is safe to call GetSource method. More...
 
void ResetSource (void)
 Reset Source data member. More...
 
const TSourceGetSource (void) const
 Get the Source member data. More...
 
void SetSource (const TSource &value)
 Assign a value to Source data member. More...
 
void SetSource (TSource &&value)
 
TSourceSetSource (void)
 Assign a value to Source data member. More...
 
bool IsSetKeywords (void) const
 Check if a value has been assigned to Keywords data member. More...
 
bool CanGetKeywords (void) const
 Check if it is safe to call GetKeywords method. More...
 
void ResetKeywords (void)
 Reset Keywords data member. More...
 
const TKeywordsGetKeywords (void) const
 Get the Keywords member data. More...
 
TKeywordsSetKeywords (void)
 Assign a value to Keywords data member. More...
 
bool IsSetOrigin (void) const
 Check if a value has been assigned to Origin data member. More...
 
bool CanGetOrigin (void) const
 Check if it is safe to call GetOrigin method. More...
 
void ResetOrigin (void)
 Reset Origin data member. More...
 
const TOriginGetOrigin (void) const
 Get the Origin member data. More...
 
void SetOrigin (const TOrigin &value)
 Assign a value to Origin data member. More...
 
void SetOrigin (TOrigin &&value)
 
TOriginSetOrigin (void)
 Assign a value to Origin data member. More...
 
bool IsSetDate (void) const
 OBSOLETE old form Entry Date Check if a value has been assigned to Date data member. More...
 
bool CanGetDate (void) const
 Check if it is safe to call GetDate method. More...
 
void ResetDate (void)
 Reset Date data member. More...
 
const TDateGetDate (void) const
 Get the Date member data. More...
 
void SetDate (const TDate &value)
 Assign a value to Date data member. More...
 
void SetDate (TDate &&value)
 
TDateSetDate (void)
 Assign a value to Date data member. More...
 
bool IsSetEntry_date (void) const
 replaces date Check if a value has been assigned to Entry_date data member. More...
 
bool CanGetEntry_date (void) const
 Check if it is safe to call GetEntry_date method. More...
 
void ResetEntry_date (void)
 Reset Entry_date data member. More...
 
const TEntry_dateGetEntry_date (void) const
 Get the Entry_date member data. More...
 
void SetEntry_date (TEntry_date &value)
 Assign a value to Entry_date data member. More...
 
TEntry_dateSetEntry_date (void)
 Assign a value to Entry_date data member. More...
 
bool IsSetDiv (void) const
 GenBank division Check if a value has been assigned to Div data member. More...
 
bool CanGetDiv (void) const
 Check if it is safe to call GetDiv method. More...
 
void ResetDiv (void)
 Reset Div data member. More...
 
const TDivGetDiv (void) const
 Get the Div member data. More...
 
void SetDiv (const TDiv &value)
 Assign a value to Div data member. More...
 
void SetDiv (TDiv &&value)
 
TDivSetDiv (void)
 Assign a value to Div data member. More...
 
bool IsSetTaxonomy (void) const
 continuation line of organism Check if a value has been assigned to Taxonomy data member. More...
 
bool CanGetTaxonomy (void) const
 Check if it is safe to call GetTaxonomy method. More...
 
void ResetTaxonomy (void)
 Reset Taxonomy data member. More...
 
const TTaxonomyGetTaxonomy (void) const
 Get the Taxonomy member data. More...
 
void SetTaxonomy (const TTaxonomy &value)
 Assign a value to Taxonomy data member. More...
 
void SetTaxonomy (TTaxonomy &&value)
 
TTaxonomySetTaxonomy (void)
 Assign a value to Taxonomy 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 CGB_block_Base Tparent
 

Private Member Functions

 CGB_block (const CGB_block &value)
 
CGB_blockoperator= (const CGB_block &value)
 

Additional Inherited Members

- Public Types inherited from CGB_block_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_extra_accessions , e_source , e_keywords ,
  e_origin , e_date , e_entry_date , e_div ,
  e_taxonomy
}
 
typedef list< stringTExtra_accessions
 
typedef string TSource
 
typedef list< stringTKeywords
 
typedef string TOrigin
 
typedef string TDate
 
typedef CDate TEntry_date
 
typedef string TDiv
 
typedef string TTaxonomy
 
typedef Tparent::CMemberIndex< E_memberIndex, 9 > 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 53 of file GB_block.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 55 of file GB_block.hpp.

Constructor & Destructor Documentation

◆ CGB_block() [1/2]

CGB_block::CGB_block ( void  )
inline

Definition at line 74 of file GB_block.hpp.

◆ ~CGB_block()

CGB_block::~CGB_block ( void  )

Definition at line 50 of file GB_block.cpp.

◆ CGB_block() [2/2]

CGB_block::CGB_block ( const CGB_block value)
private

Member Function Documentation

◆ IsEmpty()

bool CGB_block::IsEmpty ( void  ) const

◆ operator=()

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

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