Search Toolkit Book for CTitle
#include <objects/biblio/Title.hpp>
Inheritance diagram for CTitle:
Collaboration diagram for CTitle:
Public Member Functions | |
| CTitle (void) | |
| ~CTitle (void) | |
| const string & | GetTitle (C_E::E_Choice type=C_E::e_not_set) const |
| If the internal list contains a title (of the specified type, if given), returns the corresponding string; otherwise, throws an exception. More... | |
| Public Member Functions inherited from CTitle_Base | |
| CTitle_Base (void) | |
| virtual | ~CTitle_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSet (void) const |
| Check if a value has been assigned to data member. More... | |
| bool | CanGet (void) const |
| Check if it is safe to call Get method. More... | |
| void | Reset (void) |
| Reset data member. More... | |
| const Tdata & | Get (void) const |
| Get the member data. More... | |
| Tdata & | Set (void) |
| Assign a value to data member. More... | |
| operator const Tdata & (void) const | |
| Conversion operator to 'const Tdata' type. More... | |
| operator Tdata & (void) | |
| Conversion operator to 'Tdata' type. 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 |
Static Public Member Functions | |
| static const string & | GetTitle (const C_E &t) |
| Extracts the title string from the given internal element. 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 CTitle_Base | Tparent |
Private Member Functions | |
| CTitle (const CTitle &value) | |
| CTitle & | operator= (const CTitle &value) |
Additional Inherited Members | |
| Public Types inherited from CTitle_Base | |
| typedef list< CRef< C_E > > | Tdata |
| 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... | |
| 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
Member Typedef Documentation
◆ Tparent
|
private |
Constructor & Destructor Documentation
◆ CTitle() [1/2]
◆ ~CTitle()
◆ CTitle() [2/2]
Member Function Documentation
◆ GetTitle() [1/2]
| const string & CTitle::GetTitle | ( | C_E::E_Choice | type = C_E::e_not_set | ) | const |
If the internal list contains a title (of the specified type, if given), returns the corresponding string; otherwise, throws an exception.
Definition at line 56 of file Title.cpp.
References CTitle_Base::C_E::e_not_set, ctll::empty(), eUnknown, ctll::front(), CTitle_Base::Get(), ITERATE, NCBI_THROW, and CTitle_Base::C_E::SelectionName().
Referenced by SCitMatch::FillFromArticle(), GetDocSumLabel(), CCit_art::GetLabelV1(), CCit_book::GetLabelV2(), CCit_gen::GetLabelV2(), CCit_jour::GetLabelV2(), GetPubTitleAndAuthors(), GetTitleName(), CEditingActionDescJournal::GetValue(), fix_pub::PrintPub(), s_FormatCitBook(), s_FormatCitBookArt(), s_FormatJournal(), s_GetPubTitle(), CRelaxedLookupDlg::SetPubdesc(), ICitationBase::x_GetLabelV1(), CCit_art::x_GetLabelV2(), CReferenceItem::x_Init(), and CMacroFunction_ISOJTALookup::x_LookupTitleInJournal().
◆ GetTitle() [2/2]
Extracts the title string from the given internal element.
Definition at line 74 of file Title.cpp.
References CTitle_Base::C_E::e_Abr, CTitle_Base::C_E::e_Coden, CTitle_Base::C_E::e_Isbn, CTitle_Base::C_E::e_Iso_jta, CTitle_Base::C_E::e_Issn, CTitle_Base::C_E::e_Jta, CTitle_Base::C_E::e_Ml_jta, CTitle_Base::C_E::e_Name, CTitle_Base::C_E::e_Trans, CTitle_Base::C_E::e_Tsub, eUnknown, NCBI_THROW, CTitle_Base::C_E::SelectionName(), and t.
◆ operator=()
The documentation for this class was generated from the following files:
