NCBI C++ ToolKit
|
Search Toolkit Book for CProject_item
#include <objects/proj/Project_item.hpp>
Public Member Functions | |
CProject_item (void) | |
~CProject_item (void) | |
![]() | |
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 TPmuid & | GetPmuid (void) const |
Get the variant data. More... | |
TPmuid & | SetPmuid (void) |
Select the variant. More... | |
bool | IsProtuid (void) const |
Check if variant Protuid is selected. More... | |
const TProtuid & | GetProtuid (void) const |
Get the variant data. More... | |
TProtuid & | SetProtuid (void) |
Select the variant. More... | |
bool | IsNucuid (void) const |
Check if variant Nucuid is selected. More... | |
const TNucuid & | GetNucuid (void) const |
Get the variant data. More... | |
TNucuid & | SetNucuid (void) |
Select the variant. More... | |
bool | IsSequid (void) const |
Check if variant Sequid is selected. More... | |
const TSequid & | GetSequid (void) const |
Get the variant data. More... | |
TSequid & | SetSequid (void) |
Select the variant. More... | |
bool | IsGenomeuid (void) const |
Check if variant Genomeuid is selected. More... | |
const TGenomeuid & | GetGenomeuid (void) const |
Get the variant data. More... | |
TGenomeuid & | SetGenomeuid (void) |
Select the variant. More... | |
bool | IsStructuid (void) const |
Check if variant Structuid is selected. More... | |
const TStructuid & | GetStructuid (void) const |
Get the variant data. More... | |
TStructuid & | SetStructuid (void) |
Select the variant. More... | |
bool | IsPmid (void) const |
Check if variant Pmid is selected. More... | |
const TPmid & | GetPmid (void) const |
Get the variant data. More... | |
TPmid & | SetPmid (void) |
Select the variant. More... | |
bool | IsProtid (void) const |
Check if variant Protid is selected. More... | |
const TProtid & | GetProtid (void) const |
Get the variant data. More... | |
TProtid & | SetProtid (void) |
Select the variant. More... | |
bool | IsNucid (void) const |
Check if variant Nucid is selected. More... | |
const TNucid & | GetNucid (void) const |
Get the variant data. More... | |
TNucid & | SetNucid (void) |
Select the variant. More... | |
bool | IsSeqid (void) const |
Check if variant Seqid is selected. More... | |
const TSeqid & | GetSeqid (void) const |
Get the variant data. More... | |
TSeqid & | SetSeqid (void) |
Select the variant. More... | |
bool | IsGenomeid (void) const |
Check if variant Genomeid is selected. More... | |
const TGenomeid & | GetGenomeid (void) const |
Get the variant data. More... | |
TGenomeid & | SetGenomeid (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 TPment & | GetPment (void) const |
Get the variant data. More... | |
TPment & | SetPment (void) |
Select the variant. More... | |
bool | IsProtent (void) const |
Check if variant Protent is selected. More... | |
const TProtent & | GetProtent (void) const |
Get the variant data. More... | |
TProtent & | SetProtent (void) |
Select the variant. More... | |
bool | IsNucent (void) const |
Check if variant Nucent is selected. More... | |
const TNucent & | GetNucent (void) const |
Get the variant data. More... | |
TNucent & | SetNucent (void) |
Select the variant. More... | |
bool | IsSeqent (void) const |
Check if variant Seqent is selected. More... | |
const TSeqent & | GetSeqent (void) const |
Get the variant data. More... | |
TSeqent & | SetSeqent (void) |
Select the variant. More... | |
bool | IsGenomeent (void) const |
Check if variant Genomeent is selected. More... | |
const TGenomeent & | GetGenomeent (void) const |
Get the variant data. More... | |
TGenomeent & | SetGenomeent (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 TSeqannot & | GetSeqannot (void) const |
Get the variant data. More... | |
TSeqannot & | SetSeqannot (void) |
Select the variant. More... | |
bool | IsLoc (void) const |
Check if variant Loc is selected. More... | |
const TLoc & | GetLoc (void) const |
Get the variant data. More... | |
TLoc & | SetLoc (void) |
Select the variant. More... | |
bool | IsProj (void) const |
Check if variant Proj is selected. More... | |
const TProj & | GetProj (void) const |
Get the variant data. More... | |
TProj & | SetProj (void) |
Select the variant. More... | |
![]() | |
CSerialObject (void) | |
virtual | ~CSerialObject (void) |
virtual const CTypeInfo * | GetThisTypeInfo (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 string & | GetNamespaceName (void) const |
Get namespace name. More... | |
bool | HasNamespacePrefix (void) const |
Check if data type has namespace prefix. More... | |
const string & | GetNamespacePrefix (void) const |
Get namespace prefix. More... | |
![]() | |
CObject (void) | |
Constructor. More... | |
CObject (const CObject &src) | |
Copy constructor. More... | |
virtual | ~CObject (void) |
Destructor. More... | |
CObject & | operator= (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... | |
![]() | |
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 CProject_item_Base | Tparent |
Private Member Functions | |
CProject_item (const CProject_item &value) | |
CProject_item & | operator= (const CProject_item &value) |
Additional Inherited Members | |
![]() | |
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< int > | TPmuid |
typedef list< int > | TProtuid |
typedef list< int > | TNucuid |
typedef list< int > | TSequid |
typedef list< int > | TGenomeuid |
typedef list< int > | TStructuid |
typedef list< CPubMedId > | TPmid |
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 |
![]() | |
enum | EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern } |
Control filling of newly allocated memory. More... | |
typedef CObjectCounterLocker | TLockerType |
Default locker type for CRef. More... | |
typedef atomic< Uint8 > | TCounter |
Counter type is CAtomiCounter. More... | |
typedef Uint8 | TCount |
Alias for value type of counter. More... | |
![]() | |
static string | SelectionName (E_Choice index) |
Retrieve selection name (for diagnostic purposes). More... | |
![]() | |
static void | SetVerifyDataThread (ESerialVerifyData verify) |
static void | SetVerifyDataGlobal (ESerialVerifyData verify) |
static string | UnassignedString (void) |
static CStringUTF8 | UnassignedStringUTF8 (void) |
static char | UnassignedByte (void) |
![]() | |
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 void | EnableDebugDump (bool on) |
![]() | |
static const char * | ms_UnassignedStr = "<*unassigned*>" |
static const char | ms_UnassignedByte = char(0xcd) |
![]() | |
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... | |
![]() | |
virtual void | DeleteThis (void) |
Virtual method "deleting" this object. More... | |
Definition at line 65 of file Project_item.hpp.