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

Represents ASN.1 type Statistics defined in file blastxml.asn

Search Toolkit Book for CStatistics

CStatistics –. More...

#include <objects/blastxml/Statistics.hpp>

+ Inheritance diagram for CStatistics:
+ Collaboration diagram for CStatistics:

Public Member Functions

 CStatistics (void)
 
 ~CStatistics (void)
 
 CStatistics (void)
 
 ~CStatistics (void)
 
- Public Member Functions inherited from CStatistics_Base
 CStatistics_Base (void)
 
virtual ~CStatistics_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetDb_num (void) const
 Number of sequences in BLAST db Check if a value has been assigned to Db_num data member. More...
 
bool CanGetDb_num (void) const
 Check if it is safe to call GetDb_num method. More...
 
void ResetDb_num (void)
 Reset Db_num data member. More...
 
TDb_num GetDb_num (void) const
 Get the Db_num member data. More...
 
void SetDb_num (TDb_num value)
 Assign a value to Db_num data member. More...
 
TDb_numSetDb_num (void)
 Assign a value to Db_num data member. More...
 
bool IsSetDb_len (void) const
 Length of BLAST db Check if a value has been assigned to Db_len data member. More...
 
bool CanGetDb_len (void) const
 Check if it is safe to call GetDb_len method. More...
 
void ResetDb_len (void)
 Reset Db_len data member. More...
 
TDb_len GetDb_len (void) const
 Get the Db_len member data. More...
 
void SetDb_len (TDb_len value)
 Assign a value to Db_len data member. More...
 
TDb_lenSetDb_len (void)
 Assign a value to Db_len data member. More...
 
bool IsSetHsp_len (void) const
 Effective HSP length Check if a value has been assigned to Hsp_len data member. More...
 
bool CanGetHsp_len (void) const
 Check if it is safe to call GetHsp_len method. More...
 
void ResetHsp_len (void)
 Reset Hsp_len data member. More...
 
THsp_len GetHsp_len (void) const
 Get the Hsp_len member data. More...
 
void SetHsp_len (THsp_len value)
 Assign a value to Hsp_len data member. More...
 
THsp_lenSetHsp_len (void)
 Assign a value to Hsp_len data member. More...
 
bool IsSetEff_space (void) const
 Effective search space Check if a value has been assigned to Eff_space data member. More...
 
bool CanGetEff_space (void) const
 Check if it is safe to call GetEff_space method. More...
 
void ResetEff_space (void)
 Reset Eff_space data member. More...
 
TEff_space GetEff_space (void) const
 Get the Eff_space member data. More...
 
void SetEff_space (TEff_space value)
 Assign a value to Eff_space data member. More...
 
TEff_spaceSetEff_space (void)
 Assign a value to Eff_space data member. More...
 
bool IsSetKappa (void) const
 Karlin-Altschul parameter K Check if a value has been assigned to Kappa data member. More...
 
bool CanGetKappa (void) const
 Check if it is safe to call GetKappa method. More...
 
void ResetKappa (void)
 Reset Kappa data member. More...
 
TKappa GetKappa (void) const
 Get the Kappa member data. More...
 
void SetKappa (TKappa value)
 Assign a value to Kappa data member. More...
 
TKappaSetKappa (void)
 Assign a value to Kappa data member. More...
 
bool IsSetLambda (void) const
 Karlin-Altschul parameter Lambda Check if a value has been assigned to Lambda data member. More...
 
bool CanGetLambda (void) const
 Check if it is safe to call GetLambda method. More...
 
void ResetLambda (void)
 Reset Lambda data member. More...
 
TLambda GetLambda (void) const
 Get the Lambda member data. More...
 
void SetLambda (TLambda value)
 Assign a value to Lambda data member. More...
 
TLambdaSetLambda (void)
 Assign a value to Lambda data member. More...
 
bool IsSetEntropy (void) const
 Karlin-Altschul parameter H Check if a value has been assigned to Entropy data member. More...
 
bool CanGetEntropy (void) const
 Check if it is safe to call GetEntropy method. More...
 
void ResetEntropy (void)
 Reset Entropy data member. More...
 
TEntropy GetEntropy (void) const
 Get the Entropy member data. More...
 
void SetEntropy (TEntropy value)
 Assign a value to Entropy data member. More...
 
TEntropySetEntropy (void)
 Assign a value to Entropy data member. More...
 
virtual void Reset (void)
 Reset the whole object. More...
 
 CStatistics_Base (void)
 
virtual ~CStatistics_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetDb_num (void) const
 Number of sequences in BLAST db Check if a value has been assigned to Db_num data member. More...
 
bool CanGetDb_num (void) const
 Check if it is safe to call GetDb_num method. More...
 
void ResetDb_num (void)
 Reset Db_num data member. More...
 
TDb_num GetDb_num (void) const
 Get the Db_num member data. More...
 
void SetDb_num (TDb_num value)
 Assign a value to Db_num data member. More...
 
TDb_numSetDb_num (void)
 Assign a value to Db_num data member. More...
 
