Search Toolkit Book for CPC_XRefData_Base

Depositor Provided X-Ref and LinkOut data for Entrez. More...

#include <objects/pcsubstance/PC_XRefData_.hpp>

Inheritance diagram for CPC_XRefData_Base:

Collaboration diagram for CPC_XRefData_Base:

Public Types
enum	E_Choice { e_not_set = 0 , e_Regid , e_Rn , e_Mesh , e_Pmid , e_Gi , e_Mmdb , e_Sid , e_Cid , e_Dburl , e_Sburl , e_Asurl , e_Protein_gi , e_Nucleotide_gi , e_Taxonomy , e_Aid , e_Mim , e_Gene , e_Probe , e_Biosystem , e_Geogse , e_Geogsm , e_Patent , e_Protein_accession , e_Nucleotide_accession , e_Doi , e_Citation }
	Choice variants. More...

enum	E_ChoiceStopper { e_MaxChoice = 27 }
	Maximum+1 value of the choice variant enumerator. More...

typedef string	TRegid

typedef string	TRn

typedef string	TMesh

typedef int	TPmid

typedef int	TGi

typedef int	TMmdb

typedef int	TSid

typedef int	TCid

typedef string	TDburl

typedef string	TSburl

typedef string	TAsurl

typedef int	TProtein_gi

typedef int	TNucleotide_gi

typedef int	TTaxonomy

typedef int	TAid

typedef int	TMim

typedef int	TGene

typedef int	TProbe

typedef int	TBiosystem

typedef int	TGeogse

typedef int	TGeogsm

typedef string	TPatent

typedef string	TProtein_accession

typedef string	TNucleotide_accession

typedef string	TDoi

typedef string	TCitation

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 Member Functions
	CPC_XRefData_Base (void)

virtual	~CPC_XRefData_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	IsRegid (void) const
	Check if variant Regid is selected. More...

const TRegid &	GetRegid (void) const
	Get the variant data. More...

TRegid &	SetRegid (void)
	Select the variant. More...

void	SetRegid (const TRegid &value)
	Select the variant and set its data. More...

bool	IsRn (void) const
	Check if variant Rn is selected. More...

const TRn &	GetRn (void) const
	Get the variant data. More...

TRn &	SetRn (void)
	Select the variant. More...

void	SetRn (const TRn &value)
	Select the variant and set its data. More...

bool	IsMesh (void) const
	Check if variant Mesh is selected. More...

const TMesh &	GetMesh (void) const
	Get the variant data. More...

TMesh &	SetMesh (void)
	Select the variant. More...

void	SetMesh (const TMesh &value)
	Select the variant and set its data. More...

bool	IsPmid (void) const
	Check if variant Pmid is selected. More...

TPmid	GetPmid (void) const
	Get the variant data. More...

TPmid &	SetPmid (void)
	Select the variant. More...

void	SetPmid (TPmid value)
	Select the variant and set its data. More...

bool	IsGi (void) const
	Check if variant Gi is selected. More...

TGi	GetGi (void) const
	Get the variant data. More...

TGi &	SetGi (void)
	Select the variant. More...

void	SetGi (TGi value)
	Select the variant and set its data. More...

bool	IsMmdb (void) const
	Check if variant Mmdb is selected. More...

TMmdb	GetMmdb (void) const
	Get the variant data. More...

TMmdb &	SetMmdb (void)
	Select the variant. More...

void	SetMmdb (TMmdb value)
	Select the variant and set its data. More...

bool	IsSid (void) const
	Check if variant Sid is selected. More...

TSid	GetSid (void) const
	Get the variant data. More...

TSid &	SetSid (void)
	Select the variant. More...

void	SetSid (TSid value)
	Select the variant and set its data. More...

bool	IsCid (void) const
	Check if variant Cid is selected. More...

TCid	GetCid (void) const
	Get the variant data. More...

TCid &	SetCid (void)
	Select the variant. More...

void	SetCid (TCid value)
	Select the variant and set its data. More...

bool	IsDburl (void) const
	Check if variant Dburl is selected. More...

const TDburl &	GetDburl (void) const
	Get the variant data. More...

TDburl &	SetDburl (void)
	Select the variant. More...

void	SetDburl (const TDburl &value)
	Select the variant and set its data. More...

bool	IsSburl (void) const
	Check if variant Sburl is selected. More...

const TSburl &	GetSburl (void) const
	Get the variant data. More...

TSburl &	SetSburl (void)
	Select the variant. More...

void	SetSburl (const TSburl &value)
	Select the variant and set its data. More...

bool	IsAsurl (void) const
	Check if variant Asurl is selected. More...

const TAsurl &	GetAsurl (void) const
	Get the variant data. More...

TAsurl &	SetAsurl (void)
	Select the variant. More...

void	SetAsurl (const TAsurl &value)
	Select the variant and set its data. More...

bool	IsProtein_gi (void) const
	Check if variant Protein_gi is selected. More...

TProtein_gi	GetProtein_gi (void) const
	Get the variant data. More...

TProtein_gi &	SetProtein_gi (void)
	Select the variant. More...

void	SetProtein_gi (TProtein_gi value)
	Select the variant and set its data. More...

bool	IsNucleotide_gi (void) const
	Check if variant Nucleotide_gi is selected. More...

TNucleotide_gi	GetNucleotide_gi (void) const
	Get the variant data. More...

TNucleotide_gi &	SetNucleotide_gi (void)
	Select the variant. More...

void	SetNucleotide_gi (TNucleotide_gi value)
	Select the variant and set its data. More...

