Search Toolkit Book for CMSHitSet
#include <objects/omssa/MSHitSet.hpp>
Inheritance diagram for CMSHitSet:
Collaboration diagram for CMSHitSet:
Public Member Functions | |
| CMSHitSet (void) | |
| ~CMSHitSet (void) | |
| Public Member Functions inherited from CMSHitSet_Base | |
| CMSHitSet_Base (void) | |
| virtual | ~CMSHitSet_Base (void) |
| DECLARE_INTERNAL_TYPE_INFO () | |
| bool | IsSetNumber (void) const |
| unique number of spectrum Check if a value has been assigned to Number data member. More... | |
| bool | CanGetNumber (void) const |
| Check if it is safe to call GetNumber method. More... | |
| void | ResetNumber (void) |
| Reset Number data member. More... | |
| TNumber | GetNumber (void) const |
| Get the Number member data. More... | |
| void | SetNumber (TNumber value) |
| Assign a value to Number data member. More... | |
| TNumber & | SetNumber (void) |
| Assign a value to Number data member. More... | |
| bool | IsSetError (void) const |
| error, if any Check if a value has been assigned to Error data member. More... | |
| bool | CanGetError (void) const |
| Check if it is safe to call GetError method. More... | |
| void | ResetError (void) |
| Reset Error data member. More... | |
| TError | GetError (void) const |
| Get the Error member data. More... | |
| void | SetError (TError value) |
| Assign a value to Error data member. More... | |
| TError & | SetError (void) |
| Assign a value to Error data member. More... | |
| bool | IsSetHits (void) const |
| set of hit to spectrum Check if a value has been assigned to Hits data member. More... | |
| bool | CanGetHits (void) const |
| Check if it is safe to call GetHits method. More... | |
| void | ResetHits (void) |
| Reset Hits data member. More... | |
| const THits & | GetHits (void) const |
| Get the Hits member data. More... | |
| THits & | SetHits (void) |
| Assign a value to Hits data member. More... | |
| bool | IsSetIds (void) const |
| filenames or other ids of spectra searched Check if a value has been assigned to Ids data member. More... | |
| bool | CanGetIds (void) const |
| Check if it is safe to call GetIds method. More... | |
| void | ResetIds (void) |
| Reset Ids data member. More... | |
| const TIds & | GetIds (void) const |
| Get the Ids member data. More... | |
| TIds & | SetIds (void) |
| Assign a value to Ids data member. More... | |
| bool | IsSetNamevalue (void) const |
| extra info: retention times, etc. More... | |
| bool | CanGetNamevalue (void) const |
| Check if it is safe to call GetNamevalue method. More... | |
| void | ResetNamevalue (void) |
| Reset Namevalue data member. More... | |
| const TNamevalue & | GetNamevalue (void) const |
| Get the Namevalue member data. More... | |
| TNamevalue & | SetNamevalue (void) |
| Assign a value to Namevalue data member. More... | |
| bool | IsSetSettingid (void) const |
| id of the search setting used Check if a value has been assigned to Settingid data member. More... | |
| bool | CanGetSettingid (void) const |
| Check if it is safe to call GetSettingid method. More... | |
| void | ResetSettingid (void) |
| Reset Settingid data member. More... | |
| TSettingid | GetSettingid (void) const |
| Get the Settingid member data. More... | |
| void | SetSettingid (TSettingid value) |
| Assign a value to Settingid data member. More... | |
| TSettingid & | SetSettingid (void) |
| Assign a value to Settingid data member. More... | |
| bool | IsSetUserannotation (void) const |
| allows users to flag certain Check if a value has been assigned to Userannotation data member. More... | |
| bool | CanGetUserannotation (void) const |
| Check if it is safe to call GetUserannotation method. More... | |
| void | ResetUserannotation (void) |
| Reset Userannotation data member. More... | |
| TUserannotation | GetUserannotation (void) const |
| Get the Userannotation member data. More... | |
| void | SetUserannotation (TUserannotation value) |
| Assign a value to Userannotation data member. More... | |
| TUserannotation & | SetUserannotation (void) |
| Assign a value to Userannotation 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 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 CMSHitSet_Base | Tparent |
Private Member Functions | |
| CMSHitSet (const CMSHitSet &value) | |
| CMSHitSet & | operator= (const CMSHitSet &value) |
Additional Inherited Members | |
| Public Types inherited from CMSHitSet_Base | |
| enum class | E_memberIndex { e__allMandatory = 0 , e_number , e_error , e_hits , e_ids , e_namevalue , e_settingid , e_userannotation } |
| typedef int | TNumber |
| typedef int | TError |
| typedef vector< CRef< CMSHits > > | THits |
| typedef list< string > | TIds |
| typedef list< CRef< CNameValue > > | TNamevalue |
| typedef int | TSettingid |
| typedef int | TUserannotation |
| 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< Uint8 > | TCounter |
| 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
CMSHitSet –.
Definition at line 65 of file MSHitSet.hpp.
The documentation for this class was generated from the following files:
- include/objects/omssa/MSHitSet.hpp
- src/objects/omssa/MSHitSet.cpp
