Search Toolkit Book for CSearch_database_Base::C_Attlist

#include <algo/ms/formats/pepxml/Search_database_.hpp>

Inheritance diagram for CSearch_database_Base::C_Attlist:

Collaboration diagram for CSearch_database_Base::C_Attlist:

Public Types
enum	EAttlist_type { eAttlist_type_AA = 1 , eAttlist_type_NA = 2 }

enum class	E_memberIndex { e__allMandatory = 0 , e_local_path , e_URL , e_database_name , e_orig_database_url , e_database_release_date , e_database_release_identifier , e_size_in_db_entries , e_size_of_residues , e_type }

typedef string	TLocal_path

typedef string	TURL

typedef string	TDatabase_name

typedef string	TOrig_database_url

typedef string	TDatabase_release_date

typedef string	TDatabase_release_identifier

typedef int	TSize_in_db_entries

typedef int	TSize_of_residues

typedef EAttlist_type	TType

typedef Tparent::CMemberIndex< E_memberIndex, 10 >	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
	C_Attlist (void)

	~C_Attlist (void)

	DECLARE_INTERNAL_TYPE_INFO ()

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

bool	CanGetLocal_path (void) const
	Check if it is safe to call GetLocal_path method. More...

void	ResetLocal_path (void)
	Reset Local_path data member. More...

const TLocal_path &	GetLocal_path (void) const
	Get the Local_path member data. More...

void	SetLocal_path (const TLocal_path &value)
	Assign a value to Local_path data member. More...

void	SetLocal_path (TLocal_path &&value)

TLocal_path &	SetLocal_path (void)
	Assign a value to Local_path data member. More...

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

bool	CanGetURL (void) const
	Check if it is safe to call GetURL method. More...

void	ResetURL (void)
	Reset URL data member. More...

const TURL &	GetURL (void) const
	Get the URL member data. More...

void	SetURL (const TURL &value)
	Assign a value to URL data member. More...

void	SetURL (TURL &&value)

TURL &	SetURL (void)
	Assign a value to URL data member. More...

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

bool	CanGetDatabase_name (void) const
	Check if it is safe to call GetDatabase_name method. More...

void	ResetDatabase_name (void)
	Reset Database_name data member. More...

const TDatabase_name &	GetDatabase_name (void) const
	Get the Database_name member data. More...

void	SetDatabase_name (const TDatabase_name &value)
	Assign a value to Database_name data member. More...

void	SetDatabase_name (TDatabase_name &&value)

TDatabase_name &	SetDatabase_name (void)
	Assign a value to Database_name data member. More...

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

bool	CanGetOrig_database_url (void) const
	Check if it is safe to call GetOrig_database_url method. More...

void	ResetOrig_database_url (void)
	Reset Orig_database_url data member. More...

const TOrig_database_url &	GetOrig_database_url (void) const
	Get the Orig_database_url member data. More...

void	SetOrig_database_url (const TOrig_database_url &value)
	Assign a value to Orig_database_url data member. More...

void	SetOrig_database_url (TOrig_database_url &&value)

TOrig_database_url &	SetOrig_database_url (void)
	Assign a value to Orig_database_url data member. More...

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

bool	CanGetDatabase_release_date (void) const
	Check if it is safe to call GetDatabase_release_date method. More...

void	ResetDatabase_release_date (void)
	Reset Database_release_date data member. More...

const TDatabase_release_date &	GetDatabase_release_date (void) const
	Get the Database_release_date member data. More...

void	SetDatabase_release_date (const TDatabase_release_date &value)
	Assign a value to Database_release_date data member. More...

void	SetDatabase_release_date (TDatabase_release_date &&value)

TDatabase_release_date &	SetDatabase_release_date (void)
	Assign a value to Database_release_date data member. More...

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

bool	CanGetDatabase_release_identifier (void) const
	Check if it is safe to call GetDatabase_release_identifier method. More...

void	ResetDatabase_release_identifier (void)
	Reset Database_release_identifier data member. More...

const TDatabase_release_identifier &	GetDatabase_release_identifier (void) const
	Get the Database_release_identifier member data. More...

void	SetDatabase_release_identifier (const TDatabase_release_identifier &value)
	Assign a value to Database_release_identifier data member. More...

void	SetDatabase_release_identifier (TDatabase_release_identifier &&value)

TDatabase_release_identifier &	SetDatabase_release_identifier (void)
	Assign a value to Database_release_identifier data member. More...

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

bool	CanGetSize_in_db_entries (void) const
	Check if it is safe to call GetSize_in_db_entries method. More...

void	ResetSize_in_db_entries (void)
	Reset Size_in_db_entries data member. More...

TSize_in_db_entries	GetSize_in_db_entries (void) const
	Get the Size_in_db_entries member data. More...

void	SetSize_in_db_entries (TSize_in_db_entries value)
	Assign a value to Size_in_db_entries data member. More...

TSize_in_db_entries &	SetSize_in_db_entries (void)
	Assign a value to Size_in_db_entries data member. More...

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

bool	CanGetSize_of_residues (void) const
	Check if it is safe to call GetSize_of_residues method. More...

void	ResetSize_of_residues (void)
	Reset Size_of_residues data member. More...

TSize_of_residues	GetSize_of_residues (void) const
	Get the Size_of_residues member data. More...

void	SetSize_of_residues (TSize_of_residues value)
	Assign a value to Size_of_residues data member. More...

TSize_of_residues &	SetSize_of_residues (void)
	Assign a value to Size_of_residues data member. More...

bool	IsSetType (void) const
	Database type (AA=amino acid, NA=nucleic acid) 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...

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

Static Public Member Functions
static const NCBI_NS_NCBI::CEnumeratedTypeValues *ENUM_METHOD_NAME()	EAttlist_type (void)
	Access to EAttlist_type'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)

Private Types
typedef CSerialObject	Tparent

Private Member Functions
	C_Attlist (const C_Attlist &)

C_Attlist &	operator= (const C_Attlist &)

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

C_Attlist –.

Definition at line 89 of file Search_database_.hpp.

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

include/algo/ms/formats/pepxml/Search_database_.hpp
src/algo/ms/formats/pepxml/Search_database_.cpp

Private Attributes
Uint4	m_set_State [1]

string	m_Local_path

string	m_URL

string	m_Database_name

string	m_Orig_database_url

string	m_Database_release_date

string	m_Database_release_identifier

int	m_Size_in_db_entries

int	m_Size_of_residues

EAttlist_type	m_Type

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description