CMim_reference Class Reference

Search Toolkit Book for CMim_reference

CMim_reference –. More...

#include <objects/mim/Mim_reference.hpp>

Inheritance diagram for CMim_reference:

Collaboration diagram for CMim_reference:

Public Member Functions
	CMim_reference (void)
	~CMim_reference (void)
Public Member Functions inherited from CMim_reference_Base
	CMim_reference_Base (void)
virtual	~CMim_reference_Base (void)
	DECLARE_INTERNAL_TYPE_INFO ()
bool	IsSetNumber (void) const
	Check if a value has been assigned to Number data member. More...
bool	CanGetNumber (void) const
	Check if it is safe to call GetNumber method. More...
void	ResetNumber (void)
	Reset Number data member. More...
TNumber	GetNumber (void) const
	Get the Number member data. More...
void	SetNumber (TNumber value)
	Assign a value to Number data member. More...
TNumber &	SetNumber (void)
	Assign a value to Number data member. More...
bool	IsSetOrigNumber (void) const
	Check if a value has been assigned to OrigNumber data member. More...
bool	CanGetOrigNumber (void) const
	Check if it is safe to call GetOrigNumber method. More...
void	ResetOrigNumber (void)
	Reset OrigNumber data member. More...
TOrigNumber	GetOrigNumber (void) const
	Get the OrigNumber member data. More...
void	SetOrigNumber (TOrigNumber value)
	Assign a value to OrigNumber data member. More...
TOrigNumber &	SetOrigNumber (void)
	Assign a value to OrigNumber data member. More...
bool	IsSetType (void) const
	Check if a value has been assigned to Type data member. More...
bool	CanGetType (void) const
	Check if it is safe to call GetType method. More...
void	ResetType (void)
	Reset Type data member. More...
TType	GetType (void) const
	Get the Type member data. More...
void	SetType (TType value)
	Assign a value to Type data member. More...
TType &	SetType (void)
	Assign a value to Type data member. More...
bool	IsSetAuthors (void) const
	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...
TAuthors &	SetAuthors (void)
	Assign a value to Authors data member. More...
bool	IsSetPrimaryAuthor (void) const
	Check if a value has been assigned to PrimaryAuthor data member. More...
bool	CanGetPrimaryAuthor (void) const
	Check if it is safe to call GetPrimaryAuthor method. More...
void	ResetPrimaryAuthor (void)
	Reset PrimaryAuthor data member. More...
const TPrimaryAuthor &	GetPrimaryAuthor (void) const
	Get the PrimaryAuthor member data. More...
void	SetPrimaryAuthor (const TPrimaryAuthor &value)
	Assign a value to PrimaryAuthor data member. More...
void	SetPrimaryAuthor (TPrimaryAuthor &&value)
TPrimaryAuthor &	SetPrimaryAuthor (void)
	Assign a value to PrimaryAuthor data member. More...
bool	IsSetOtherAuthors (void) const
	Check if a value has been assigned to OtherAuthors data member. More...
bool	CanGetOtherAuthors (void) const
	Check if it is safe to call GetOtherAuthors method. More...
void	ResetOtherAuthors (void)
	Reset OtherAuthors data member. More...
const TOtherAuthors &	GetOtherAuthors (void) const
	Get the OtherAuthors member data. More...
void	SetOtherAuthors (const TOtherAuthors &value)
	Assign a value to OtherAuthors data member. More...
void	SetOtherAuthors (TOtherAuthors &&value)
TOtherAuthors &	SetOtherAuthors (void)
	Assign a value to OtherAuthors data member. More...
bool	IsSetCitationTitle (void) const
	Check if a value has been assigned to CitationTitle data member. More...
bool	CanGetCitationTitle (void) const
	Check if it is safe to call GetCitationTitle method. More...
void	ResetCitationTitle (void)
	Reset CitationTitle data member. More...
const TCitationTitle &	GetCitationTitle (void) const
	Get the CitationTitle member data. More...
void	SetCitationTitle (const TCitationTitle &value)
	Assign a value to CitationTitle data member. More...
void	SetCitationTitle (TCitationTitle &&value)
TCitationTitle &	SetCitationTitle (void)
	Assign a value to CitationTitle data member. More...
bool	IsSetCitationType (void) const
	Check if a value has been assigned to CitationType data member. More...
bool	CanGetCitationType (void) const
	Check if it is safe to call GetCitationType method. More...
void	ResetCitationType (void)
	Reset CitationType data member. More...
TCitationType	GetCitationType (void) const
	Get the CitationType member data. More...
void	SetCitationType (TCitationType value)
	Assign a value to CitationType data member. More...
TCitationType &	SetCitationType (void)
	Assign a value to CitationType data member. More...
bool	IsSetBookTitle (void) const
	Check if a value has been assigned to BookTitle data member. More...
bool	CanGetBookTitle (void) const
	Check if it is safe to call GetBookTitle method. More...
