NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | List of all members
CPub Class Reference

Represents ASN.1 type Pub defined in file pub.asn

Search Toolkit Book for CPub

#include <objects/pub/Pub.hpp>

+ Inheritance diagram for CPub:
+ Collaboration diagram for CPub:

Public Types

enum  ELabelType { eType, eContent, eBoth }
 
typedef CConstRef< CTitle::C_ETOneTitleRef
 
typedef vector< TOneTitleRefTOneTitleRefVec
 
- Public Types inherited from CPub_Base
enum  E_Choice {
  e_not_set = 0, e_Gen, e_Sub, e_Medline,
  e_Muid, e_Article, e_Journal, e_Book,
  e_Proc, e_Patent, e_Pat_id, e_Man,
  e_Equiv, e_Pmid
}
 Choice variants. More...
 
enum  E_ChoiceStopper { e_MaxChoice = 14 }
 Maximum+1 value of the choice variant enumerator. More...
 
typedef CCit_gen TGen
 
typedef CCit_sub TSub
 
typedef CMedline_entry TMedline
 
typedef NCBI_NS_NCBI::TEntrezId TMuid
 
typedef CCit_art TArticle
 
typedef CCit_jour TJournal
 
typedef CCit_book TBook
 
typedef CCit_proc TProc
 
typedef CCit_pat TPatent
 
typedef CId_pat TPat_id
 
typedef CCit_let TMan
 
typedef CPub_equiv TEquiv
 
typedef CPubMedId TPmid
 
- 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 CAtomicCounter TCounter
 Counter type is CAtomiCounter. More...
 
typedef TCounter::TValue 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...
 

Public Member Functions

 CPub (void)
 
 ~CPub (void)
 
