Search Toolkit Book for CEntrez2_field_info

#include <objects/entrez2/Entrez2_field_info.hpp>

Inheritance diagram for CEntrez2_field_info:

Collaboration diagram for CEntrez2_field_info:

Public Member Functions
	CEntrez2_field_info (void)

	~CEntrez2_field_info (void)

Public Member Functions inherited from CEntrez2_field_info_Base
	CEntrez2_field_info_Base (void)

virtual	~CEntrez2_field_info_Base (void)

	DECLARE_INTERNAL_TYPE_INFO ()

bool	IsSetField_name (void) const
	the internal name Check if a value has been assigned to Field_name data member. More...

bool	CanGetField_name (void) const
	Check if it is safe to call GetField_name method. More...

void	ResetField_name (void)
	Reset Field_name data member. More...

const TField_name &	GetField_name (void) const
	Get the Field_name member data. More...

void	SetField_name (const TField_name &value)
	Assign a value to Field_name data member. More...

TField_name &	SetField_name (void)
	Assign a value to Field_name data member. More...

bool	IsSetField_menu (void) const
	short string suitable for menu Check if a value has been assigned to Field_menu data member. More...

bool	CanGetField_menu (void) const
	Check if it is safe to call GetField_menu method. More...

void	ResetField_menu (void)
	Reset Field_menu data member. More...

const TField_menu &	GetField_menu (void) const
	Get the Field_menu member data. More...

void	SetField_menu (const TField_menu &value)
	Assign a value to Field_menu data member. More...

void	SetField_menu (TField_menu &&value)

TField_menu &	SetField_menu (void)
	Assign a value to Field_menu data member. More...

bool	IsSetField_descr (void) const
	longer, explanatory name Check if a value has been assigned to Field_descr data member. More...

bool	CanGetField_descr (void) const
	Check if it is safe to call GetField_descr method. More...

void	ResetField_descr (void)
	Reset Field_descr data member. More...

const TField_descr &	GetField_descr (void) const
	Get the Field_descr member data. More...

void	SetField_descr (const TField_descr &value)
	Assign a value to Field_descr data member. More...

void	SetField_descr (TField_descr &&value)

TField_descr &	SetField_descr (void)
	Assign a value to Field_descr data member. More...

bool	IsSetTerm_count (void) const
	number of terms in field Check if a value has been assigned to Term_count data member. More...

bool	CanGetTerm_count (void) const
	Check if it is safe to call GetTerm_count method. More...

void	ResetTerm_count (void)
	Reset Term_count data member. More...

TTerm_count	GetTerm_count (void) const
	Get the Term_count member data. More...

void	SetTerm_count (TTerm_count value)
	Assign a value to Term_count data member. More...

TTerm_count &	SetTerm_count (void)
	Assign a value to Term_count data member. More...

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

bool	CanGetIs_date (void) const
	Check if it is safe to call GetIs_date method. More...

void	ResetIs_date (void)
	Reset Is_date data member. More...

TIs_date	GetIs_date (void) const
	Get the Is_date member data. More...

void	SetIs_date (TIs_date value)
	Assign a value to Is_date data member. More...

TIs_date &	SetIs_date (void)
	Assign a value to Is_date data member. More...

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

bool	CanGetIs_numerical (void) const
	Check if it is safe to call GetIs_numerical method. More...

void	ResetIs_numerical (void)
	Reset Is_numerical data member. More...

TIs_numerical	GetIs_numerical (void) const
	Get the Is_numerical member data. More...

void	SetIs_numerical (TIs_numerical value)
	Assign a value to Is_numerical data member. More...

TIs_numerical &	SetIs_numerical (void)
	Assign a value to Is_numerical data member. More...

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

bool	CanGetSingle_token (void) const
	Check if it is safe to call GetSingle_token method. More...

void	ResetSingle_token (void)
	Reset Single_token data member. More...

TSingle_token	GetSingle_token (void) const
	Get the Single_token member data. More...

void	SetSingle_token (TSingle_token value)
	Assign a value to Single_token data member. More...

TSingle_token &	SetSingle_token (void)
	Assign a value to Single_token data member. More...

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

bool	CanGetHierarchy_avail (void) const
	Check if it is safe to call GetHierarchy_avail method. More...

void	ResetHierarchy_avail (void)
	Reset Hierarchy_avail data member. More...

THierarchy_avail	GetHierarchy_avail (void) const
	Get the Hierarchy_avail member data. More...

void	SetHierarchy_avail (THierarchy_avail value)
	Assign a value to Hierarchy_avail data member. More...

THierarchy_avail &	SetHierarchy_avail (void)
	Assign a value to Hierarchy_avail data member. More...

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

bool	CanGetIs_rangable (void) const
	Check if it is safe to call GetIs_rangable method. More...

void	ResetIs_rangable (void)
	Reset Is_rangable data member. More...

TIs_rangable	GetIs_rangable (void) const
	Get the Is_rangable member data. More...

void	SetIs_rangable (TIs_rangable value)
	Assign a value to Is_rangable data member. More...

TIs_rangable &	SetIs_rangable (void)
	Assign a value to Is_rangable data member. More...

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

bool	CanGetIs_truncatable (void) const
	Check if it is safe to call GetIs_truncatable method. More...

void	ResetIs_truncatable (void)
	Reset Is_truncatable data member. More...

TIs_truncatable	GetIs_truncatable (void) const
	Get the Is_truncatable member data. More...

void	SetIs_truncatable (TIs_truncatable value)
	Assign a value to Is_truncatable data member. More...

TIs_truncatable &	SetIs_truncatable (void)
	Assign a value to Is_truncatable 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 CEntrez2_field_info_Base	Tparent

Private Member Functions
	CEntrez2_field_info (const CEntrez2_field_info &value)

CEntrez2_field_info &	operator= (const CEntrez2_field_info &value)

Additional Inherited Members
Public Types inherited from CEntrez2_field_info_Base
enum class	E_memberIndex { e__allMandatory = 0 , e_field_name , e_field_menu , e_field_descr , e_term_count , e_is_date , e_is_numerical , e_single_token , e_hierarchy_avail , e_is_rangable , e_is_truncatable }

typedef CEntrez2_field_id	TField_name

typedef string	TField_menu

typedef string	TField_descr

typedef int	TTerm_count

typedef bool	TIs_date

typedef bool	TIs_numerical

typedef bool	TSingle_token

typedef bool	THierarchy_avail

typedef bool	TIs_rangable

typedef bool	TIs_truncatable

typedef Tparent::CMemberIndex< E_memberIndex, 11 >	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 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

CEntrez2_field_info –.

Definition at line 65 of file Entrez2_field_info.hpp.

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

include/objects/entrez2/Entrez2_field_info.hpp
src/objects/entrez2/Entrez2_field_info.cpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description