void	ResetBookTitle (void)
	Reset BookTitle data member. More...
const TBookTitle &	GetBookTitle (void) const
	Get the BookTitle member data. More...
void	SetBookTitle (const TBookTitle &value)
	Assign a value to BookTitle data member. More...
void	SetBookTitle (TBookTitle &&value)
TBookTitle &	SetBookTitle (void)
	Assign a value to BookTitle data member. More...
bool	IsSetEditors (void) const
	Check if a value has been assigned to Editors data member. More...
bool	CanGetEditors (void) const
	Check if it is safe to call GetEditors method. More...
void	ResetEditors (void)
	Reset Editors data member. More...
const TEditors &	GetEditors (void) const
	Get the Editors member data. More...
TEditors &	SetEditors (void)
	Assign a value to Editors data member. More...
bool	IsSetVolume (void) const
	Check if a value has been assigned to Volume data member. More...
bool	CanGetVolume (void) const
	Check if it is safe to call GetVolume method. More...
void	ResetVolume (void)
	Reset Volume data member. More...
const TVolume &	GetVolume (void) const
	Get the Volume member data. More...
void	SetVolume (const TVolume &value)
	Assign a value to Volume data member. More...
void	SetVolume (TVolume &&value)
TVolume &	SetVolume (void)
	Assign a value to Volume data member. More...
bool	IsSetEdition (void) const
	Check if a value has been assigned to Edition data member. More...
bool	CanGetEdition (void) const
	Check if it is safe to call GetEdition method. More...
void	ResetEdition (void)
	Reset Edition data member. More...
const TEdition &	GetEdition (void) const
	Get the Edition member data. More...
void	SetEdition (const TEdition &value)
	Assign a value to Edition data member. More...
void	SetEdition (TEdition &&value)
TEdition &	SetEdition (void)
	Assign a value to Edition data member. More...
bool	IsSetJournal (void) const
	Check if a value has been assigned to Journal data member. More...
bool	CanGetJournal (void) const
	Check if it is safe to call GetJournal method. More...
void	ResetJournal (void)
	Reset Journal data member. More...
const TJournal &	GetJournal (void) const
	Get the Journal member data. More...
void	SetJournal (const TJournal &value)
	Assign a value to Journal data member. More...
void	SetJournal (TJournal &&value)
TJournal &	SetJournal (void)
	Assign a value to Journal data member. More...
bool	IsSetSeries (void) const
	Check if a value has been assigned to Series data member. More...
bool	CanGetSeries (void) const
	Check if it is safe to call GetSeries method. More...
void	ResetSeries (void)
	Reset Series data member. More...
const TSeries &	GetSeries (void) const
	Get the Series member data. More...
void	SetSeries (const TSeries &value)
	Assign a value to Series data member. More...
void	SetSeries (TSeries &&value)
TSeries &	SetSeries (void)
	Assign a value to Series data member. More...
bool	IsSetPublisher (void) const
	Check if a value has been assigned to Publisher data member. More...
bool	CanGetPublisher (void) const
	Check if it is safe to call GetPublisher method. More...
void	ResetPublisher (void)
	Reset Publisher data member. More...
const TPublisher &	GetPublisher (void) const
	Get the Publisher member data. More...
void	SetPublisher (const TPublisher &value)
	Assign a value to Publisher data member. More...
void	SetPublisher (TPublisher &&value)
TPublisher &	SetPublisher (void)
	Assign a value to Publisher data member. More...
bool	IsSetPlace (void) const
	Check if a value has been assigned to Place data member. More...
bool	CanGetPlace (void) const
	Check if it is safe to call GetPlace method. More...
void	ResetPlace (void)
	Reset Place data member. More...
const TPlace &	GetPlace (void) const
	Get the Place member data. More...
void	SetPlace (const TPlace &value)
	Assign a value to Place data member. More...
void	SetPlace (TPlace &&value)
TPlace &	SetPlace (void)
	Assign a value to Place data member. More...
bool	IsSetCommNote (void) const
	Check if a value has been assigned to CommNote data member. More...
bool	CanGetCommNote (void) const
	Check if it is safe to call GetCommNote method. More...
void	ResetCommNote (void)
	Reset CommNote data member. More...
const TCommNote &	GetCommNote (void) const
	Get the CommNote member data. More...
void	SetCommNote (const TCommNote &value)
	Assign a value to CommNote data member. More...
void	SetCommNote (TCommNote &&value)
TCommNote &	SetCommNote (void)
	Assign a value to CommNote data member. More...
bool	IsSetPubDate (void) const
	Check if a value has been assigned to PubDate data member. More...
bool	CanGetPubDate (void) const
	Check if it is safe to call GetPubDate method. More...
void	ResetPubDate (void)
	Reset PubDate data member. More...
const TPubDate &	GetPubDate (void) const
	Get the PubDate member data. More...
