Search Toolkit Book for CPub_set
#include <objects/pub/Pub_set.hpp>
Inheritance diagram for CPub_set:
Collaboration diagram for CPub_set:
Public Member Functions | |
| CPub_set (void) | |
| ~CPub_set (void) | |
| bool | GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const override |
| Get a label that is the concatenation of the pub labels for the pubs in the set. More... | |
| Public Member Functions inherited from CPub_set_Base | |
| CPub_set_Base (void) | |
| virtual | ~CPub_set_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 | IsPub (void) const |
| Check if variant Pub is selected. More... | |
| const TPub & | GetPub (void) const |
| Get the variant data. More... | |
| TPub & | SetPub (void) |
| Select the variant. More... | |
| bool | IsMedline (void) const |
| Check if variant Medline is selected. More... | |
| const TMedline & | GetMedline (void) const |
| Get the variant data. More... | |
| TMedline & | SetMedline (void) |
| Select the variant. More... | |
| bool | IsArticle (void) const |
| Check if variant Article is selected. More... | |
| const TArticle & | GetArticle (void) const |
| Get the variant data. More... | |
| TArticle & | SetArticle (void) |
| Select the variant. More... | |
| bool | IsJournal (void) const |
| Check if variant Journal is selected. More... | |
| const TJournal & | GetJournal (void) const |
| Get the variant data. More... | |
| TJournal & | SetJournal (void) |
| Select the variant. More... | |
| bool | IsBook (void) const |
| Check if variant Book is selected. More... | |
| const TBook & | GetBook (void) const |
| Get the variant data. More... | |
| TBook & | SetBook (void) |
| Select the variant. More... | |
| bool | IsProc (void) const |
| Check if variant Proc is selected. More... | |
| const TProc & | GetProc (void) const |
| Get the variant data. More... | |
| TProc & | SetProc (void) |
| Select the variant. More... | |
| bool | IsPatent (void) const |
| Check if variant Patent is selected. More... | |
| const TPatent & | GetPatent (void) const |
| Get the variant data. More... | |
| TPatent & | SetPatent (void) |
| Select the variant. More... | |
| Public Member Functions inherited from CSerialObject | |
| 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... | |
| Public Member Functions inherited from CObject | |
| 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... | |
| 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 |
| Public Member Functions inherited from IAbstractCitation | |
| virtual | ~IAbstractCitation () |
Private Types | |
| typedef CPub_set_Base | Tparent |
Private Member Functions | |
| CPub_set (const CPub_set &value) | |
| CPub_set & | operator= (const CPub_set &value) |
Additional Inherited Members | |
| Public Types inherited from CPub_set_Base | |
| enum | E_Choice { e_not_set = 0 , e_Pub , e_Medline , e_Article , e_Journal , e_Book , e_Proc , e_Patent } |
| Choice variants. More... | |
| enum | E_ChoiceStopper { e_MaxChoice = 8 } |
| Maximum+1 value of the choice variant enumerator. More... | |
| typedef list< CRef< CPub > > | TPub |
| typedef list< CRef< CMedline_entry > > | TMedline |
| typedef list< CRef< CCit_art > > | TArticle |
| typedef list< CRef< CCit_jour > > | TJournal |
| typedef list< CRef< CCit_book > > | TBook |
| typedef list< CRef< CCit_proc > > | TProc |
| typedef list< CRef< CCit_pat > > | TPatent |
| 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< Uint8 > | TCounter |
| Counter type is CAtomiCounter. More... | |
| typedef Uint8 | TCount |
| Alias for value type of counter. More... | |
| Public Types inherited from IAbstractCitation | |
| enum | ELabelFlags { fLabel_Unique = 1 << 0 , fLabel_FlatNCBI = 1 << 1 , fLabel_FlatEMBL = 1 << 2 , fLabel_ISO_JTA = 1 << 3 , fLabel_NoBadCitGen = 1 << 4 , fLabel_NoUnpubAffil = 1 << 5 , fLabel_Consortia = 1 << 30 } |
| Flags for use by GetLabel methods. More... | |
| enum | ELabelVersion { eLabel_V1 = 1 , eLabel_V2 = 2 , eLabel_MinVersion = eLabel_V1 , eLabel_DefaultVersion = eLabel_V1 , eLabel_MaxVersion = eLabel_V2 } |
| typedef int | TLabelFlags |
| binary OR of ELabelFlags More... | |
| Static Public Member Functions inherited from CPub_set_Base | |
| 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) |
| 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 52 of file Pub_set.hpp.
Member Typedef Documentation
◆ Tparent
|
private |
Definition at line 54 of file Pub_set.hpp.
Constructor & Destructor Documentation
◆ CPub_set() [1/2]
|
inline |
Definition at line 79 of file Pub_set.hpp.
◆ ~CPub_set()
| CPub_set::~CPub_set | ( | void | ) |
Definition at line 50 of file Pub_set.cpp.
◆ CPub_set() [2/2]
Member Function Documentation
◆ GetLabel()
|
overridevirtual |
Get a label that is the concatenation of the pub labels for the pubs in the set.
Implements IAbstractCitation.
Definition at line 74 of file Pub_set.cpp.
References CPub_set_Base::e_Article, CPub_set_Base::e_Book, CPub_set_Base::e_Journal, CPub_set_Base::e_Medline, CPub_set_Base::e_Patent, CPub_set_Base::e_Proc, CPub_set_Base::e_Pub, flags, CPub_set_Base::GetArticle(), CPub_set_Base::GetBook(), CPub_set_Base::GetJournal(), CPub_set_Base::GetMedline(), CPub_set_Base::GetPatent(), CPub_set_Base::GetProc(), CPub_set_Base::GetPub(), label, dtl::version, and CPub_set_Base::Which().
Referenced by s_GetImpLabel().
◆ operator=()
The documentation for this class was generated from the following files:
- include/objects/pub/Pub_set.hpp
- src/objects/pub/Pub_set.cpp
