Search Toolkit Book for CBlast4_request_body

#include <objects/blast/Blast4_request_body.hpp>

Inheritance diagram for CBlast4_request_body:

Collaboration diagram for CBlast4_request_body:

Public Member Functions
	CBlast4_request_body (void)

	~CBlast4_request_body (void)

Public Member Functions inherited from CBlast4_request_body_Base
	CBlast4_request_body_Base (void)

virtual	~CBlast4_request_body_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	IsFinish_params (void) const
	Check if variant Finish_params is selected. More...

const TFinish_params &	GetFinish_params (void) const
	Get the variant data. More...

TFinish_params &	SetFinish_params (void)
	Select the variant. More...

void	SetFinish_params (TFinish_params &value)
	Select the variant and set its data. More...

bool	IsGet_databases (void) const
	Check if variant Get_databases is selected. More...

void	SetGet_databases (void)
	Select the variant. More...

bool	IsGet_matrices (void) const
	Check if variant Get_matrices is selected. More...

void	SetGet_matrices (void)
	Select the variant. More...

bool	IsGet_parameters (void) const
	Check if variant Get_parameters is selected. More...

void	SetGet_parameters (void)
	Select the variant. More...

bool	IsGet_paramsets (void) const
	Check if variant Get_paramsets is selected. More...

void	SetGet_paramsets (void)
	Select the variant. More...

bool	IsGet_programs (void) const
	Check if variant Get_programs is selected. More...

void	SetGet_programs (void)
	Select the variant. More...

bool	IsGet_search_results (void) const
	Check if variant Get_search_results is selected. More...

const TGet_search_results &	GetGet_search_results (void) const
	Get the variant data. More...

TGet_search_results &	SetGet_search_results (void)
	Select the variant. More...

void	SetGet_search_results (TGet_search_results &value)
	Select the variant and set its data. More...

bool	IsGet_sequences (void) const
	Check if variant Get_sequences is selected. More...

const TGet_sequences &	GetGet_sequences (void) const
	Get the variant data. More...

TGet_sequences &	SetGet_sequences (void)
	Select the variant. More...

void	SetGet_sequences (TGet_sequences &value)
	Select the variant and set its data. More...

bool	IsQueue_search (void) const
	Check if variant Queue_search is selected. More...

const TQueue_search &	GetQueue_search (void) const
	Get the variant data. More...

TQueue_search &	SetQueue_search (void)
	Select the variant. More...

void	SetQueue_search (TQueue_search &value)
	Select the variant and set its data. More...

bool	IsGet_request_info (void) const
	Check if variant Get_request_info is selected. More...

const TGet_request_info &	GetGet_request_info (void) const
	Get the variant data. More...

TGet_request_info &	SetGet_request_info (void)
	Select the variant. More...

void	SetGet_request_info (TGet_request_info &value)
	Select the variant and set its data. More...

bool	IsGet_sequence_parts (void) const
	Check if variant Get_sequence_parts is selected. More...

const TGet_sequence_parts &	GetGet_sequence_parts (void) const
	Get the variant data. More...

TGet_sequence_parts &	SetGet_sequence_parts (void)
	Select the variant. More...

void	SetGet_sequence_parts (TGet_sequence_parts &value)
	Select the variant and set its data. More...

bool	IsGet_windowmasked_taxids (void) const
	Check if variant Get_windowmasked_taxids is selected. More...

void	SetGet_windowmasked_taxids (void)
	Select the variant. More...

bool	IsGet_protocol_info (void) const
	Check if variant Get_protocol_info is selected. More...

const TGet_protocol_info &	GetGet_protocol_info (void) const
	Get the variant data. More...

TGet_protocol_info &	SetGet_protocol_info (void)
	Select the variant. More...

void	SetGet_protocol_info (TGet_protocol_info &value)
	Select the variant and set its data. More...

bool	IsGet_search_info (void) const
	Check if variant Get_search_info is selected. More...

const TGet_search_info &	GetGet_search_info (void) const
	Get the variant data. More...

TGet_search_info &	SetGet_search_info (void)
	Select the variant. More...

void	SetGet_search_info (TGet_search_info &value)
	Select the variant and set its data. More...

bool	IsGet_databases_ex (void) const
	Check if variant Get_databases_ex is selected. More...

const TGet_databases_ex &	GetGet_databases_ex (void) const
	Get the variant data. More...

TGet_databases_ex &	SetGet_databases_ex (void)
	Select the variant. More...

void	SetGet_databases_ex (TGet_databases_ex &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

Private Types
typedef CBlast4_request_body_Base	Tparent

Private Member Functions
	CBlast4_request_body (const CBlast4_request_body &value)

CBlast4_request_body &	operator= (const CBlast4_request_body &value)

Additional Inherited Members
Public Types inherited from CBlast4_request_body_Base
enum	E_Choice { e_not_set = 0 , e_Finish_params , e_Get_databases , e_Get_matrices , e_Get_parameters , e_Get_paramsets , e_Get_programs , e_Get_search_results , e_Get_sequences , e_Queue_search , e_Get_request_info , e_Get_sequence_parts , e_Get_windowmasked_taxids , e_Get_protocol_info , e_Get_search_info , e_Get_databases_ex }
	Choice variants. More...

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

typedef CBlast4_finish_params_request	TFinish_params

typedef CBlast4_get_search_results_request	TGet_search_results

typedef CBlast4_get_sequences_request	TGet_sequences

typedef CBlast4_queue_search_request	TQueue_search

typedef CBlast4_get_request_info_request	TGet_request_info

typedef CBlast4_get_seq_parts_request	TGet_sequence_parts

typedef CBlast4_get_protocol_info_request	TGet_protocol_info

typedef CBlast4_get_search_info_request	TGet_search_info

typedef CBlast4_get_databases_ex_request	TGet_databases_ex

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 CBlast4_request_body_Base
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)

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

CBlast4_request_body –.

Definition at line 65 of file Blast4_request_body.hpp.

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

include/objects/blast/Blast4_request_body.hpp
src/objects/blast/Blast4_request_body.cpp

Public Member Functions

Private Types

Private Member Functions

Additional Inherited Members

Detailed Description