Represents ASN.1 type Cit-book defined in file biblio.asn

#include <objects/biblio/Cit_book.hpp>

Inheritance diagram for CCit_book:

Collaboration diagram for CCit_book:

Public Member Functions
	CCit_book (void)

	~CCit_book (void)

Public Member Functions inherited from CCit_book_Base
	CCit_book_Base (void)

virtual	~CCit_book_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetTitle (void) const
	Title of book Check if a value has been assigned to Title data member. More...

bool	CanGetTitle (void) const
	Check if it is safe to call GetTitle method. More...

void	ResetTitle (void)
	Reset Title data member. More...

const TTitle &	GetTitle (void) const
	Get the Title member data. More...

void	SetTitle (TTitle &value)
	Assign a value to Title data member. More...

TTitle &	SetTitle (void)
	Assign a value to Title data member. More...

bool	IsSetColl (void) const
	part of a collection Check if a value has been assigned to Coll data member. More...

bool	CanGetColl (void) const
	Check if it is safe to call GetColl method. More...

void	ResetColl (void)
	Reset Coll data member. More...

const TColl &	GetColl (void) const
	Get the Coll member data. More...

void	SetColl (TColl &value)
	Assign a value to Coll data member. More...

TColl &	SetColl (void)
	Assign a value to Coll data member. More...

bool	IsSetAuthors (void) const
	authors Check if a value has been assigned to Authors data member. More...

bool	CanGetAuthors (void) const
	Check if it is safe to call GetAuthors method. More...

void	ResetAuthors (void)
	Reset Authors data member. More...

const TAuthors &	GetAuthors (void) const
	Get the Authors member data. More...

void	SetAuthors (TAuthors &value)
	Assign a value to Authors data member. More...

TAuthors &	SetAuthors (void)
	Assign a value to Authors data member. More...

bool	IsSetImp (void) const
	Check if a value has been assigned to Imp data member. More...

bool	CanGetImp (void) const
	Check if it is safe to call GetImp method. More...

void	ResetImp (void)
	Reset Imp data member. More...

const TImp &	GetImp (void) const
	Get the Imp member data. More...

void	SetImp (TImp &value)
	Assign a value to Imp data member. More...

TImp &	SetImp (void)
	Assign a value to Imp data member. More...

virtual void	Reset (void)
	Reset the whole object. 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 CCit_book_Base	Tparent

Private Member Functions
	CCit_book (const CCit_book &value)

CCit_book &	operator= (const CCit_book &value)

Additional Inherited Members
Public Types inherited from CCit_book_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_title , e_coll , e_authors , e_imp }

typedef CTitle	TTitle

typedef CTitle	TColl

typedef CAuth_list	TAuthors

typedef CImprint	TImp

typedef Tparent::CMemberIndex< E_memberIndex, 5 >	TmemberIndex

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

Definition at line 52 of file Cit_book.hpp.

Member Typedef Documentation

◆ Tparent

typedef CCit_book_Base CCit_book::Tparent

private

Definition at line 54 of file Cit_book.hpp.

Constructor & Destructor Documentation

◆ CCit_book() [1/2]

CCit_book::CCit_book ( void )

inline

Definition at line 79 of file Cit_book.hpp.

◆ ~CCit_book()

CCit_book::~CCit_book ( void )

Definition at line 50 of file Cit_book.cpp.

◆ CCit_book() [2/2]

CCit_book::CCit_book ( const CCit_book & value )

private

Member Function Documentation

◆ GetLabelV1()

bool CCit_book::GetLabelV1	(	string *	label,
		TLabelFlags	flags
	)		const

overrideprotectedvirtual

Implements ICitationBase.

Definition at line 55 of file Cit_book.cpp.

References IAbstractCitation::fLabel_Unique, flags, CCit_book_Base::GetAuthors(), CCit_book_Base::GetImp(), CCit_book_Base::GetTitle(), label, and ICitationBase::x_GetLabelV1().

◆ GetLabelV2()

bool CCit_book::GetLabelV2	(	string *	label,
		TLabelFlags	flags
	)		const

overrideprotectedvirtual

Implements ICitationBase.

Definition at line 63 of file Cit_book.cpp.

References CImprint_Base::CanGetPrepub(), CImprint_Base::CanGetPub(), IAbstractCitation::eLabel_V1, CImprint_Base::ePrepub_in_press, flags, CImprint_Base::GetDate(), CCit_book_Base::GetImp(), ICitationBase::GetLabel(), ICitationBase::GetParenthesizedYear(), CImprint_Base::GetPrepub(), CImprint_Base::GetPub(), CTitle::GetTitle(), CCit_book_Base::GetTitle(), label, ICitationBase::MaybeAddSpace(), and NStr::ToUpper().

◆ operator=()

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

private

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

include/objects/biblio/Cit_book.hpp
src/objects/biblio/Cit_book.cpp

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Tparent

Constructor & Destructor Documentation

◆ CCit_book() [1/2]

◆ ~CCit_book()

◆ CCit_book() [2/2]

Member Function Documentation

◆ GetLabelV1()

◆ GetLabelV2()

◆ operator=()