void	SetPubDate (TPubDate &value)
	Assign a value to PubDate data member. More...
TPubDate &	SetPubDate (void)
	Assign a value to PubDate data member. More...
bool	IsSetPages (void) const
	Check if a value has been assigned to Pages data member. More...
bool	CanGetPages (void) const
	Check if it is safe to call GetPages method. More...
void	ResetPages (void)
	Reset Pages data member. More...
const TPages &	GetPages (void) const
	Get the Pages member data. More...
TPages &	SetPages (void)
	Assign a value to Pages data member. More...
bool	IsSetMiscInfo (void) const
	Check if a value has been assigned to MiscInfo data member. More...
bool	CanGetMiscInfo (void) const
	Check if it is safe to call GetMiscInfo method. More...
void	ResetMiscInfo (void)
	Reset MiscInfo data member. More...
const TMiscInfo &	GetMiscInfo (void) const
	Get the MiscInfo member data. More...
void	SetMiscInfo (const TMiscInfo &value)
	Assign a value to MiscInfo data member. More...
void	SetMiscInfo (TMiscInfo &&value)
TMiscInfo &	SetMiscInfo (void)
	Assign a value to MiscInfo data member. More...
bool	IsSetPubmedUID (void) const
	Check if a value has been assigned to PubmedUID data member. More...
bool	CanGetPubmedUID (void) const
	Check if it is safe to call GetPubmedUID method. More...
void	ResetPubmedUID (void)
	Reset PubmedUID data member. More...
TPubmedUID	GetPubmedUID (void) const
	Get the PubmedUID member data. More...
void	SetPubmedUID (TPubmedUID value)
	Assign a value to PubmedUID data member. More...
TPubmedUID &	SetPubmedUID (void)
	Assign a value to PubmedUID data member. More...
bool	IsSetAmbiguous (void) const
	Check if a value has been assigned to Ambiguous data member. More...
bool	CanGetAmbiguous (void) const
	Check if it is safe to call GetAmbiguous method. More...
void	ResetAmbiguous (void)
	Reset Ambiguous data member. More...
TAmbiguous	GetAmbiguous (void) const
	Get the Ambiguous member data. More...
void	SetAmbiguous (TAmbiguous value)
	Assign a value to Ambiguous data member. More...
TAmbiguous &	SetAmbiguous (void)
	Assign a value to Ambiguous data member. More...
bool	IsSetNoLink (void) const
	Check if a value has been assigned to NoLink data member. More...
bool	CanGetNoLink (void) const
	Check if it is safe to call GetNoLink method. More...
void	ResetNoLink (void)
	Reset NoLink data member. More...
TNoLink	GetNoLink (void) const
	Get the NoLink member data. More...
void	SetNoLink (TNoLink value)
	Assign a value to NoLink data member. More...
TNoLink &	SetNoLink (void)
	Assign a value to NoLink 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

Private Types
typedef CMim_reference_Base	Tparent

Private Member Functions
	CMim_reference (const CMim_reference &value)
CMim_reference &	operator= (const CMim_reference &value)

Additional Inherited Members
Public Types inherited from CMim_reference_Base
enum	EType {   eType_not_set = 0 , eType_citation = 1 , eType_book = 2 , eType_personal_communication = 3 ,   eType_book_citation = 4 }
enum class	E_memberIndex {   e__allMandatory = 0 , e_number , e_origNumber , e_type ,   e_authors , e_primaryAuthor , e_otherAuthors , e_citationTitle ,   e_citationType , e_bookTitle , e_editors , e_volume ,   e_edition , e_journal , e_series , e_publisher ,   e_place , e_commNote , e_pubDate , e_pages ,   e_miscInfo , e_pubmedUID , e_ambiguous , e_noLink }
typedef int	TNumber
typedef int	TOrigNumber
typedef EType	TType
typedef list< CRef< CMim_author > >	TAuthors
typedef string	TPrimaryAuthor
typedef string	TOtherAuthors
typedef string	TCitationTitle
typedef int	TCitationType
typedef string	TBookTitle
typedef list< CRef< CMim_author > >	TEditors
typedef string	TVolume
typedef string	TEdition
typedef string	TJournal
typedef string	TSeries
typedef string	TPublisher
typedef string	TPlace
typedef string	TCommNote
typedef CMim_date	TPubDate
typedef list< CRef< CMim_page > >	TPages
typedef string	TMiscInfo
typedef int	TPubmedUID
typedef bool	TAmbiguous
typedef bool	TNoLink
typedef Tparent::CMemberIndex< E_memberIndex, 24 >	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...
Static Public Member Functions inherited from CMim_reference_Base
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME()	EType (void)
	Access to EType's attributes (values, names) as defined in spec. 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

CMim_reference –.

Definition at line 65 of file Mim_reference.hpp.

---

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

• include/objects/mim/Mim_reference.hpp
• src/objects/mim/Mim_reference.cpp