#include <objects/homologene/HG_Entry.hpp>

Inheritance diagram for CHG_Entry:

Collaboration diagram for CHG_Entry:

Public Types
typedef TGenes	TCore_genes

Public Types inherited from CHG_Entry_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_hg_id , e_version , e_title , e_caption , e_taxid , e_genes , e_cr_date , e_up_date , e_distances , e_commentaries , e_warnings , e_node }

typedef int	THg_id

typedef int	TVersion

typedef string	TTitle

typedef string	TCaption

typedef int	TTaxid

typedef list< CRef< CHG_Gene > >	TGenes

typedef CDate	TCr_date

typedef CDate	TUp_date

typedef list< CRef< CHG_Stats > >	TDistances

typedef list< CRef< CHG_CommentarySet > >	TCommentaries

typedef list< string >	TWarnings

typedef CHG_Node	TNode

typedef Tparent::CMemberIndex< E_memberIndex, 13 >	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 Member Functions
	CHG_Entry (void)

	~CHG_Entry (void)

bool	IsSetCore_genes (void) const

bool	CanGetCore_genes (void) const

void	ResetCore_genes (void)

const TCore_genes &	GetCore_genes (void) const

TCore_genes &	SetCore_genes (void)

Public Member Functions inherited from CHG_Entry_Base
	CHG_Entry_Base (void)

virtual	~CHG_Entry_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

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

bool	CanGetHg_id (void) const
	Check if it is safe to call GetHg_id method. More...

void	ResetHg_id (void)
	Reset Hg_id data member. More...

THg_id	GetHg_id (void) const
	Get the Hg_id member data. More...

void	SetHg_id (THg_id value)
	Assign a value to Hg_id data member. More...

THg_id &	SetHg_id (void)
	Assign a value to Hg_id data member. More...

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

bool	CanGetVersion (void) const
	Check if it is safe to call GetVersion method. More...

void	ResetVersion (void)
	Reset Version data member. More...

TVersion	GetVersion (void) const
	Get the Version member data. More...

void	SetVersion (TVersion value)
	Assign a value to Version data member. More...

TVersion &	SetVersion (void)
	Assign a value to Version data member. More...

bool	IsSetTitle (void) const
	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 (const TTitle &value)
	Assign a value to Title data member. More...

void	SetTitle (TTitle &&value)

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

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

bool	CanGetCaption (void) const
	Check if it is safe to call GetCaption method. More...

void	ResetCaption (void)
	Reset Caption data member. More...

const TCaption &	GetCaption (void) const
	Get the Caption member data. More...

void	SetCaption (const TCaption &value)
	Assign a value to Caption data member. More...

void	SetCaption (TCaption &&value)

TCaption &	SetCaption (void)
	Assign a value to Caption data member. More...

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

bool	CanGetTaxid (void) const
	Check if it is safe to call GetTaxid method. More...

void	ResetTaxid (void)
	Reset Taxid data member. More...

TTaxid	GetTaxid (void) const
	Get the Taxid member data. More...

void	SetTaxid (TTaxid value)
	Assign a value to Taxid data member. More...

TTaxid &	SetTaxid (void)
	Assign a value to Taxid data member. More...

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

bool	CanGetGenes (void) const
	Check if it is safe to call GetGenes method. More...

void	ResetGenes (void)
	Reset Genes data member. More...

const TGenes &	GetGenes (void) const
	Get the Genes member data. More...

TGenes &	SetGenes (void)
	Assign a value to Genes data member. More...

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

bool	CanGetCr_date (void) const
	Check if it is safe to call GetCr_date method. More...

void	ResetCr_date (void)
	Reset Cr_date data member. More...

const TCr_date &	GetCr_date (void) const
	Get the Cr_date member data. More...

void	SetCr_date (TCr_date &value)
	Assign a value to Cr_date data member. More...

TCr_date &	SetCr_date (void)
	Assign a value to Cr_date data member. More...

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

bool	CanGetUp_date (void) const
	Check if it is safe to call GetUp_date method. More...

void	ResetUp_date (void)
	Reset Up_date data member. More...

const TUp_date &	GetUp_date (void) const
	Get the Up_date member data. More...

