MSMZHit_.hpp

Go to the documentation of this file.

Go to the SVN repository for this file.

/* $Id$
 * ===========================================================================
 *
 *                            PUBLIC DOMAIN NOTICE
 *               National Center for Biotechnology Information
 *
 *  This software/database is a "United States Government Work" under the
 *  terms of the United States Copyright Act.  It was written as part of
 *  the author's official duties as a United States Government employee and
 *  thus cannot be copyrighted.  This software/database is freely available
 *  to the public for use. The National Library of Medicine and the U.S.
 *  Government have not placed any restriction on its use or reproduction.
 *
 *  Although all reasonable efforts have been taken to ensure the accuracy
 *  and reliability of the software and data, the NLM and the U.S.
 *  Government do not and cannot warrant the performance or results that
 *  may be obtained by using this software or data. The NLM and the U.S.
 *  Government disclaim all warranties, express or implied, including
 *  warranties of performance, merchantability or fitness for any particular
 *  purpose.
 *
 *  Please cite the author in any work or product based on this material.
 *
 * ===========================================================================
 *
 */
 
/// @file MSMZHit_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/omssa/omssa.asn">omssa.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/omssa/omssa.def">omssa.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_OMSSA_MSMZHIT_BASE_HPP
#define OBJECTS_OMSSA_MSMZHIT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <objects/omssa/MSIonType.hpp>
 
BEGIN_NCBI_SCOPE
 
