CBlast_db_metadata Class Reference

Search Toolkit Book for CBlast_db_metadata

CBlast_db_metadata –. More...

#include <objects/blastdb/Blast_db_metadata.hpp>

Inheritance diagram for CBlast_db_metadata:

Collaboration diagram for CBlast_db_metadata:

Public Member Functions
	CBlast_db_metadata (void)
	~CBlast_db_metadata (void)
Public Member Functions inherited from CBlast_db_metadata_Base
	CBlast_db_metadata_Base (void)
virtual	~CBlast_db_metadata_Base (void)
	DECLARE_INTERNAL_TYPE_INFO ()
bool	IsSetVersion (void) const
	Default indicates the starting version 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...
void	SetDefaultVersion (void)
	Assign default value to Version data member. More...
const TVersion &	GetVersion (void) const
	Get the Version member data. More...
void	SetVersion (const TVersion &value)
	Assign a value to Version data member. More...
void	SetVersion (TVersion &&value)
TVersion &	SetVersion (void)
	Assign a value to Version data member. More...
bool	IsSetDbname (void) const
	Check if a value has been assigned to Dbname data member. More...
bool	CanGetDbname (void) const
	Check if it is safe to call GetDbname method. More...
void	ResetDbname (void)
	Reset Dbname data member. More...
const TDbname &	GetDbname (void) const
	Get the Dbname member data. More...
void	SetDbname (const TDbname &value)
	Assign a value to Dbname data member. More...
void	SetDbname (TDbname &&value)
TDbname &	SetDbname (void)
	Assign a value to Dbname data member. More...
bool	IsSetDbtype (void) const
	Check if a value has been assigned to Dbtype data member. More...
bool	CanGetDbtype (void) const
	Check if it is safe to call GetDbtype method. More...
void	ResetDbtype (void)
	Reset Dbtype data member. More...
const TDbtype &	GetDbtype (void) const
	Get the Dbtype member data. More...
void	SetDbtype (const TDbtype &value)
	Assign a value to Dbtype data member. More...
void	SetDbtype (TDbtype &&value)
TDbtype &	SetDbtype (void)
	Assign a value to Dbtype data member. More...
bool	IsSetDb_version (void) const
	Default indicates the starting version Check if a value has been assigned to Db_version data member. More...
bool	CanGetDb_version (void) const
	Check if it is safe to call GetDb_version method. More...
void	ResetDb_version (void)
	Reset Db_version data member. More...
void	SetDefaultDb_version (void)
	Assign default value to Db_version data member. More...
TDb_version	GetDb_version (void) const
	Get the Db_version member data. More...
void	SetDb_version (TDb_version value)
	Assign a value to Db_version data member. More...
TDb_version &	SetDb_version (void)
	Assign a value to Db_version data member. More...
bool	IsSetDescription (void) const
	Check if a value has been assigned to Description data member. More...
bool	CanGetDescription (void) const
	Check if it is safe to call GetDescription method. More...
void	ResetDescription (void)
	Reset Description data member. More...
const TDescription &	GetDescription (void) const
	Get the Description member data. More...
void	SetDescription (const TDescription &value)
	Assign a value to Description data member. More...
void	SetDescription (TDescription &&value)
TDescription &	SetDescription (void)
	Assign a value to Description data member. More...
bool	IsSetNumber_of_letters (void) const
	Check if a value has been assigned to Number_of_letters data member. More...
bool	CanGetNumber_of_letters (void) const
	Check if it is safe to call GetNumber_of_letters method. More...
void	ResetNumber_of_letters (void)
	Reset Number_of_letters data member. More...
TNumber_of_letters	GetNumber_of_letters (void) const
	Get the Number_of_letters member data. More...
void	SetNumber_of_letters (TNumber_of_letters value)
	Assign a value to Number_of_letters data member. More...
TNumber_of_letters &	SetNumber_of_letters (void)
	Assign a value to Number_of_letters data member. More...
bool	IsSetNumber_of_sequences (void) const
	Check if a value has been assigned to Number_of_sequences data member. More...
bool	CanGetNumber_of_sequences (void) const
	Check if it is safe to call GetNumber_of_sequences method. More...
void	ResetNumber_of_sequences (void)
	Reset Number_of_sequences data member. More...
TNumber_of_sequences	GetNumber_of_sequences (void) const
	Get the Number_of_sequences member data. More...
void	SetNumber_of_sequences (TNumber_of_sequences value)
	Assign a value to Number_of_sequences data member. More...
TNumber_of_sequences &	SetNumber_of_sequences (void)
	Assign a value to Number_of_sequences data member. More...
bool	IsSetLast_updated (void) const
	Check if a value has been assigned to Last_updated data member. More...
bool	CanGetLast_updated (void) const
	Check if it is safe to call GetLast_updated method. More...
void	ResetLast_updated (void)
	Reset Last_updated data member. More...
const TLast_updated &	GetLast_updated (void) const
	Get the Last_updated member data. More...
void	SetLast_updated (const TLast_updated &value)
	Assign a value to Last_updated data member. More...
void	SetLast_updated (TLast_updated &&value)
TLast_updated &	SetLast_updated (void)
	Assign a value to Last_updated data member. More...
bool	IsSetNumber_of_volumes (void) const
	Check if a value has been assigned to Number_of_volumes data member. More...
