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

Represents ASN.1 type Project-item defined in file proj.asn

Search Toolkit Book for CProject_item_Base

CProject_item_Base –. More...

#include <objects/proj/Project_item_.hpp>

+ Inheritance diagram for CProject_item_Base:
+ Collaboration diagram for CProject_item_Base:

Public Types

enum  E_Choice {
  e_not_set = 0 , e_Pmuid , e_Protuid , e_Nucuid ,
  e_Sequid , e_Genomeuid , e_Structuid , e_Pmid ,
  e_Protid , e_Nucid , e_Seqid , e_Genomeid ,
  e_Structid , e_Pment , e_Protent , e_Nucent ,
  e_Seqent , e_Genomeent , e_Structent , e_Seqannot ,
  e_Loc , e_Proj
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 22 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef list< intTPmuid
 
typedef list< intTProtuid
 
typedef list< intTNucuid
 
typedef list< intTSequid
 
typedef list< intTGenomeuid
 
typedef list< intTStructuid
 
typedef list< CPubMedIdTPmid
 
typedef list< CRef< CSeq_id > > TProtid
 
typedef list< CRef< CSeq_id > > TNucid
 
typedef list< CRef< CSeq_id > > TSeqid
 
typedef list< CRef< CSeq_id > > TGenomeid
 
typedef list< CRef< CPubmed_entry > > TPment
 
typedef list< CRef< CSeq_entry > > TProtent
 
typedef list< CRef< CSeq_entry > > TNucent
 
typedef list< CRef< CSeq_entry > > TSeqent
 
typedef list< CRef< CSeq_entry > > TGenomeent
 
typedef list< CRef< CSeq_annot > > TSeqannot
 
typedef list< CRef< CSeq_loc > > TLoc
 
typedef list< CRef< CProject > > TProj
 
- 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

 CProject_item_Base (void)
 
virtual ~CProject_item_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
virtual void Reset (void)
 Reset the whole object. More...
 
virtual void ResetSelection (void)
 Reset the selection (set it to e_not_set). More...
 
E_Choice Which (void) const
 Which variant is currently selected. More...
 
void CheckSelected (E_Choice index) const
 Verify selection, throw exception if it differs from the expected. More...
 
void ThrowInvalidSelection (E_Choice index) const
 Throw 'InvalidSelection' exception. More...
 
void Select (E_Choice index, EResetVariant reset=eDoResetVariant)
 Select the requested variant if needed. More...
 
void Select (E_Choice index, EResetVariant reset, CObjectMemoryPool *pool)
 Select the requested variant if needed, allocating CObject variants from memory pool. More...
 
bool IsPmuid (void) const
 Check if variant Pmuid is selected. More...
 
const TPmuidGetPmuid (void) const
 Get the variant data. More...
 
TPmuidSetPmuid (void)
 Select the variant. More...
 
bool IsProtuid (void) const
 Check if variant Protuid is selected. More...
 
const TProtuidGetProtuid (void) const
 Get the variant data. More...
 
TProtuidSetProtuid (void)
 Select the variant. More...
 
bool IsNucuid (void) const
 Check if variant Nucuid is selected. More...
 
const TNucuidGetNucuid (void) const
 Get the variant data. More...
 
TNucuidSetNucuid (void)
 Select the variant. More...
 
bool IsSequid (void) const
 Check if variant Sequid is selected. More...
 
const TSequidGetSequid (void) const
 Get the variant data. More...
 
TSequidSetSequid (void)
 Select the variant. More...
 
bool IsGenomeuid (void) const
 Check if variant Genomeuid is selected. More...
 
const TGenomeuidGetGenomeuid (void) const
 Get the variant data. More...
 
TGenomeuidSetGenomeuid (void)
 Select the variant. More...
 
bool IsStructuid (void) const
 Check if variant Structuid is selected. More...
 
const TStructuidGetStructuid (void) const
 Get the variant data. More...
 
TStructuidSetStructuid (void)
 Select the variant. More...
 
bool IsPmid (void) const
 Check if variant Pmid is selected. More...
 
const TPmidGetPmid (void) const
 Get the variant data. More...
 
TPmidSetPmid (void)
 Select the variant. More...
 
bool IsProtid (void) const
 Check if variant Protid is selected. More...
 
const TProtidGetProtid (void) const
 Get the variant data. More...
 
TProtidSetProtid (void)
 Select the variant. More...
 
bool IsNucid (void) const
 Check if variant Nucid is selected. More...
 
const TNucidGetNucid (void) const
 Get the variant data. More...
 
TNucidSetNucid (void)
 Select the variant. More...
 
bool IsSeqid (void) const
 Check if variant Seqid is selected. More...
 
const TSeqidGetSeqid (void) const
 Get the variant data. More...
 
TSeqidSetSeqid (void)
 Select the variant. More...
 
bool IsGenomeid (void) const
 Check if variant Genomeid is selected. More...
 
const TGenomeidGetGenomeid (void) const
 Get the variant data. More...
 
TGenomeidSetGenomeid (void)
 Select the variant. More...
 
bool IsStructid (void) const
 Check if variant Structid is selected. More...
 
void SetStructid (void)
 Select the variant. More...
 
bool IsPment (void) const
 Check if variant Pment is selected. More...
 
const TPmentGetPment (void) const
 Get the variant data. More...
 
TPmentSetPment (void)
 Select the variant. More...
 
bool IsProtent (void) const
 Check if variant Protent is selected. More...
 
const TProtentGetProtent (void) const
 Get the variant data. More...
 
TProtentSetProtent (void)
 Select the variant. More...
 
bool IsNucent (void) const
 Check if variant Nucent is selected. More...
 
const TNucentGetNucent (void) const
 Get the variant data. More...
 
TNucentSetNucent (void)
 Select the variant. More...
 
bool IsSeqent (void) const
 Check if variant Seqent is selected. More...
 
const TSeqentGetSeqent (void) const
 Get the variant data. More...
 
TSeqentSetSeqent (void)
 Select the variant. More...
 
bool IsGenomeent (void) const
 Check if variant Genomeent is selected. More...
 
const TGenomeentGetGenomeent (void) const
 Get the variant data. More...
 
TGenomeentSetGenomeent (void)
 Select the variant. More...
 
bool IsStructent (void) const
 Check if variant Structent is selected. More...
 
void SetStructent (void)
 Select the variant. More...
 
bool IsSeqannot (void) const
 Check if variant Seqannot is selected. More...
 
const TSeqannotGetSeqannot (void) const
 Get the variant data. More...
 
TSeqannotSetSeqannot (void)
 Select the variant. More...
 
bool IsLoc (void) const
 Check if variant Loc is selected. More...
 
const TLocGetLoc (void) const
 Get the variant data. More...
 
TLocSetLoc (void)
 Select the variant. More...
 
bool IsProj (void) const
 Check if variant Proj is selected. More...
 
const TProjGetProj (void) const
 Get the variant data. More...
 
TProjSetProj (void)
 Select the variant. 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 Member Functions

static string SelectionName (E_Choice index)
 Retrieve selection name (for diagnostic purposes). 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)
 