bool	IsTaxonomy (void) const
	Check if variant Taxonomy is selected. More...

TTaxonomy	GetTaxonomy (void) const
	Get the variant data. More...

TTaxonomy &	SetTaxonomy (void)
	Select the variant. More...

void	SetTaxonomy (TTaxonomy value)
	Select the variant and set its data. More...

bool	IsAid (void) const
	Check if variant Aid is selected. More...

TAid	GetAid (void) const
	Get the variant data. More...

TAid &	SetAid (void)
	Select the variant. More...

void	SetAid (TAid value)
	Select the variant and set its data. More...

bool	IsMim (void) const
	Check if variant Mim is selected. More...

TMim	GetMim (void) const
	Get the variant data. More...

TMim &	SetMim (void)
	Select the variant. More...

void	SetMim (TMim value)
	Select the variant and set its data. More...

bool	IsGene (void) const
	Check if variant Gene is selected. More...

TGene	GetGene (void) const
	Get the variant data. More...

TGene &	SetGene (void)
	Select the variant. More...

void	SetGene (TGene value)
	Select the variant and set its data. More...

bool	IsProbe (void) const
	Check if variant Probe is selected. More...

TProbe	GetProbe (void) const
	Get the variant data. More...

TProbe &	SetProbe (void)
	Select the variant. More...

void	SetProbe (TProbe value)
	Select the variant and set its data. More...

bool	IsBiosystem (void) const
	Check if variant Biosystem is selected. More...

TBiosystem	GetBiosystem (void) const
	Get the variant data. More...

TBiosystem &	SetBiosystem (void)
	Select the variant. More...

void	SetBiosystem (TBiosystem value)
	Select the variant and set its data. More...

bool	IsGeogse (void) const
	Check if variant Geogse is selected. More...

TGeogse	GetGeogse (void) const
	Get the variant data. More...

TGeogse &	SetGeogse (void)
	Select the variant. More...

void	SetGeogse (TGeogse value)
	Select the variant and set its data. More...

bool	IsGeogsm (void) const
	Check if variant Geogsm is selected. More...

TGeogsm	GetGeogsm (void) const
	Get the variant data. More...

TGeogsm &	SetGeogsm (void)
	Select the variant. More...

void	SetGeogsm (TGeogsm 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 (const TPatent &value)
	Select the variant and set its data. More...

bool	IsProtein_accession (void) const
	Check if variant Protein_accession is selected. More...

const TProtein_accession &	GetProtein_accession (void) const
	Get the variant data. More...

TProtein_accession &	SetProtein_accession (void)
	Select the variant. More...

void	SetProtein_accession (const TProtein_accession &value)
	Select the variant and set its data. More...

bool	IsNucleotide_accession (void) const
	Check if variant Nucleotide_accession is selected. More...

const TNucleotide_accession &	GetNucleotide_accession (void) const
	Get the variant data. More...

TNucleotide_accession &	SetNucleotide_accession (void)
	Select the variant. More...

void	SetNucleotide_accession (const TNucleotide_accession &value)
	Select the variant and set its data. More...

bool	IsDoi (void) const
	Check if variant Doi is selected. More...

const TDoi &	GetDoi (void) const
	Get the variant data. More...

TDoi &	SetDoi (void)
	Select the variant. More...

void	SetDoi (const TDoi &value)
	Select the variant and set its data. More...

bool	IsCitation (void) const
	Check if variant Citation is selected. More...

const TCitation &	GetCitation (void) const
	Get the variant data. More...

TCitation &	SetCitation (void)
	Select the variant. More...

void	SetCitation (const TCitation &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

Static Public Member Functions
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)

Private Types
typedef CSerialObject	Tparent

Private Member Functions
	CPC_XRefData_Base (const CPC_XRefData_Base &)

CPC_XRefData_Base &	operator= (const CPC_XRefData_Base &)

void	DoSelect (E_Choice index, CObjectMemoryPool *pool=0)

Private Attributes
E_Choice	m_choice

union {
TPmid CPC_XRefData_Base::m_Pmid

TGi CPC_XRefData_Base::m_Gi

TMmdb CPC_XRefData_Base::m_Mmdb

TSid CPC_XRefData_Base::m_Sid

TCid CPC_XRefData_Base::m_Cid

TProtein_gi CPC_XRefData_Base::m_Protein_gi

TNucleotide_gi CPC_XRefData_Base::m_Nucleotide_gi

TTaxonomy CPC_XRefData_Base::m_Taxonomy

TAid CPC_XRefData_Base::m_Aid

TMim CPC_XRefData_Base::m_Mim

TGene CPC_XRefData_Base::m_Gene

TProbe CPC_XRefData_Base::m_Probe

TBiosystem CPC_XRefData_Base::m_Biosystem

TGeogse CPC_XRefData_Base::m_Geogse

TGeogsm CPC_XRefData_Base::m_Geogsm

NCBI_NS_NCBI::CUnionBuffer< NCBI_NS_STD::string > CPC_XRefData_Base::m_string

void * CPC_XRefData_Base::m_dummy_pointer_for_alignment

};

Static Private Attributes
static const char *const	sm_SelectionNames []

Additional Inherited Members
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

Depositor Provided X-Ref and LinkOut data for Entrez.

CPC_XRefData_Base –

Definition at line 73 of file PC_XRefData_.hpp.

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

include/objects/pcsubstance/PC_XRefData_.hpp
src/objects/pcsubstance/PC_XRefData_.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description