#ifndef BEGIN_objects_SCOPE
#  define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
#  define END_objects_SCOPE END_SCOPE(objects)
#endif
BEGIN_objects_SCOPE // namespace ncbi::objects::
 
 
// forward declarations
class CMSIon;
class CMSIonAnnot;
 
 
// generated classes
 
 
/** @addtogroup dataspec_OMSSA
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// defines a particular ion
///
/// CMSMZHit_Base --
///
 
class NCBI_OMSSA_EXPORT CMSMZHit_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CMSMZHit_Base(void);
    // destructor
    virtual ~CMSMZHit_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TIon;
    typedef int TCharge;
    typedef int TNumber;
    typedef int TMz;
    typedef int TIndex;
    typedef CMSIon TMoreion;
    typedef CMSIonAnnot TAnnotation;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_ion,
        e_charge,
        e_number,
        e_mz,
        e_index,
        e_moreion,
        e_annotation
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 8> TmemberIndex;
 
    // getters
    // setters
 
    /// ion type, e.g. b
    /// Check if a value has been assigned to Ion data member.
    ///
    /// Data member Ion is mandatory;
    /// its type is defined as 'typedef int TIon'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIon(void) const;
 
    /// Check if it is safe to call GetIon method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIon(void) const;
 
    /// Reset Ion data member.
    void ResetIon(void);
 
    /// Get the Ion member data.
    ///
    /// @return
    ///   Copy of the member data.
    TIon GetIon(void) const;
 
    /// Assign a value to Ion data member.
    ///
    /// @param value
    ///   Value to assign
    void SetIon(TIon value);
 
    /// Assign a value to Ion data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIon& SetIon(void);
 
    /// ion charge
    /// Check if a value has been assigned to Charge data member.
    ///
    /// Data member Charge is mandatory;
    /// its type is defined as 'typedef int TCharge'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCharge(void) const;
 
    /// Check if it is safe to call GetCharge method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCharge(void) const;
 
    /// Reset Charge data member.
    void ResetCharge(void);
 
    /// Get the Charge member data.
    ///
    /// @return
    ///   Copy of the member data.
    TCharge GetCharge(void) const;
 
    /// Assign a value to Charge data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCharge(TCharge value);
 
    /// Assign a value to Charge data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCharge& SetCharge(void);
 
    /// the sequential number of the ion
    /// Check if a value has been assigned to Number data member.
    ///
    /// Data member Number is mandatory;
    /// its type is defined as 'typedef int TNumber'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNumber(void) const;
 
    /// Check if it is safe to call GetNumber method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNumber(void) const;
 
    /// Reset Number data member.
    void ResetNumber(void);
 
    /// Get the Number member data.
    ///
    /// @return
    ///   Copy of the member data.
    TNumber GetNumber(void) const;
 
    /// Assign a value to Number data member.
    ///
    /// @param value
    ///   Value to assign
    void SetNumber(TNumber value);
 
    /// Assign a value to Number data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNumber& SetNumber(void);
 
    /// scaled m/z value in Da
    /// Check if a value has been assigned to Mz data member.
    ///
    /// Data member Mz is mandatory;
    /// its type is defined as 'typedef int TMz'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMz(void) const;
 
    /// Check if it is safe to call GetMz method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMz(void) const;
 
    /// Reset Mz data member.
    void ResetMz(void);
 
    /// Get the Mz member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMz GetMz(void) const;
 
    /// Assign a value to Mz data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMz(TMz value);
 
    /// Assign a value to Mz data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMz& SetMz(void);
 
    /// the index of the peak in the original spectrum
    /// Check if a value has been assigned to Index data member.
    ///
    /// Data member Index is optional;
    /// its type is defined as 'typedef int TIndex'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIndex(void) const;
 
    /// Check if it is safe to call GetIndex method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIndex(void) const;
 
    /// Reset Index data member.
    void ResetIndex(void);
 
    /// Get the Index member data.
    ///
    /// @return
    ///   Copy of the member data.
    TIndex GetIndex(void) const;
 
    /// Assign a value to Index data member.
    ///
    /// @param value
    ///   Value to assign
    void SetIndex(TIndex value);
 
    /// Assign a value to Index data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIndex& SetIndex(void);
 
    /// more information about the ion type
    /// Check if a value has been assigned to Moreion data member.
    ///
    /// Data member Moreion is optional;
    /// its type is defined as 'typedef CMSIon TMoreion'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMoreion(void) const;
 
    /// Check if it is safe to call GetMoreion method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMoreion(void) const;
 
    /// Reset Moreion data member.
    void ResetMoreion(void);
 
    /// Get the Moreion member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMoreion& GetMoreion(void) const;
 
    /// Assign a value to Moreion data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetMoreion(TMoreion& value);
 
    /// Assign a value to Moreion data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMoreion& SetMoreion(void);
 
    /// annotations on the ion
    /// Check if a value has been assigned to Annotation data member.
    ///
    /// Data member Annotation is optional;
    /// its type is defined as 'typedef CMSIonAnnot TAnnotation'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAnnotation(void) const;
 
    /// Check if it is safe to call GetAnnotation method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAnnotation(void) const;
 
    /// Reset Annotation data member.
    void ResetAnnotation(void);
 
    /// Get the Annotation member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAnnotation& GetAnnotation(void) const;
 
    /// Assign a value to Annotation data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAnnotation(TAnnotation& value);
 
    /// Assign a value to Annotation data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAnnotation& SetAnnotation(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMSMZHit_Base(const CMSMZHit_Base&);
    CMSMZHit_Base& operator=(const CMSMZHit_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Ion;
    int m_Charge;
    int m_Number;
    int m_Mz;
    int m_Index;
    CRef< TMoreion > m_Moreion;
    CRef< TAnnotation > m_Annotation;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMSMZHit_Base::IsSetIon(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CMSMZHit_Base::CanGetIon(void) const
{
    return IsSetIon();
}
 
inline
void CMSMZHit_Base::ResetIon(void)
{
    m_Ion = (int)(0);
    m_set_State[0] &= ~0x3;
}
 
inline
CMSMZHit_Base::TIon CMSMZHit_Base::GetIon(void) const
{
    if (!CanGetIon()) {
        ThrowUnassigned(0);
    }
    return m_Ion;
}
 
inline
void CMSMZHit_Base::SetIon(CMSMZHit_Base::TIon value)
{
    m_Ion = value;
    m_set_State[0] |= 0x3;
}
 
inline
CMSMZHit_Base::TIon& CMSMZHit_Base::SetIon(void)
{
#ifdef _DEBUG
    if (!IsSetIon()) {
        memset(&m_Ion,UnassignedByte(),sizeof(m_Ion));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Ion;
}
 
inline
bool CMSMZHit_Base::IsSetCharge(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CMSMZHit_Base::CanGetCharge(void) const
{
    return IsSetCharge();
}
 
inline
void CMSMZHit_Base::ResetCharge(void)
{
    m_Charge = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CMSMZHit_Base::TCharge CMSMZHit_Base::GetCharge(void) const
{
    if (!CanGetCharge()) {
        ThrowUnassigned(1);
    }
    return m_Charge;
}
 
inline
void CMSMZHit_Base::SetCharge(CMSMZHit_Base::TCharge value)
{
    m_Charge = value;
    m_set_State[0] |= 0xc;
}
 
inline
CMSMZHit_Base::TCharge& CMSMZHit_Base::SetCharge(void)
{
#ifdef _DEBUG
    if (!IsSetCharge()) {
        memset(&m_Charge,UnassignedByte(),sizeof(m_Charge));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Charge;
}
 
inline
bool CMSMZHit_Base::IsSetNumber(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CMSMZHit_Base::CanGetNumber(void) const
{
    return IsSetNumber();
}
 
inline
void CMSMZHit_Base::ResetNumber(void)
{
    m_Number = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CMSMZHit_Base::TNumber CMSMZHit_Base::GetNumber(void) const
{
    if (!CanGetNumber()) {
        ThrowUnassigned(2);
    }
    return m_Number;
}
 
inline
void CMSMZHit_Base::SetNumber(CMSMZHit_Base::TNumber value)
{
    m_Number = value;
    m_set_State[0] |= 0x30;
}
 
inline
CMSMZHit_Base::TNumber& CMSMZHit_Base::SetNumber(void)
{
#ifdef _DEBUG
    if (!IsSetNumber()) {
        memset(&m_Number,UnassignedByte(),sizeof(m_Number));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Number;
}
 
inline
bool CMSMZHit_Base::IsSetMz(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CMSMZHit_Base::CanGetMz(void) const
{
    return IsSetMz();
}
 
inline
void CMSMZHit_Base::ResetMz(void)
{
    m_Mz = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CMSMZHit_Base::TMz CMSMZHit_Base::GetMz(void) const
{
    if (!CanGetMz()) {
        ThrowUnassigned(3);
    }
    return m_Mz;
}
 
inline
void CMSMZHit_Base::SetMz(CMSMZHit_Base::TMz value)
{
    m_Mz = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CMSMZHit_Base::TMz& CMSMZHit_Base::SetMz(void)
{
#ifdef _DEBUG
    if (!IsSetMz()) {
        memset(&m_Mz,UnassignedByte(),sizeof(m_Mz));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Mz;
}
 
inline
bool CMSMZHit_Base::IsSetIndex(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CMSMZHit_Base::CanGetIndex(void) const
{
    return IsSetIndex();
}
 
inline
void CMSMZHit_Base::ResetIndex(void)
{
    m_Index = 0;
    m_set_State[0] &= ~0x300;
}
 
inline
CMSMZHit_Base::TIndex CMSMZHit_Base::GetIndex(void) const
{
    if (!CanGetIndex()) {
        ThrowUnassigned(4);
    }
    return m_Index;
}
 
inline
void CMSMZHit_Base::SetIndex(CMSMZHit_Base::TIndex value)
{
    m_Index = value;
    m_set_State[0] |= 0x300;
}
 
inline
CMSMZHit_Base::TIndex& CMSMZHit_Base::SetIndex(void)
{
#ifdef _DEBUG
    if (!IsSetIndex()) {
        memset(&m_Index,UnassignedByte(),sizeof(m_Index));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Index;
}
 
inline
bool CMSMZHit_Base::IsSetMoreion(void) const
{
    return m_Moreion.NotEmpty();
}
 
inline
bool CMSMZHit_Base::CanGetMoreion(void) const
{
    return IsSetMoreion();
}
 
inline
const CMSMZHit_Base::TMoreion& CMSMZHit_Base::GetMoreion(void) const
{
    if (!CanGetMoreion()) {
        ThrowUnassigned(5);
    }
    return (*m_Moreion);
}
 
inline
bool CMSMZHit_Base::IsSetAnnotation(void) const
{
    return m_Annotation.NotEmpty();
}
 
inline
bool CMSMZHit_Base::CanGetAnnotation(void) const
{
    return IsSetAnnotation();
}
 
inline
const CMSMZHit_Base::TAnnotation& CMSMZHit_Base::GetAnnotation(void) const
{
    if (!CanGetAnnotation()) {
        ThrowUnassigned(6);
    }
    return (*m_Annotation);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_OMSSA_MSMZHIT_BASE_HPP