bool	CanGetNumber_of_volumes (void) const
	Check if it is safe to call GetNumber_of_volumes method. More...
void	ResetNumber_of_volumes (void)
	Reset Number_of_volumes data member. More...
TNumber_of_volumes	GetNumber_of_volumes (void) const
	Get the Number_of_volumes member data. More...
void	SetNumber_of_volumes (TNumber_of_volumes value)
	Assign a value to Number_of_volumes data member. More...
TNumber_of_volumes &	SetNumber_of_volumes (void)
	Assign a value to Number_of_volumes data member. More...
bool	IsSetNumber_of_taxids (void) const
	Check if a value has been assigned to Number_of_taxids data member. More...
bool	CanGetNumber_of_taxids (void) const
	Check if it is safe to call GetNumber_of_taxids method. More...
void	ResetNumber_of_taxids (void)
	Reset Number_of_taxids data member. More...
TNumber_of_taxids	GetNumber_of_taxids (void) const
	Get the Number_of_taxids member data. More...
void	SetNumber_of_taxids (TNumber_of_taxids value)
	Assign a value to Number_of_taxids data member. More...
TNumber_of_taxids &	SetNumber_of_taxids (void)
	Assign a value to Number_of_taxids data member. More...
bool	IsSetBytes_total (void) const
	Check if a value has been assigned to Bytes_total data member. More...
bool	CanGetBytes_total (void) const
	Check if it is safe to call GetBytes_total method. More...
void	ResetBytes_total (void)
	Reset Bytes_total data member. More...
TBytes_total	GetBytes_total (void) const
	Get the Bytes_total member data. More...
void	SetBytes_total (TBytes_total value)
	Assign a value to Bytes_total data member. More...
TBytes_total &	SetBytes_total (void)
	Assign a value to Bytes_total data member. More...
bool	IsSetBytes_to_cache (void) const
	Check if a value has been assigned to Bytes_to_cache data member. More...
bool	CanGetBytes_to_cache (void) const
	Check if it is safe to call GetBytes_to_cache method. More...
void	ResetBytes_to_cache (void)
	Reset Bytes_to_cache data member. More...
TBytes_to_cache	GetBytes_to_cache (void) const
	Get the Bytes_to_cache member data. More...
void	SetBytes_to_cache (TBytes_to_cache value)
	Assign a value to Bytes_to_cache data member. More...
TBytes_to_cache &	SetBytes_to_cache (void)
	Assign a value to Bytes_to_cache data member. More...
bool	IsSetBytes_total_compressed (void) const
	Check if a value has been assigned to Bytes_total_compressed data member. More...
bool	CanGetBytes_total_compressed (void) const
	Check if it is safe to call GetBytes_total_compressed method. More...
void	ResetBytes_total_compressed (void)
	Reset Bytes_total_compressed data member. More...
TBytes_total_compressed	GetBytes_total_compressed (void) const
	Get the Bytes_total_compressed member data. More...
void	SetBytes_total_compressed (TBytes_total_compressed value)
	Assign a value to Bytes_total_compressed data member. More...
TBytes_total_compressed &	SetBytes_total_compressed (void)
	Assign a value to Bytes_total_compressed data member. More...
bool	IsSetFiles (void) const
	Check if a value has been assigned to Files data member. More...
bool	CanGetFiles (void) const
	Check if it is safe to call GetFiles method. More...
void	ResetFiles (void)
	Reset Files data member. More...
const TFiles &	GetFiles (void) const
	Get the Files member data. More...
TFiles &	SetFiles (void)
	Assign a value to Files data member. More...
bool	IsSetCompressed_files (void) const
	Check if a value has been assigned to Compressed_files data member. More...
bool	CanGetCompressed_files (void) const
	Check if it is safe to call GetCompressed_files method. More...
void	ResetCompressed_files (void)
	Reset Compressed_files data member. More...
const TCompressed_files &	GetCompressed_files (void) const
	Get the Compressed_files member data. More...
TCompressed_files &	SetCompressed_files (void)
	Assign a value to Compressed_files 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 CBlast_db_metadata_Base	Tparent

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

Additional Inherited Members
Public Types inherited from CBlast_db_metadata_Base
enum class	E_memberIndex {   e__allMandatory = 0 , e_version , e_dbname , e_dbtype ,   e_db_version , e_description , e_number_of_letters , e_number_of_sequences ,   e_last_updated , e_number_of_volumes , e_number_of_taxids , e_bytes_total ,   e_bytes_to_cache , e_bytes_total_compressed , e_files , e_compressed_files }
typedef string	TVersion
typedef string	TDbname
typedef string	TDbtype
typedef int	TDb_version
typedef string	TDescription
typedef Uint8	TNumber_of_letters
typedef Int8	TNumber_of_sequences
typedef string	TLast_updated
typedef int	TNumber_of_volumes
typedef int	TNumber_of_taxids
typedef Uint8	TBytes_total
typedef Uint8	TBytes_to_cache
typedef Uint8	TBytes_total_compressed
typedef vector< string >	TFiles
typedef vector< string >	TCompressed_files
typedef Tparent::CMemberIndex< E_memberIndex, 16 >	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

CBlast_db_metadata –.

Definition at line 65 of file Blast_db_metadata.hpp.

---

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

• include/objects/blastdb/Blast_db_metadata.hpp
• src/objects/blastdb/Blast_db_metadata.cpp