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

Search Toolkit Book for CMSLibrarySettings_Base

Library search settings. More...

#include <objects/omssa/MSLibrarySettings_.hpp>

+ Inheritance diagram for CMSLibrarySettings_Base:
+ Collaboration diagram for CMSLibrarySettings_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_libnames , e_presearch , e_useomssascore ,
  e_usereplicatescore , e_qtofscore
}
 
typedef list< stringTLibnames
 
typedef bool TPresearch
 
typedef bool TUseomssascore
 
typedef bool TUsereplicatescore
 
typedef bool TQtofscore
 
typedef Tparent::CMemberIndex< E_memberIndex, 6 > 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...
 

Public Member Functions

 CMSLibrarySettings_Base (void)
 
virtual ~CMSLibrarySettings_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetLibnames (void) const
 names of search libraries Check if a value has been assigned to Libnames data member. More...
 
bool CanGetLibnames (void) const
 Check if it is safe to call GetLibnames method. More...
 
void ResetLibnames (void)
 Reset Libnames data member. More...
 
const TLibnamesGetLibnames (void) const
 Get the Libnames member data. More...
 
TLibnamesSetLibnames (void)
 Assign a value to Libnames data member. More...
 
bool IsSetPresearch (void) const
 should there be a restriction on precursor mass? Check if a value has been assigned to Presearch data member. More...
 
bool CanGetPresearch (void) const
 Check if it is safe to call GetPresearch method. More...
 
void ResetPresearch (void)
 Reset Presearch data member. More...
 
TPresearch GetPresearch (void) const
 Get the Presearch member data. More...
 
void SetPresearch (TPresearch value)
 Assign a value to Presearch data member. More...
 
TPresearchSetPresearch (void)
 Assign a value to Presearch data member. More...
 
bool IsSetUseomssascore (void) const
 use the omssa score? Check if a value has been assigned to Useomssascore data member. More...
 
bool CanGetUseomssascore (void) const
 Check if it is safe to call GetUseomssascore method. More...
 
void ResetUseomssascore (void)
 Reset Useomssascore data member. More...
 
TUseomssascore GetUseomssascore (void) const
 Get the Useomssascore member data. More...
 
void SetUseomssascore (TUseomssascore value)
 Assign a value to Useomssascore data member. More...
 
TUseomssascoreSetUseomssascore (void)
 Assign a value to Useomssascore data member. More...
 
bool IsSetUsereplicatescore (void) const
 use the number of replicates score? Check if a value has been assigned to Usereplicatescore data member. More...
 
bool CanGetUsereplicatescore (void) const
 Check if it is safe to call GetUsereplicatescore method. More...
 
void ResetUsereplicatescore (void)
 Reset Usereplicatescore data member. More...
 
TUsereplicatescore GetUsereplicatescore (void) const
 Get the Usereplicatescore member data. More...
 
void SetUsereplicatescore (TUsereplicatescore value)
 Assign a value to Usereplicatescore data member. More...
 
TUsereplicatescoreSetUsereplicatescore (void)
 Assign a value to Usereplicatescore data member. More...
 
bool IsSetQtofscore (void) const
 use the qtof score? Check if a value has been assigned to Qtofscore data member. More...
 
bool CanGetQtofscore (void) const
 Check if it is safe to call GetQtofscore method. More...
 
void ResetQtofscore (void)
 Reset Qtofscore data member. More...
 
TQtofscore GetQtofscore (void) const
 Get the Qtofscore member data. More...
 
void SetQtofscore (TQtofscore value)
 Assign a value to Qtofscore data member. More...
 
TQtofscoreSetQtofscore (void)
 Assign a value to Qtofscore 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 CSerialObject Tparent
 

Private Member Functions

 CMSLibrarySettings_Base (const CMSLibrarySettings_Base &)
 
CMSLibrarySettings_Baseoperator= (const CMSLibrarySettings_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
list< stringm_Libnames
 
bool m_Presearch
 
bool m_Useomssascore
 
bool m_Usereplicatescore
 
bool m_Qtofscore
 

Additional Inherited Members

- 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

Library search settings.

CMSLibrarySettings_Base

Definition at line 74 of file MSLibrarySettings_.hpp.


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