void	SetUp_date (TUp_date &value)
	Assign a value to Up_date data member. More...

TUp_date &	SetUp_date (void)
	Assign a value to Up_date data member. More...

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

bool	CanGetDistances (void) const
	Check if it is safe to call GetDistances method. More...

void	ResetDistances (void)
	Reset Distances data member. More...

const TDistances &	GetDistances (void) const
	Get the Distances member data. More...

TDistances &	SetDistances (void)
	Assign a value to Distances data member. More...

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

bool	CanGetCommentaries (void) const
	Check if it is safe to call GetCommentaries method. More...

void	ResetCommentaries (void)
	Reset Commentaries data member. More...

const TCommentaries &	GetCommentaries (void) const
	Get the Commentaries member data. More...

TCommentaries &	SetCommentaries (void)
	Assign a value to Commentaries data member. More...

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

bool	CanGetWarnings (void) const
	Check if it is safe to call GetWarnings method. More...

void	ResetWarnings (void)
	Reset Warnings data member. More...

const TWarnings &	GetWarnings (void) const
	Get the Warnings member data. More...

TWarnings &	SetWarnings (void)
	Assign a value to Warnings data member. More...

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

bool	CanGetNode (void) const
	Check if it is safe to call GetNode method. More...

void	ResetNode (void)
	Reset Node data member. More...

const TNode &	GetNode (void) const
	Get the Node member data. More...

void	SetNode (TNode &value)
	Assign a value to Node data member. More...

TNode &	SetNode (void)
	Assign a value to Node 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 CHG_Entry_Base	Tparent

Private Member Functions
	CHG_Entry (const CHG_Entry &value)

CHG_Entry &	operator= (const CHG_Entry &value)

Additional Inherited Members
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 50 of file HG_Entry.hpp.

Member Typedef Documentation

◆ TCore_genes

typedef TGenes CHG_Entry::TCore_genes

Definition at line 66 of file HG_Entry.hpp.

◆ Tparent

typedef CHG_Entry_Base CHG_Entry::Tparent

private

Definition at line 52 of file HG_Entry.hpp.

Constructor & Destructor Documentation

◆ CHG_Entry() [1/2]

CHG_Entry::CHG_Entry ( void )

inline

Definition at line 81 of file HG_Entry.hpp.

◆ ~CHG_Entry()

CHG_Entry::~CHG_Entry ( void )

Definition at line 50 of file HG_Entry.cpp.

◆ CHG_Entry() [2/2]

CHG_Entry::CHG_Entry ( const CHG_Entry & value )

private

Member Function Documentation

◆ CanGetCore_genes()

bool CHG_Entry::CanGetCore_genes ( void ) const

inline

Definition at line 69 of file HG_Entry.hpp.

References CHG_Entry_Base::CanGetGenes().

◆ GetCore_genes()

const TCore_genes& CHG_Entry::GetCore_genes ( void ) const

inline

Definition at line 71 of file HG_Entry.hpp.

References CHG_Entry_Base::GetGenes().

◆ IsSetCore_genes()

bool CHG_Entry::IsSetCore_genes ( void ) const

inline

Definition at line 68 of file HG_Entry.hpp.

References CHG_Entry_Base::IsSetGenes().

◆ operator=()

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

private

◆ ResetCore_genes()

void CHG_Entry::ResetCore_genes ( void )

inline

Definition at line 70 of file HG_Entry.hpp.

References CHG_Entry_Base::ResetGenes().

◆ SetCore_genes()

TCore_genes& CHG_Entry::SetCore_genes ( void )

inline

Definition at line 72 of file HG_Entry.hpp.

References CHG_Entry_Base::SetGenes().

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

include/objects/homologene/HG_Entry.hpp
src/objects/homologene/HG_Entry.cpp

Public Types

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TCore_genes

◆ Tparent

Constructor & Destructor Documentation

◆ CHG_Entry() [1/2]

◆ ~CHG_Entry()

◆ CHG_Entry() [2/2]

Member Function Documentation

◆ CanGetCore_genes()

◆ GetCore_genes()

◆ IsSetCore_genes()

◆ operator=()

◆ ResetCore_genes()

◆ SetCore_genes()