bool IsSetDb_len (void) const
 Length of BLAST db Check if a value has been assigned to Db_len data member. More...
 
bool CanGetDb_len (void) const
 Check if it is safe to call GetDb_len method. More...
 
void ResetDb_len (void)
 Reset Db_len data member. More...
 
TDb_len GetDb_len (void) const
 Get the Db_len member data. More...
 
void SetDb_len (TDb_len value)
 Assign a value to Db_len data member. More...
 
TDb_lenSetDb_len (void)
 Assign a value to Db_len data member. More...
 
bool IsSetHsp_len (void) const
 Effective HSP length Check if a value has been assigned to Hsp_len data member. More...
 
bool CanGetHsp_len (void) const
 Check if it is safe to call GetHsp_len method. More...
 
void ResetHsp_len (void)
 Reset Hsp_len data member. More...
 
THsp_len GetHsp_len (void) const
 Get the Hsp_len member data. More...
 
void SetHsp_len (THsp_len value)
 Assign a value to Hsp_len data member. More...
 
THsp_lenSetHsp_len (void)
 Assign a value to Hsp_len data member. More...
 
bool IsSetEff_space (void) const
 Effective search space Check if a value has been assigned to Eff_space data member. More...
 
bool CanGetEff_space (void) const
 Check if it is safe to call GetEff_space method. More...
 
void ResetEff_space (void)
 Reset Eff_space data member. More...
 
TEff_space GetEff_space (void) const
 Get the Eff_space member data. More...
 
void SetEff_space (TEff_space value)
 Assign a value to Eff_space data member. More...
 
TEff_spaceSetEff_space (void)
 Assign a value to Eff_space data member. More...
 
bool IsSetKappa (void) const
 Karlin-Altschul parameter K Check if a value has been assigned to Kappa data member. More...
 
bool CanGetKappa (void) const
 Check if it is safe to call GetKappa method. More...
 
void ResetKappa (void)
 Reset Kappa data member. More...
 
TKappa GetKappa (void) const
 Get the Kappa member data. More...
 
void SetKappa (TKappa value)
 Assign a value to Kappa data member. More...
 
TKappaSetKappa (void)
 Assign a value to Kappa data member. More...
 
bool IsSetLambda (void) const
 Karlin-Altschul parameter Lambda Check if a value has been assigned to Lambda data member. More...
 
bool CanGetLambda (void) const
 Check if it is safe to call GetLambda method. More...
 
void ResetLambda (void)
 Reset Lambda data member. More...
 
TLambda GetLambda (void) const
 Get the Lambda member data. More...
 
void SetLambda (TLambda value)
 Assign a value to Lambda data member. More...
 
TLambdaSetLambda (void)
 Assign a value to Lambda data member. More...
 
bool IsSetEntropy (void) const
 Karlin-Altschul parameter H Check if a value has been assigned to Entropy data member. More...
 
bool CanGetEntropy (void) const
 Check if it is safe to call GetEntropy method. More...
 
void ResetEntropy (void)
 Reset Entropy data member. More...
 
TEntropy GetEntropy (void) const
 Get the Entropy member data. More...
 
void SetEntropy (TEntropy value)
 Assign a value to Entropy data member. More...
 
TEntropySetEntropy (void)
 Assign a value to Entropy 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 CStatistics_Base Tparent
 
typedef CStatistics_Base Tparent
 

Private Member Functions

 CStatistics (const CStatistics &value)
 
CStatisticsoperator= (const CStatistics &value)
 
 CStatistics (const CStatistics &value)
 
CStatisticsoperator= (const CStatistics &value)
 

Additional Inherited Members

- Public Types inherited from CStatistics_Base
enum class  E_memberIndex {
  e__allMandatory = 0 , e_db_num , e_db_len , e_hsp_len ,
  e_eff_space , e_kappa , e_lambda , e_entropy ,
  e__allMandatory = 0 , e_db_num , e_db_len , e_hsp_len ,
  e_eff_space , e_kappa , e_lambda , e_entropy
}
 
enum class  E_memberIndex {
  e__allMandatory = 0 , e_db_num , e_db_len , e_hsp_len ,
  e_eff_space , e_kappa , e_lambda , e_entropy ,
  e__allMandatory = 0 , e_db_num , e_db_len , e_hsp_len ,
  e_eff_space , e_kappa , e_lambda , e_entropy
}
 
typedef int TDb_num
 
typedef Int8 TDb_len
 
typedef int THsp_len
 
typedef double TEff_space
 
typedef double TKappa
 
typedef double TLambda
 
typedef double TEntropy
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > TmemberIndex
 
typedef Int8 TDb_num
 
typedef Int8 TDb_len
 
typedef int THsp_len
 
typedef Int8 TEff_space
 
typedef double TKappa
 
typedef double TLambda
 
typedef double TEntropy
 
typedef Tparent::CMemberIndex< E_memberIndex, 8 > 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

CStatistics –.

Definition at line 65 of file Statistics.hpp.


The documentation for this class was generated from the following files:
Modified on Mon May 13 04:33:35 2024 by modify_doxy.py rev. 669887