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

Represents ASN.1 type MSMZHit defined in file omssa.asn

Search Toolkit Book for CMSMZHit_Base

defines a particular ion More...

#include <objects/omssa/MSMZHit_.hpp>

+ Inheritance diagram for CMSMZHit_Base:
+ Collaboration diagram for CMSMZHit_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_ion , e_charge , e_number ,
  e_mz , e_index , e_moreion , e_annotation
}
 
typedef int TIon
 
typedef int TCharge
 
typedef int TNumber
 
typedef int TMz
 
typedef int TIndex
 
typedef CMSIon TMoreion
 
typedef CMSIonAnnot TAnnotation
 
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...
 

Public Member Functions

 CMSMZHit_Base (void)
 
virtual ~CMSMZHit_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetIon (void) const
 ion type, e.g. More...
 
bool CanGetIon (void) const
 Check if it is safe to call GetIon method. More...
 
void ResetIon (void)
 Reset Ion data member. More...
 
TIon GetIon (void) const
 Get the Ion member data. More...
 
void SetIon (TIon value)
 Assign a value to Ion data member. More...
 
TIonSetIon (void)
 Assign a value to Ion data member. More...
 
bool IsSetCharge (void) const
 ion charge Check if a value has been assigned to Charge data member. More...
 
bool CanGetCharge (void) const
 Check if it is safe to call GetCharge method. More...
 
void ResetCharge (void)
 Reset Charge data member. More...
 
TCharge GetCharge (void) const
 Get the Charge member data. More...
 
void SetCharge (TCharge value)
 Assign a value to Charge data member. More...
 
TChargeSetCharge (void)
 Assign a value to Charge data member. More...
 
bool IsSetNumber (void) const
 the sequential number of the ion 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...
 
TNumberSetNumber (void)
 Assign a value to Number data member. More...
 
bool IsSetMz (void) const
 scaled m/z value in Da Check if a value has been assigned to Mz data member. More...
 
bool CanGetMz (void) const
 Check if it is safe to call GetMz method. More...
 
void ResetMz (void)
 Reset Mz data member. More...
 
TMz GetMz (void) const
 Get the Mz member data. More...
 
void SetMz (TMz value)
 Assign a value to Mz data member. More...
 
TMzSetMz (void)
 Assign a value to Mz data member. More...
 
bool IsSetIndex (void) const
 the index of the peak in the original spectrum Check if a value has been assigned to Index data member. More...
 
bool CanGetIndex (void) const
 Check if it is safe to call GetIndex method. More...
 
void ResetIndex (void)
 Reset Index data member. More...
 
TIndex GetIndex (void) const
 Get the Index member data. More...
 
void SetIndex (TIndex value)
 Assign a value to Index data member. More...
 
TIndexSetIndex (void)
 Assign a value to Index data member. More...
 
bool IsSetMoreion (void) const
 more information about the ion type Check if a value has been assigned to Moreion data member. More...
 
bool CanGetMoreion (void) const
 Check if it is safe to call GetMoreion method. More...
 
void ResetMoreion (void)
 Reset Moreion data member. More...
 
const TMoreionGetMoreion (void) const
 Get the Moreion member data. More...
 
void SetMoreion (TMoreion &value)
 Assign a value to Moreion data member. More...
 
TMoreionSetMoreion (void)
 Assign a value to Moreion data member. More...
 
bool IsSetAnnotation (void) const
 annotations on the ion Check if a value has been assigned to Annotation data member. More...
 
bool CanGetAnnotation (void) const
 Check if it is safe to call GetAnnotation method. More...
 
void ResetAnnotation (void)
 Reset Annotation data member. More...
 
const TAnnotationGetAnnotation (void) const
 Get the Annotation member data. More...
 
void SetAnnotation (TAnnotation &value)
 Assign a value to Annotation data member. More...
 
TAnnotationSetAnnotation (void)
 Assign a value to Annotation 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

 CMSMZHit_Base (const CMSMZHit_Base &)
 
CMSMZHit_Baseoperator= (const CMSMZHit_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
int m_Ion
 
int m_Charge
 
int m_Number
 
int m_Mz
 
int m_Index
 
CRef< TMoreionm_Moreion
 
CRef< TAnnotationm_Annotation
 

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

defines a particular ion

CMSMZHit_Base

Definition at line 78 of file MSMZHit_.hpp.


The documentation for this class was generated from the following files:
Modified on Tue May 28 05:52:52 2024 by modify_doxy.py rev. 669887