Analysis_summary_.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 Analysis_summary_.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_ANALYSIS_SUMMARY_BASE_HPP
#define ALGO_MS_FORMATS_PEPXML_ANALYSIS_SUMMARY_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 CAsapratio_summary;
class CInteract_summary;
class CLibra_summary;
class CPeptideprophet_summary;
class CXpressratio_summary;
 
 
// generated classes
 
 
/** @addtogroup dataspec_pepXML
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///Summary of analysis subjected to run(s) 
///
/// CAnalysis_summary_Base --
///
 
class NCBI_PEPXML_EXPORT CAnalysis_summary_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CAnalysis_summary_Base(void);
    // destructor
    virtual ~CAnalysis_summary_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 string TTime;
        typedef string TAnalysis;
        typedef string TVersion;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_time,
            e_analysis,
            e_version
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Time data member.
        ///
        /// Data member Time is mandatory;
        /// its type is defined as 'typedef string TTime'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetTime(void) const;
    
        /// Check if it is safe to call GetTime method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetTime(void) const;
    
        /// Reset Time data member.
        void ResetTime(void);
    
        /// Get the Time member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TTime& GetTime(void) const;
    
        /// Assign a value to Time data member.
        ///
        /// @param value
        ///   Value to assign
        void SetTime(const TTime& value);
        void SetTime(TTime&& value);
    
        /// Assign a value to Time data member.
        ///
        /// @return
        ///   Reference to the data value.
        TTime& SetTime(void);
    
        /// Check if a value has been assigned to Analysis data member.
        ///
        /// Data member Analysis is mandatory;
        /// its type is defined as 'typedef string TAnalysis'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetAnalysis(void) const;
    
        /// Check if it is safe to call GetAnalysis method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetAnalysis(void) const;
    
        /// Reset Analysis data member.
        void ResetAnalysis(void);
    
        /// Get the Analysis member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TAnalysis& GetAnalysis(void) const;
    
        /// Assign a value to Analysis data member.
        ///
        /// @param value
        ///   Value to assign
        void SetAnalysis(const TAnalysis& value);
        void SetAnalysis(TAnalysis&& value);
    
        /// Assign a value to Analysis data member.
        ///
        /// @return
        ///   Reference to the data value.
        TAnalysis& SetAnalysis(void);
    
        /// Check if a value has been assigned to Version data member.
        ///
        /// Data member Version is optional;
        /// its type is defined as 'typedef string TVersion'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetVersion(void) const;
    
        /// Check if it is safe to call GetVersion method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetVersion(void) const;
    
        /// Reset Version data member.
        void ResetVersion(void);
    
        /// Get the Version member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TVersion& GetVersion(void) const;
    
        /// Assign a value to Version data member.
        ///
        /// @param value
        ///   Value to assign
        void SetVersion(const TVersion& value);
        void SetVersion(TVersion&& value);
    
        /// Assign a value to Version data member.
        ///
        /// @return
        ///   Reference to the data value.
        TVersion& SetVersion(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];
        string m_Time;
        string m_Analysis;
        string m_Version;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef list< CRef< CPeptideprophet_summary > > TPeptideprophet_summary;
    typedef list< CRef< CInteract_summary > > TInteract_summary;
    typedef list< CRef< CLibra_summary > > TLibra_summary;
    typedef list< CRef< CAsapratio_summary > > TAsapratio_summary;
    typedef list< CRef< CXpressratio_summary > > TXpressratio_summary;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_peptideprophet_summary,
        e_interact_summary,
        e_libra_summary,
        e_asapratio_summary,
        e_xpressratio_summary
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> 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 Peptideprophet_summary data member.
    ///
    /// Data member Peptideprophet_summary is optional;
    /// its type is defined as 'typedef list< CRef< CPeptideprophet_summary > > TPeptideprophet_summary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPeptideprophet_summary(void) const;
 
    /// Check if it is safe to call GetPeptideprophet_summary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPeptideprophet_summary(void) const;
 
    /// Reset Peptideprophet_summary data member.
    void ResetPeptideprophet_summary(void);
 
    /// Get the Peptideprophet_summary member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPeptideprophet_summary& GetPeptideprophet_summary(void) const;
 
    /// Assign a value to Peptideprophet_summary data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPeptideprophet_summary& SetPeptideprophet_summary(void);
 
    /// Check if a value has been assigned to Interact_summary data member.
    ///
    /// Data member Interact_summary is optional;
    /// its type is defined as 'typedef list< CRef< CInteract_summary > > TInteract_summary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetInteract_summary(void) const;
 
    /// Check if it is safe to call GetInteract_summary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetInteract_summary(void) const;
 
    /// Reset Interact_summary data member.
    void ResetInteract_summary(void);
 
    /// Get the Interact_summary member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TInteract_summary& GetInteract_summary(void) const;
 
    /// Assign a value to Interact_summary data member.
    ///
    /// @return
    ///   Reference to the data value.
    TInteract_summary& SetInteract_summary(void);
 
    /// Check if a value has been assigned to Libra_summary data member.
    ///
    /// Data member Libra_summary is optional;
    /// its type is defined as 'typedef list< CRef< CLibra_summary > > TLibra_summary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLibra_summary(void) const;
 
    /// Check if it is safe to call GetLibra_summary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLibra_summary(void) const;
 
    /// Reset Libra_summary data member.
    void ResetLibra_summary(void);
 
    /// Get the Libra_summary member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLibra_summary& GetLibra_summary(void) const;
 
    /// Assign a value to Libra_summary data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLibra_summary& SetLibra_summary(void);
 
    /// Check if a value has been assigned to Asapratio_summary data member.
    ///
    /// Data member Asapratio_summary is optional;
    /// its type is defined as 'typedef list< CRef< CAsapratio_summary > > TAsapratio_summary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAsapratio_summary(void) const;
 
    /// Check if it is safe to call GetAsapratio_summary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAsapratio_summary(void) const;
 
    /// Reset Asapratio_summary data member.
    void ResetAsapratio_summary(void);
 
    /// Get the Asapratio_summary member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAsapratio_summary& GetAsapratio_summary(void) const;
 
    /// Assign a value to Asapratio_summary data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAsapratio_summary& SetAsapratio_summary(void);
 
    /// Check if a value has been assigned to Xpressratio_summary data member.
    ///
    /// Data member Xpressratio_summary is optional;
    /// its type is defined as 'typedef list< CRef< CXpressratio_summary > > TXpressratio_summary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetXpressratio_summary(void) const;
 
    /// Check if it is safe to call GetXpressratio_summary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetXpressratio_summary(void) const;
 
    /// Reset Xpressratio_summary data member.
    void ResetXpressratio_summary(void);
 
    /// Get the Xpressratio_summary member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TXpressratio_summary& GetXpressratio_summary(void) const;
 
    /// Assign a value to Xpressratio_summary data member.
    ///
    /// @return
    ///   Reference to the data value.
    TXpressratio_summary& SetXpressratio_summary(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CAnalysis_summary_Base(const CAnalysis_summary_Base&);
    CAnalysis_summary_Base& operator=(const CAnalysis_summary_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
    list< CRef< CPeptideprophet_summary > > m_Peptideprophet_summary;
    list< CRef< CInteract_summary > > m_Interact_summary;
    list< CRef< CLibra_summary > > m_Libra_summary;
    list< CRef< CAsapratio_summary > > m_Asapratio_summary;
    list< CRef< CXpressratio_summary > > m_Xpressratio_summary;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CAnalysis_summary_Base::C_Attlist::IsSetTime(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CAnalysis_summary_Base::C_Attlist::CanGetTime(void) const
{
    return IsSetTime();
}
 
inline
const CAnalysis_summary_Base::C_Attlist::TTime& CAnalysis_summary_Base::C_Attlist::GetTime(void) const
{
    if (!CanGetTime()) {
        ThrowUnassigned(0);
    }
    return m_Time;
}
 
inline
void CAnalysis_summary_Base::C_Attlist::SetTime(const CAnalysis_summary_Base::C_Attlist::TTime& value)
{
    m_Time = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CAnalysis_summary_Base::C_Attlist::SetTime(CAnalysis_summary_Base::C_Attlist::TTime&& value)
{
    m_Time = std::forward<CAnalysis_summary_Base::C_Attlist::TTime>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CAnalysis_summary_Base::C_Attlist::TTime& CAnalysis_summary_Base::C_Attlist::SetTime(void)
{
#ifdef _DEBUG
    if (!IsSetTime()) {
        m_Time = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Time;
}
 
inline
bool CAnalysis_summary_Base::C_Attlist::IsSetAnalysis(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAnalysis_summary_Base::C_Attlist::CanGetAnalysis(void) const
{
    return IsSetAnalysis();
}
 
inline
const CAnalysis_summary_Base::C_Attlist::TAnalysis& CAnalysis_summary_Base::C_Attlist::GetAnalysis(void) const
{
    if (!CanGetAnalysis()) {
        ThrowUnassigned(1);
    }
    return m_Analysis;
}
 
inline
void CAnalysis_summary_Base::C_Attlist::SetAnalysis(const CAnalysis_summary_Base::C_Attlist::TAnalysis& value)
{
    m_Analysis = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CAnalysis_summary_Base::C_Attlist::SetAnalysis(CAnalysis_summary_Base::C_Attlist::TAnalysis&& value)
{
    m_Analysis = std::forward<CAnalysis_summary_Base::C_Attlist::TAnalysis>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CAnalysis_summary_Base::C_Attlist::TAnalysis& CAnalysis_summary_Base::C_Attlist::SetAnalysis(void)
{
#ifdef _DEBUG
    if (!IsSetAnalysis()) {
        m_Analysis = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Analysis;
}
 
inline
bool CAnalysis_summary_Base::C_Attlist::IsSetVersion(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CAnalysis_summary_Base::C_Attlist::CanGetVersion(void) const
{
    return IsSetVersion();
}
 
inline
const CAnalysis_summary_Base::C_Attlist::TVersion& CAnalysis_summary_Base::C_Attlist::GetVersion(void) const
{
    if (!CanGetVersion()) {
        ThrowUnassigned(2);
    }
    return m_Version;
}
 
inline
void CAnalysis_summary_Base::C_Attlist::SetVersion(const CAnalysis_summary_Base::C_Attlist::TVersion& value)
{
    m_Version = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CAnalysis_summary_Base::C_Attlist::SetVersion(CAnalysis_summary_Base::C_Attlist::TVersion&& value)
{
    m_Version = std::forward<CAnalysis_summary_Base::C_Attlist::TVersion>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CAnalysis_summary_Base::C_Attlist::TVersion& CAnalysis_summary_Base::C_Attlist::SetVersion(void)
{
#ifdef _DEBUG
    if (!IsSetVersion()) {
        m_Version = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Version;
}
 
inline
bool CAnalysis_summary_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CAnalysis_summary_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CAnalysis_summary_Base::TAttlist& CAnalysis_summary_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CAnalysis_summary_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CAnalysis_summary_Base::TAttlist& CAnalysis_summary_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CAnalysis_summary_Base::IsSetPeptideprophet_summary(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAnalysis_summary_Base::CanGetPeptideprophet_summary(void) const
{
    return true;
}
 
inline
const CAnalysis_summary_Base::TPeptideprophet_summary& CAnalysis_summary_Base::GetPeptideprophet_summary(void) const
{
    return m_Peptideprophet_summary;
}
 
inline
CAnalysis_summary_Base::TPeptideprophet_summary& CAnalysis_summary_Base::SetPeptideprophet_summary(void)
{
    m_set_State[0] |= 0x4;
    return m_Peptideprophet_summary;
}
 
inline
bool CAnalysis_summary_Base::IsSetInteract_summary(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CAnalysis_summary_Base::CanGetInteract_summary(void) const
{
    return true;
}
 
inline
const CAnalysis_summary_Base::TInteract_summary& CAnalysis_summary_Base::GetInteract_summary(void) const
{
    return m_Interact_summary;
}
 
inline
CAnalysis_summary_Base::TInteract_summary& CAnalysis_summary_Base::SetInteract_summary(void)
{
    m_set_State[0] |= 0x10;
    return m_Interact_summary;
}
 
inline
bool CAnalysis_summary_Base::IsSetLibra_summary(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CAnalysis_summary_Base::CanGetLibra_summary(void) const
{
    return true;
}
 
inline
const CAnalysis_summary_Base::TLibra_summary& CAnalysis_summary_Base::GetLibra_summary(void) const
{
    return m_Libra_summary;
}
 
inline
CAnalysis_summary_Base::TLibra_summary& CAnalysis_summary_Base::SetLibra_summary(void)
{
    m_set_State[0] |= 0x40;
    return m_Libra_summary;
}
 
inline
bool CAnalysis_summary_Base::IsSetAsapratio_summary(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CAnalysis_summary_Base::CanGetAsapratio_summary(void) const
{
    return true;
}
 
inline
const CAnalysis_summary_Base::TAsapratio_summary& CAnalysis_summary_Base::GetAsapratio_summary(void) const
{
    return m_Asapratio_summary;
}
 
inline
CAnalysis_summary_Base::TAsapratio_summary& CAnalysis_summary_Base::SetAsapratio_summary(void)
{
    m_set_State[0] |= 0x100;
    return m_Asapratio_summary;
}
 
inline
bool CAnalysis_summary_Base::IsSetXpressratio_summary(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CAnalysis_summary_Base::CanGetXpressratio_summary(void) const
{
    return true;
}
 
inline
const CAnalysis_summary_Base::TXpressratio_summary& CAnalysis_summary_Base::GetXpressratio_summary(void) const
{
    return m_Xpressratio_summary;
}
 
inline
CAnalysis_summary_Base::TXpressratio_summary& CAnalysis_summary_Base::SetXpressratio_summary(void)
{
    m_set_State[0] |= 0x400;
    return m_Xpressratio_summary;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_MS_FORMATS_PEPXML_ANALYSIS_SUMMARY_BASE_HPP