Mixture_model_.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 Mixture_model_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.xsd">pepXML.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.def">pepXML.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef ALGO_MS_FORMATS_PEPXML_MIXTURE_MODEL_BASE_HPP
#define ALGO_MS_FORMATS_PEPXML_MIXTURE_MODEL_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <string>
 
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 CMixturemodel_distribution;
 
 
// generated classes
 
 
/** @addtogroup dataspec_pepXML
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CMixture_model_Base --
///
 
class NCBI_PEPXML_EXPORT CMixture_model_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CMixture_model_Base(void);
    // destructor
    virtual ~CMixture_model_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class NCBI_PEPXML_EXPORT C_Attlist : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Attlist(void);
        // destructor
        ~C_Attlist(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef int TPrecursor_ion_charge;
        typedef string TComments;
        typedef double TPrior_probability;
        typedef string TEst_tot_correct;
        typedef string TTot_num_spectra;
        typedef string TNum_iterations;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_precursor_ion_charge,
            e_comments,
            e_prior_probability,
            e_est_tot_correct,
            e_tot_num_spectra,
            e_num_iterations
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Precursor_ion_charge data member.
        ///
        /// Data member Precursor_ion_charge is mandatory;
        /// its type is defined as 'typedef int TPrecursor_ion_charge'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetPrecursor_ion_charge(void) const;
    
        /// Check if it is safe to call GetPrecursor_ion_charge method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetPrecursor_ion_charge(void) const;
    
        /// Reset Precursor_ion_charge data member.
        void ResetPrecursor_ion_charge(void);
    
        /// Get the Precursor_ion_charge member data.
        ///
        /// @return
        ///   Copy of the member data.
        TPrecursor_ion_charge GetPrecursor_ion_charge(void) const;
    
        /// Assign a value to Precursor_ion_charge data member.
        ///
        /// @param value
        ///   Value to assign
        void SetPrecursor_ion_charge(TPrecursor_ion_charge value);
    
        /// Assign a value to Precursor_ion_charge data member.
        ///
        /// @return
        ///   Reference to the data value.
        TPrecursor_ion_charge& SetPrecursor_ion_charge(void);
    
        /// Check if a value has been assigned to Comments data member.
        ///
        /// Data member Comments is mandatory;
        /// its type is defined as 'typedef string TComments'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetComments(void) const;
    
        /// Check if it is safe to call GetComments method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetComments(void) const;
    
        /// Reset Comments data member.
        void ResetComments(void);
    
        /// Get the Comments member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TComments& GetComments(void) const;
    
        /// Assign a value to Comments data member.
        ///
        /// @param value
        ///   Value to assign
        void SetComments(const TComments& value);
        void SetComments(TComments&& value);
    
        /// Assign a value to Comments data member.
        ///
        /// @return
        ///   Reference to the data value.
        TComments& SetComments(void);
    
        /// Check if a value has been assigned to Prior_probability data member.
        ///
        /// Data member Prior_probability is mandatory;
        /// its type is defined as 'typedef double TPrior_probability'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetPrior_probability(void) const;
    
        /// Check if it is safe to call GetPrior_probability method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetPrior_probability(void) const;
    
        /// Reset Prior_probability data member.
        void ResetPrior_probability(void);
    
        /// Get the Prior_probability member data.
        ///
        /// @return
        ///   Copy of the member data.
        TPrior_probability GetPrior_probability(void) const;
    
        /// Assign a value to Prior_probability data member.
        ///
        /// @param value
        ///   Value to assign
        void SetPrior_probability(TPrior_probability value);
    
        /// Assign a value to Prior_probability data member.
        ///
        /// @return
        ///   Reference to the data value.
        TPrior_probability& SetPrior_probability(void);
    
        /// Check if a value has been assigned to Est_tot_correct data member.
        ///
        /// Data member Est_tot_correct is mandatory;
        /// its type is defined as 'typedef string TEst_tot_correct'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetEst_tot_correct(void) const;
    
        /// Check if it is safe to call GetEst_tot_correct method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetEst_tot_correct(void) const;
    
        /// Reset Est_tot_correct data member.
        void ResetEst_tot_correct(void);
    
        /// Get the Est_tot_correct member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TEst_tot_correct& GetEst_tot_correct(void) const;
    
        /// Assign a value to Est_tot_correct data member.
        ///
        /// @param value
        ///   Value to assign
        void SetEst_tot_correct(const TEst_tot_correct& value);
        void SetEst_tot_correct(TEst_tot_correct&& value);
    
        /// Assign a value to Est_tot_correct data member.
        ///
        /// @return
        ///   Reference to the data value.
        TEst_tot_correct& SetEst_tot_correct(void);
    
        /// Check if a value has been assigned to Tot_num_spectra data member.
        ///
        /// Data member Tot_num_spectra is mandatory;
        /// its type is defined as 'typedef string TTot_num_spectra'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetTot_num_spectra(void) const;
    
        /// Check if it is safe to call GetTot_num_spectra method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetTot_num_spectra(void) const;
    
        /// Reset Tot_num_spectra data member.
        void ResetTot_num_spectra(void);
    
        /// Get the Tot_num_spectra member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TTot_num_spectra& GetTot_num_spectra(void) const;
    
        /// Assign a value to Tot_num_spectra data member.
        ///
        /// @param value
        ///   Value to assign
        void SetTot_num_spectra(const TTot_num_spectra& value);
        void SetTot_num_spectra(TTot_num_spectra&& value);
    
        /// Assign a value to Tot_num_spectra data member.
        ///
        /// @return
        ///   Reference to the data value.
        TTot_num_spectra& SetTot_num_spectra(void);
    
        /// Check if a value has been assigned to Num_iterations data member.
        ///
        /// Data member Num_iterations is mandatory;
        /// its type is defined as 'typedef string TNum_iterations'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetNum_iterations(void) const;
    
        /// Check if it is safe to call GetNum_iterations method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetNum_iterations(void) const;
    
        /// Reset Num_iterations data member.
        void ResetNum_iterations(void);
    
        /// Get the Num_iterations member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TNum_iterations& GetNum_iterations(void) const;
    
        /// Assign a value to Num_iterations data member.
        ///
        /// @param value
        ///   Value to assign
        void SetNum_iterations(const TNum_iterations& value);
        void SetNum_iterations(TNum_iterations&& value);
    
        /// Assign a value to Num_iterations data member.
        ///
        /// @return
        ///   Reference to the data value.
        TNum_iterations& SetNum_iterations(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Attlist(const C_Attlist&);
        C_Attlist& operator=(const C_Attlist&);
    
        // data
        Uint4 m_set_State[1];
        int m_Precursor_ion_charge;
        string m_Comments;
        double m_Prior_probability;
        string m_Est_tot_correct;
        string m_Tot_num_spectra;
        string m_Num_iterations;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef list< CRef< CMixturemodel_distribution > > TMixturemodel_distribution;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_mixturemodel_distribution
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Attlist data member.
    ///
    /// Data member Attlist is mandatory;
    /// its type is defined as 'typedef C_Attlist TAttlist'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAttlist(void) const;
 
    /// Check if it is safe to call GetAttlist method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAttlist(void) const;
 
    /// Reset Attlist data member.
    void ResetAttlist(void);
 
    /// Get the Attlist member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAttlist& GetAttlist(void) const;
 
    /// Assign a value to Attlist data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAttlist(TAttlist& value);
 
    /// Assign a value to Attlist data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAttlist& SetAttlist(void);
 
    /// Check if a value has been assigned to Mixturemodel_distribution data member.
    ///
    /// Data member Mixturemodel_distribution is mandatory;
    /// its type is defined as 'typedef list< CRef< CMixturemodel_distribution > > TMixturemodel_distribution'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMixturemodel_distribution(void) const;
 
    /// Check if it is safe to call GetMixturemodel_distribution method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMixturemodel_distribution(void) const;
 
    /// Reset Mixturemodel_distribution data member.
    void ResetMixturemodel_distribution(void);
 
    /// Get the Mixturemodel_distribution member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMixturemodel_distribution& GetMixturemodel_distribution(void) const;
 
    /// Assign a value to Mixturemodel_distribution data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMixturemodel_distribution& SetMixturemodel_distribution(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMixture_model_Base(const CMixture_model_Base&);
    CMixture_model_Base& operator=(const CMixture_model_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
    list< CRef< CMixturemodel_distribution > > m_Mixturemodel_distribution;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMixture_model_Base::C_Attlist::IsSetPrecursor_ion_charge(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CMixture_model_Base::C_Attlist::CanGetPrecursor_ion_charge(void) const
{
    return IsSetPrecursor_ion_charge();
}
 
inline
void CMixture_model_Base::C_Attlist::ResetPrecursor_ion_charge(void)
{
    m_Precursor_ion_charge = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CMixture_model_Base::C_Attlist::TPrecursor_ion_charge CMixture_model_Base::C_Attlist::GetPrecursor_ion_charge(void) const
{
    if (!CanGetPrecursor_ion_charge()) {
        ThrowUnassigned(0);
    }
    return m_Precursor_ion_charge;
}
 
inline
void CMixture_model_Base::C_Attlist::SetPrecursor_ion_charge(CMixture_model_Base::C_Attlist::TPrecursor_ion_charge value)
{
    m_Precursor_ion_charge = value;
    m_set_State[0] |= 0x3;
}
 
inline
CMixture_model_Base::C_Attlist::TPrecursor_ion_charge& CMixture_model_Base::C_Attlist::SetPrecursor_ion_charge(void)
{
#ifdef _DEBUG
    if (!IsSetPrecursor_ion_charge()) {
        memset(&m_Precursor_ion_charge,UnassignedByte(),sizeof(m_Precursor_ion_charge));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Precursor_ion_charge;
}
 
inline
bool CMixture_model_Base::C_Attlist::IsSetComments(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CMixture_model_Base::C_Attlist::CanGetComments(void) const
{
    return IsSetComments();
}
 
inline
const CMixture_model_Base::C_Attlist::TComments& CMixture_model_Base::C_Attlist::GetComments(void) const
{
    if (!CanGetComments()) {
        ThrowUnassigned(1);
    }
    return m_Comments;
}
 
inline
void CMixture_model_Base::C_Attlist::SetComments(const CMixture_model_Base::C_Attlist::TComments& value)
{
    m_Comments = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CMixture_model_Base::C_Attlist::SetComments(CMixture_model_Base::C_Attlist::TComments&& value)
{
    m_Comments = std::forward<CMixture_model_Base::C_Attlist::TComments>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CMixture_model_Base::C_Attlist::TComments& CMixture_model_Base::C_Attlist::SetComments(void)
{
#ifdef _DEBUG
    if (!IsSetComments()) {
        m_Comments = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Comments;
}
 
inline
bool CMixture_model_Base::C_Attlist::IsSetPrior_probability(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CMixture_model_Base::C_Attlist::CanGetPrior_probability(void) const
{
    return IsSetPrior_probability();
}
 
inline
void CMixture_model_Base::C_Attlist::ResetPrior_probability(void)
{
    m_Prior_probability = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CMixture_model_Base::C_Attlist::TPrior_probability CMixture_model_Base::C_Attlist::GetPrior_probability(void) const
{
    if (!CanGetPrior_probability()) {
        ThrowUnassigned(2);
    }
    return m_Prior_probability;
}
 
inline
void CMixture_model_Base::C_Attlist::SetPrior_probability(CMixture_model_Base::C_Attlist::TPrior_probability value)
{
    m_Prior_probability = value;
    m_set_State[0] |= 0x30;
}
 
inline
CMixture_model_Base::C_Attlist::TPrior_probability& CMixture_model_Base::C_Attlist::SetPrior_probability(void)
{
#ifdef _DEBUG
    if (!IsSetPrior_probability()) {
        memset(&m_Prior_probability,UnassignedByte(),sizeof(m_Prior_probability));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Prior_probability;
}
 
inline
bool CMixture_model_Base::C_Attlist::IsSetEst_tot_correct(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CMixture_model_Base::C_Attlist::CanGetEst_tot_correct(void) const
{
    return IsSetEst_tot_correct();
}
 
inline
const CMixture_model_Base::C_Attlist::TEst_tot_correct& CMixture_model_Base::C_Attlist::GetEst_tot_correct(void) const
{
    if (!CanGetEst_tot_correct()) {
        ThrowUnassigned(3);
    }
    return m_Est_tot_correct;
}
 
inline
void CMixture_model_Base::C_Attlist::SetEst_tot_correct(const CMixture_model_Base::C_Attlist::TEst_tot_correct& value)
{
    m_Est_tot_correct = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CMixture_model_Base::C_Attlist::SetEst_tot_correct(CMixture_model_Base::C_Attlist::TEst_tot_correct&& value)
{
    m_Est_tot_correct = std::forward<CMixture_model_Base::C_Attlist::TEst_tot_correct>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CMixture_model_Base::C_Attlist::TEst_tot_correct& CMixture_model_Base::C_Attlist::SetEst_tot_correct(void)
{
#ifdef _DEBUG
    if (!IsSetEst_tot_correct()) {
        m_Est_tot_correct = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Est_tot_correct;
}
 
inline
bool CMixture_model_Base::C_Attlist::IsSetTot_num_spectra(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CMixture_model_Base::C_Attlist::CanGetTot_num_spectra(void) const
{
    return IsSetTot_num_spectra();
}
 
inline
const CMixture_model_Base::C_Attlist::TTot_num_spectra& CMixture_model_Base::C_Attlist::GetTot_num_spectra(void) const
{
    if (!CanGetTot_num_spectra()) {
        ThrowUnassigned(4);
    }
    return m_Tot_num_spectra;
}
 
inline
void CMixture_model_Base::C_Attlist::SetTot_num_spectra(const CMixture_model_Base::C_Attlist::TTot_num_spectra& value)
{
    m_Tot_num_spectra = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CMixture_model_Base::C_Attlist::SetTot_num_spectra(CMixture_model_Base::C_Attlist::TTot_num_spectra&& value)
{
    m_Tot_num_spectra = std::forward<CMixture_model_Base::C_Attlist::TTot_num_spectra>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CMixture_model_Base::C_Attlist::TTot_num_spectra& CMixture_model_Base::C_Attlist::SetTot_num_spectra(void)
{
#ifdef _DEBUG
    if (!IsSetTot_num_spectra()) {
        m_Tot_num_spectra = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Tot_num_spectra;
}
 
inline
bool CMixture_model_Base::C_Attlist::IsSetNum_iterations(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CMixture_model_Base::C_Attlist::CanGetNum_iterations(void) const
{
    return IsSetNum_iterations();
}
 
inline
const CMixture_model_Base::C_Attlist::TNum_iterations& CMixture_model_Base::C_Attlist::GetNum_iterations(void) const
{
    if (!CanGetNum_iterations()) {
        ThrowUnassigned(5);
    }
    return m_Num_iterations;
}
 
inline
void CMixture_model_Base::C_Attlist::SetNum_iterations(const CMixture_model_Base::C_Attlist::TNum_iterations& value)
{
    m_Num_iterations = value;
    m_set_State[0] |= 0xc00;
}
 
inline
void CMixture_model_Base::C_Attlist::SetNum_iterations(CMixture_model_Base::C_Attlist::TNum_iterations&& value)
{
    m_Num_iterations = std::forward<CMixture_model_Base::C_Attlist::TNum_iterations>(value);
    m_set_State[0] |= 0xc00;
}
 
inline
CMixture_model_Base::C_Attlist::TNum_iterations& CMixture_model_Base::C_Attlist::SetNum_iterations(void)
{
#ifdef _DEBUG
    if (!IsSetNum_iterations()) {
        m_Num_iterations = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Num_iterations;
}
 
inline
bool CMixture_model_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CMixture_model_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CMixture_model_Base::TAttlist& CMixture_model_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CMixture_model_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CMixture_model_Base::TAttlist& CMixture_model_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CMixture_model_Base::IsSetMixturemodel_distribution(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CMixture_model_Base::CanGetMixturemodel_distribution(void) const
{
    return true;
}
 
inline
const CMixture_model_Base::TMixturemodel_distribution& CMixture_model_Base::GetMixturemodel_distribution(void) const
{
    return m_Mixturemodel_distribution;
}
 
inline
CMixture_model_Base::TMixturemodel_distribution& CMixture_model_Base::SetMixturemodel_distribution(void)
{
    m_set_State[0] |= 0x4;
    return m_Mixturemodel_distribution;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_MS_FORMATS_PEPXML_MIXTURE_MODEL_BASE_HPP