bool GetLabel (string *label, ELabelType type=eContent, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const
 Concatenate a label for this pub to label. More...
 
bool GetLabel (string *label, ELabelType type, bool unique=false) const
 
bool GetLabel (string *label, TLabelFlags flags=0, ELabelVersion version=eLabel_DefaultVersion) const
 Append a label to the specified string per the specified flags. More...
 
bool IsSetAuthors (void) const
 
const CAuth_listGetAuthors (void) const
 
CAuth_listSetAuthors (void)
 
void GetTitles (TOneTitleRefVec &out_title, size_t iMaxToGet=std::numeric_limits< std::size_t >::max()) const
 This gets the titles on the CPub. More...
 
bool SameCitation (const CPub &other) const
 
- Public Member Functions inherited from CPub_Base
 CPub_Base (void)
 
virtual ~CPub_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...
 
NCBI_NORETURN 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 IsGen (void) const
 Check if variant Gen is selected. More...
 
const TGenGetGen (void) const
 Get the variant data. More...
 
TGenSetGen (void)
 Select the variant. More...
 
void SetGen (TGen &value)
 Select the variant and set its data. More...
 
bool IsSub (void) const
 Check if variant Sub is selected. More...
 
const TSubGetSub (void) const
 Get the variant data. More...
 
TSubSetSub (void)
 Select the variant. More...
 
void SetSub (TSub &value)
 Select the variant and set its data. More...
 
bool IsMedline (void) const
 Check if variant Medline is selected. More...
 
const TMedlineGetMedline (void) const
 Get the variant data. More...
 
TMedlineSetMedline (void)
 Select the variant. More...
 
void SetMedline (TMedline &value)
 Select the variant and set its data. More...
 
bool IsMuid (void) const
 Check if variant Muid is selected. More...
 
TMuid GetMuid (void) const
 Get the variant data. More...
 
TMuidSetMuid (void)
 Select the variant. More...
 
void SetMuid (TMuid value)
 Select the variant and set its data. More...
 
bool IsArticle (void) const
 Check if variant Article is selected. More...
 
const TArticleGetArticle (void) const
 Get the variant data. More...
 
TArticleSetArticle (void)
 Select the variant. More...
 
void SetArticle (TArticle &value)
 Select the variant and set its data. More...
 
bool IsJournal (void) const
 Check if variant Journal is selected. More...
 
const TJournalGetJournal (void) const
 Get the variant data. More...
 
TJournalSetJournal (void)
 Select the variant. More...
 
void SetJournal (TJournal &value)
 Select the variant and set its data. More...
 
bool IsBook (void) const
 Check if variant Book is selected. More...
 
const TBookGetBook (void) const
 Get the variant data. More...
 
TBookSetBook (void)
 Select the variant. More...
 
void SetBook (TBook &value)
 Select the variant and set its data. More...
 
bool IsProc (void) const
 Check if variant Proc is selected. More...
 
const TProcGetProc (void) const
 Get the variant data. More...
 
TProcSetProc (void)
 Select the variant. More...
 
void SetProc (TProc &value)
 Select the variant and set its data. More...
 
bool IsPatent (void) const
 Check if variant Patent is selected. More...
 
const TPatentGetPatent (void) const
 Get the variant data. More...
 
TPatentSetPatent (void)
 Select the variant. More...
 
void SetPatent (TPatent &value)
 Select the variant and set its data. More...
 
bool IsPat_id (void) const
 Check if variant Pat_id is selected. More...
 
const TPat_idGetPat_id (void) const
 Get the variant data. More...
 
TPat_idSetPat_id (void)
 Select the variant. More...
 
void SetPat_id (TPat_id &value)
 Select the variant and set its data. More...
 
bool IsMan (void) const
 Check if variant Man is selected. More...
 
const TManGetMan (void) const
 Get the variant data. More...
 
TManSetMan (void)
 Select the variant. More...
 
void SetMan (TMan &value)
 Select the variant and set its data. More...
 
bool IsEquiv (void) const
 Check if variant Equiv is selected. More...
 
const TEquivGetEquiv (void) const
 Get the variant data. More...
 
TEquivSetEquiv (void)
 Select the variant. More...
 
void SetEquiv (TEquiv &value)
 Select the variant and set its data. 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...
 
void SetPmid (const TPmid &value)
 Select the variant and set its data. 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
 
- Public Member Functions inherited from IAbstractCitation
virtual ~IAbstractCitation ()
 

Private Types

typedef CPub_Base Tparent
 

Private Member Functions

 CPub (const CPub &value)
 
CPuboperator= (const CPub &value)
 

Static Private Member Functions

static TOneTitleRef xs_GetTitleFromPlainString (const string &sTitle)
 
static void xs_AppendTitles (TOneTitleRefVec &out_title, size_t iMaxToGet, const CTitle &in_title)
 

Additional Inherited Members

- Static Public Member Functions inherited from CPub_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_NORETURN void ThrowNullPointerException (void)
 Define method to throw null pointer exception. More...
 
static NCBI_NORETURN 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 55 of file Pub.hpp.

Member Typedef Documentation

Definition at line 89 of file Pub.hpp.

Definition at line 90 of file Pub.hpp.

typedef CPub_Base CPub::Tparent
private

Definition at line 57 of file Pub.hpp.

Member Enumeration Documentation

Enumerator
eType 
eContent 
eBoth 

Definition at line 64 of file Pub.hpp.

Constructor & Destructor Documentation

CPub::CPub ( void  )
inline

Definition at line 130 of file Pub.hpp.

CPub::~CPub ( void  )

Definition at line 70 of file Pub.cpp.

CPub::CPub ( const CPub value)
private

Member Function Documentation

const CAuth_list & CPub::GetAuthors ( void  ) const
bool CPub::GetLabel ( string label,
ELabelType  type = eContent,
TLabelFlags  flags = 0,
ELabelVersion  version = eLabel_DefaultVersion 
) const
bool CPub::GetLabel ( string label,
ELabelType  type,
bool  unique = false 
) const
inline

Definition at line 135 of file Pub.hpp.

References IAbstractCitation::fLabel_Unique, and GetLabel().

bool CPub::GetLabel ( string label,
TLabelFlags  flags = 0,
ELabelVersion  version = eLabel_DefaultVersion 
) const
inlinevirtual

Append a label to the specified string per the specified flags.

Implements IAbstractCitation.

Definition at line 141 of file Pub.hpp.

References eContent, and GetLabel().

void CPub::GetTitles ( TOneTitleRefVec out_title,
size_t  iMaxToGet = std::numeric_limits<std::size_t>::max() 
) const

This gets the titles on the CPub.

Parameters
out_titlesEach title found will be appended to this. Titles of plain strings will be given as type CTitle::C_E::e_Name, and complex titles will be a const reference to the title inside the CPub, so they might change if the CPub is changed.
iMaxToGetThe maximum number of titles to append to out_title

Definition at line 224 of file Pub.cpp.

References CPub_Base::e_Article, CPub_Base::e_Book, CPub_Base::e_Equiv, CPub_Base::e_Gen, CPub_Base::e_Journal, CPub_Base::e_Man, CPub_Base::e_Medline, CPub_Base::e_not_set, CPub_Base::e_Pat_id, CPub_Base::e_Patent, CPub_Base::e_Pmid, CPub_Base::e_Proc, CPub_Base::e_Sub, eUnknown, FIELD_CHAIN_OF_2_IS_SET, FOR_EACH_PUB_ON_PUBEQUIV, CPub_Base::GetArticle(), CPub_Base::GetBook(), wgsparse::GetDescr(), CPub_Base::GetEquiv(), CPub_Base::GetGen(), CPub_Base::GetJournal(), CPub_Base::GetMan(), CPub_Base::GetPatent(), CPub_Base::GetProc(), CPub_Base::GetSub(), GetTitle(), max(), NCBI_THROW, CPub_Base::Which(), xs_AppendTitles(), and xs_GetTitleFromPlainString().

bool CPub::IsSetAuthors ( void  ) const
CPub& CPub::operator= ( const CPub value)
private
bool CPub::SameCitation ( const CPub other) const
CAuth_list & CPub::SetAuthors ( void  )
void CPub::xs_AppendTitles ( TOneTitleRefVec out_title,
size_t  iMaxToGet,
const CTitle in_title 
)
staticprivate

Definition at line 325 of file Pub.cpp.

References CTitle_Base::Get(), and CTitle_Base::IsSet().

Referenced by GetTitles().

CPub::TOneTitleRef CPub::xs_GetTitleFromPlainString ( const string sTitle)
staticprivate

Definition at line 317 of file Pub.cpp.

References CTitle_Base::C_E::SetName().

Referenced by GetTitles().


The documentation for this class was generated from the following files:
Modified on Thu Feb 22 13:22:52 2018 by modify_doxy.py rev. 546573