#include <objects/pub/Pub.hpp>

Inheritance diagram for CPub:

Collaboration diagram for CPub:

Public Types
enum	ELabelType { eType , eContent , eBoth }

typedef CConstRef< CTitle::C_E >	TOneTitleRef

typedef vector< TOneTitleRef >	TOneTitleRefVec

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 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...

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 override
	Append a label to the specified string per the specified flags. More...

bool	IsSetAuthors (void) const

const CAuth_list &	GetAuthors (void) const

CAuth_list &	SetAuthors (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...

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 TGen &	GetGen (void) const
	Get the variant data. More...

TGen &	SetGen (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 TSub &	GetSub (void) const
	Get the variant data. More...

TSub &	SetSub (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 TMedline &	GetMedline (void) const
	Get the variant data. More...

TMedline &	SetMedline (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...

TMuid &	SetMuid (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 TArticle &	GetArticle (void) const
	Get the variant data. More...

TArticle &	SetArticle (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 TJournal &	GetJournal (void) const
	Get the variant data. More...

TJournal &	SetJournal (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 TBook &	GetBook (void) const
	Get the variant data. More...

TBook &	SetBook (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 TProc &	GetProc (void) const
	Get the variant data. More...

TProc &	SetProc (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 TPatent &	GetPatent (void) const
	Get the variant data. More...

TPatent &	SetPatent (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_id &	GetPat_id (void) const
	Get the variant data. More...

TPat_id &	SetPat_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 TMan &	GetMan (void) const
	Get the variant data. More...

TMan &	SetMan (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 TEquiv &	GetEquiv (void) const
	Get the variant data. More...

TEquiv &	SetEquiv (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 TPmid &	GetPmid (void) const
	Get the variant data. More...

TPmid &	SetPmid (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 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_Base	Tparent

Private Member Functions
	CPub (const CPub &value)

CPub &	operator= (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_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 55 of file Pub.hpp.

Member Typedef Documentation

◆ TOneTitleRef

typedef CConstRef<CTitle::C_E> CPub::TOneTitleRef

Definition at line 89 of file Pub.hpp.

◆ TOneTitleRefVec

typedef vector<TOneTitleRef> CPub::TOneTitleRefVec

Definition at line 90 of file Pub.hpp.

◆ Tparent

typedef CPub_Base CPub::Tparent

private

Definition at line 57 of file Pub.hpp.

Member Enumeration Documentation

◆ ELabelType

enum CPub::ELabelType

Enumerator
eType
eContent
eBoth

Definition at line 64 of file Pub.hpp.

Constructor & Destructor Documentation

◆ CPub() [1/2]

CPub::CPub ( void )

inline

Definition at line 130 of file Pub.hpp.

◆ ~CPub()

CPub::~CPub ( void )

Definition at line 70 of file Pub.cpp.

◆ CPub() [2/2]

CPub::CPub ( const CPub & value )

private

Member Function Documentation

◆ GetAuthors()

const CAuth_list & CPub::GetAuthors ( void ) const

Definition at line 178 of file Pub.cpp.

References CPub_Base::e_Article, CPub_Base::e_Book, CPub_Base::e_Gen, CPub_Base::e_Man, CPub_Base::e_Medline, CPub_Base::e_Patent, CPub_Base::e_Proc, CPub_Base::e_Sub, CPub_Base::GetArticle(), CPub_Base::GetBook(), CPub_Base::GetGen(), CPub_Base::GetMan(), CPub_Base::GetMedline(), CPub_Base::GetPatent(), CPub_Base::GetProc(), CPub_Base::GetSub(), NCBI_THROW, CPub_Base::SelectionName(), and CPub_Base::Which().

Referenced by CReferenceItem::ChangeMedlineAuthorsToISO(), GetAuthList(), IEditingActionDescAffil::Modify(), IEditingActionDescAuthors::Modify(), CEditingActionDescAuthorNameList::Modify(), s_TransferPubData(), CEditingActionDescAffil::SetValue(), CEditingActionDescDepartment::SetValue(), CEditingActionDescStreet::SetValue(), CEditingActionDescCity::SetValue(), CEditingActionDescState::SetValue(), CEditingActionDescCountry::SetValue(), and CEditingActionDescEmail::SetValue().

◆ GetLabel() [1/3]

bool CPub::GetLabel	(	string *	label,
		ELabelType	type,
		bool	unique = `false`
	)		const

inline

Definition at line 135 of file Pub.hpp.

References IAbstractCitation::fLabel_Unique, GetLabel(), and label.

◆ GetLabel() [2/3]

bool CPub::GetLabel	(	string *	label,
		ELabelType	type = `eContent`,
		TLabelFlags	flags = `0`,
		ELabelVersion	version = `eLabel_DefaultVersion`
	)		const

Concatenate a label for this pub to label.

If flags contains fCitLabel_Unique, add a unique tag to the end of the concatenated label.

Definition at line 76 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_Muid, CPub_Base::e_Pat_id, CPub_Base::e_Patent, CPub_Base::e_Pmid, CPub_Base::e_Proc, CPub_Base::e_Sub, eBoth, eType, flags, Get(), CPub_Base::GetArticle(), CPub_Base::GetBook(), CPub_Base::GetEquiv(), CPub_Base::GetGen(), CPub_Base::GetJournal(), ICitationBase::GetLabel(), CPub_equiv::GetLabel(), CPub_Base::GetMan(), CPub_Base::GetMedline(), CPub_Base::GetMuid(), CPub_Base::GetPat_id(), CPub_Base::GetPatent(), CPub_Base::GetPmid(), CPub_Base::GetProc(), CPub_Base::GetSub(), label, NStr::NumericToString(), string, dtl::version, and CPub_Base::Which().

Referenced by pub_report::CollectData(), GetLabel(), CPub_equiv::GetLabel(), CReferenceItem::Matches(), CCmdFactory::RemoveCitations(), s_CitMatches(), SetMinimumPub(), CRemoveCollidingPubs::x_ApplyToPubdesc(), CReferenceItem::x_CreateUniqueStr(), CNewCleanup_imp::x_NotePubdescOrAnnotPubs_RecursionHelper(), and CNewCleanup_imp::x_RememberPubOldLabel().

◆ GetLabel() [3/3]

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

inlineoverridevirtual

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

Implements IAbstractCitation.

Definition at line 141 of file Pub.hpp.

References eContent, flags, GetLabel(), label, and dtl::version.

◆ GetTitles()

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_titles	Each 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.
iMaxToGet	The maximum number of titles to append to out_title

Definition at line 230 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(), 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().

◆ IsSetAuthors()

bool CPub::IsSetAuthors ( void ) const

◆ operator=()

CPub& CPub::operator= ( const CPub & value )

private

◆ SameCitation()

bool CPub::SameCitation ( const CPub & other ) const

◆ SetAuthors()

CAuth_list & CPub::SetAuthors ( void )

◆ xs_AppendTitles()

void CPub::xs_AppendTitles	(	TOneTitleRefVec &	out_title,
		size_t	iMaxToGet,
		const CTitle &	in_title
	)

staticprivate

Definition at line 331 of file Pub.cpp.

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

Referenced by GetTitles().

◆ xs_GetTitleFromPlainString()

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

staticprivate

Definition at line 323 of file Pub.cpp.

Referenced by GetTitles().

The documentation for this class was generated from the following files:

include/objects/pub/Pub.hpp
src/objects/pub/Pub.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TOneTitleRef

◆ TOneTitleRefVec

◆ Tparent

Member Enumeration Documentation

◆ ELabelType

Constructor & Destructor Documentation

◆ CPub() [1/2]

◆ ~CPub()

◆ CPub() [2/2]

Member Function Documentation

◆ GetAuthors()

◆ GetLabel() [1/3]

◆ GetLabel() [2/3]

◆ GetLabel() [3/3]

◆ GetTitles()

◆ IsSetAuthors()

◆ operator=()

◆ SameCitation()

◆ SetAuthors()

◆ xs_AppendTitles()

◆ xs_GetTitleFromPlainString()