NCBI C++ ToolKit
Public Member Functions | Private Types | Private Member Functions | List of all members

Search Toolkit Book for CBlast4_archive

CBlast4_archive –. More...

#include <objects/blast/Blast4_archive.hpp>

+ Inheritance diagram for CBlast4_archive:
+ Collaboration diagram for CBlast4_archive:

Public Member Functions

 CBlast4_archive (void)
 
 ~CBlast4_archive (void)
 
- Public Member Functions inherited from CBlast4_archive_Base
 CBlast4_archive_Base (void)
 
virtual ~CBlast4_archive_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetRequest (void) const
 Query and options Check if a value has been assigned to Request data member. More...
 
bool CanGetRequest (void) const
 Check if it is safe to call GetRequest method. More...
 
void ResetRequest (void)
 Reset Request data member. More...
 
const TRequestGetRequest (void) const
 Get the Request member data. More...
 
void SetRequest (TRequest &value)
 Assign a value to Request data member. More...
 
TRequestSetRequest (void)
 Assign a value to Request data member. More...
 
bool IsSetResults (void) const
 Results of search Check if a value has been assigned to Results data member. More...
 
bool CanGetResults (void) const
 Check if it is safe to call GetResults method. More...
 
void ResetResults (void)
 Reset Results data member. More...
 
const TResultsGetResults (void) const
 Get the Results member data. More...
 
void SetResults (TResults &value)
 Assign a value to Results data member. More...
 
TResultsSetResults (void)
 Assign a value to Results data member. More...
 
bool IsSetMessages (void) const
 Check if a value has been assigned to Messages data member. More...
 
bool CanGetMessages (void) const
 Check if it is safe to call GetMessages method. More...
 
void ResetMessages (void)
 Reset Messages data member. More...
 
const TMessagesGetMessages (void) const
 Get the Messages member data. More...
 
TMessagesSetMessages (void)
 Assign a value to Messages 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 CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
CObjectoperator= (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_archive_Base Tparent
 

Private Member Functions

 CBlast4_archive (const CBlast4_archive &value)
 
CBlast4_archiveoperator= (const CBlast4_archive &value)
 

Additional Inherited Members

- Public Types inherited from CBlast4_archive_Base
enum class  E_memberIndex { e__allMandatory = 0 , e_request , e_results , e_messages }
 
typedef CBlast4_request TRequest
 
typedef CBlast4_get_search_results_reply TResults
 
typedef list< CRef< CBlast4_error > > TMessages
 
typedef Tparent::CMemberIndex< E_memberIndex, 4 > 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< Uint8TCounter
 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

CBlast4_archive –.

Definition at line 65 of file Blast4_archive.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:52 2024 by modify_doxy.py rev. 669887