Private Types

typedef CSerialObject Tparent
 

Private Member Functions

 CProject_item_Base (const CProject_item_Base &)
 
CProject_item_Baseoperator= (const CProject_item_Base &)
 
void DoSelect (E_Choice index, CObjectMemoryPool *pool=0)
 

Private Attributes

E_Choice m_choice
 
union {
   NCBI_NS_NCBI::CUnionBuffer< TPmuid >   CProject_item_Base::m_Pmuid
 
   NCBI_NS_NCBI::CUnionBuffer< TProtuid >   CProject_item_Base::m_Protuid
 
   NCBI_NS_NCBI::CUnionBuffer< TNucuid >   CProject_item_Base::m_Nucuid
 
   NCBI_NS_NCBI::CUnionBuffer< TSequid >   CProject_item_Base::m_Sequid
 
   NCBI_NS_NCBI::CUnionBuffer< TGenomeuid >   CProject_item_Base::m_Genomeuid
 
   NCBI_NS_NCBI::CUnionBuffer< TStructuid >   CProject_item_Base::m_Structuid
 
   NCBI_NS_NCBI::CUnionBuffer< TPmid >   CProject_item_Base::m_Pmid
 
   NCBI_NS_NCBI::CUnionBuffer< TProtid >   CProject_item_Base::m_Protid
 
   NCBI_NS_NCBI::CUnionBuffer< TNucid >   CProject_item_Base::m_Nucid
 
   NCBI_NS_NCBI::CUnionBuffer< TSeqid >   CProject_item_Base::m_Seqid
 
   NCBI_NS_NCBI::CUnionBuffer< TGenomeid >   CProject_item_Base::m_Genomeid
 
   NCBI_NS_NCBI::CUnionBuffer< TPment >   CProject_item_Base::m_Pment
 
   NCBI_NS_NCBI::CUnionBuffer< TProtent >   CProject_item_Base::m_Protent
 
   NCBI_NS_NCBI::CUnionBuffer< TNucent >   CProject_item_Base::m_Nucent
 
   NCBI_NS_NCBI::CUnionBuffer< TSeqent >   CProject_item_Base::m_Seqent
 
   NCBI_NS_NCBI::CUnionBuffer< TGenomeent >   CProject_item_Base::m_Genomeent
 
   NCBI_NS_NCBI::CUnionBuffer< TSeqannot >   CProject_item_Base::m_Seqannot
 
   NCBI_NS_NCBI::CUnionBuffer< TLoc >   CProject_item_Base::m_Loc
 
   NCBI_NS_NCBI::CUnionBuffer< TProj >   CProject_item_Base::m_Proj
 
   void *   CProject_item_Base::m_dummy_pointer_for_alignment
 
}; 
 

Static Private Attributes

static const char *const sm_SelectionNames []
 

Additional Inherited Members

- 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

CProject_item_Base –.

Definition at line 82 of file Project_item_.hpp.


The documentation for this class was generated from the following files:
Modified on Sat Dec 02 09:22:21 2023 by modify_doxy.py rev. 669887