Search Toolkit Book for CAffil
@Affil.hpp User-defined methods of the data storage class. More...
#include <objects/biblio/Affil.hpp>
Inheritance diagram for CAffil:
Collaboration diagram for CAffil:
Public Member Functions | |
| CAffil (void) | |
| ~CAffil (void) | |
| Public Member Functions inherited from CAffil_Base | |
| CAffil_Base (void) | |
| virtual | ~CAffil_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 | IsStr (void) const |
| Check if variant Str is selected. More... | |
| const TStr & | GetStr (void) const |
| Get the variant data. More... | |
| TStr & | SetStr (void) |
| Select the variant. More... | |
| void | SetStr (const TStr &value) |
| Select the variant and set its data. More... | |
| bool | IsStd (void) const |
| Check if variant Std is selected. More... | |
| const TStd & | GetStd (void) const |
| Get the variant data. More... | |
| TStd & | SetStd (void) |
| Select the variant. More... | |
| void | SetStd (TStd &value) |
| Select the variant and set its data. 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 ICitationBase | |
| bool | GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const override |
| Append a label to the specified string per the specified flags. More... | |
| bool | GetLabel (string *label, bool unique) const |
| Public Member Functions inherited from IAbstractCitation | |
| virtual | ~IAbstractCitation () |
Protected Member Functions | |
| bool | GetLabelV1 (string *label, TLabelFlags flags) const override |
| bool | GetLabelV2 (string *label, TLabelFlags flags) const override |
| Protected Member Functions inherited from CObject | |
| virtual void | DeleteThis (void) |
| Virtual method "deleting" this object. More... | |
Private Types | |
| typedef CAffil_Base | Tparent |
Private Member Functions | |
| CAffil (const CAffil &value) | |
| CAffil & | operator= (const CAffil &value) |
Additional Inherited Members | |
| Public Types inherited from CAffil_Base | |
| enum | E_Choice { e_not_set = 0 , e_Str , e_Std } |
| Choice variants. More... | |
| enum | E_ChoiceStopper { e_MaxChoice = 3 } |
| Maximum+1 value of the choice variant enumerator. More... | |
| typedef string | TStr |
| typedef C_Std | TStd |
| 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 CAffil_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 Member Functions inherited from ICitationBase | |
| static string | FixPages (const string &orig_pages) |
| Canonicalize a range of page numbers, expanding Medline-style 125-35 -> 125-135, F124-34 -> F124-F134, and 12a-c -> 12a-12c, and returning a single number (without a dash) for a single page. More... | |
| static string | GetParenthesizedYear (const CDate &date) |
| static bool | HasText (const string &s) |
| static bool | HasText (const string *s) |
| static void | MaybeAddSpace (string *label) |
| static void | NoteSup (string *label, const CImprint &imp) |
| static bool | SWNC (const string &str, const string &pfx) |
| 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... | |
| Static Protected Member Functions inherited from ICitationBase | |
| static bool | x_GetLabelV1 (string *label, bool unique, const CAuth_list *authors, const CImprint *imprint, const CTitle *title, const CCit_book *book, const CCit_jour *journal, const string *title1=0, const string *title2=0, const string *titleunique=0, const string *date=0, const string *volume=0, const string *issue=0, const string *pages=0, bool unpublished=false) |
Detailed Description
@Affil.hpp User-defined methods of the data storage class.
This file was originally generated by application DATATOOL using the following specifications: 'biblio.asn'.
New methods or data members can be added to it if needed. See also: Affil_.hpp
Member Typedef Documentation
◆ Tparent
|
private |
Constructor & Destructor Documentation
◆ CAffil() [1/2]
◆ ~CAffil()
◆ CAffil() [2/2]
Member Function Documentation
◆ GetLabelV1()
|
overrideprotectedvirtual |
Implements ICitationBase.
Definition at line 56 of file Affil.cpp.
References ADD_AFFIL_FIELD, CAffil_Base::e_not_set, CAffil_Base::e_Std, CAffil_Base::e_Str, CAffil_Base::GetStr(), ICitationBase::HasText(), label, and CAffil_Base::Which().
◆ GetLabelV2()
|
overrideprotectedvirtual |
Implements ICitationBase.
Definition at line 89 of file Affil.cpp.
References ADD_AFFIL_FIELD, CAffil_Base::C_Std::CanGetPostal_code(), CAffil_Base::e_not_set, CAffil_Base::e_Std, CAffil_Base::e_Str, CAffil_Base::GetStd(), CAffil_Base::GetStr(), ICitationBase::HasText(), label, NStr::Replace(), and CAffil_Base::Which().
◆ operator=()
The documentation for this class was generated from the following files:
