Asapratio_contribution_.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 Asapratio_contribution_.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_ASAPRATIO_CONTRIBUTION_BASE_HPP
#define ALGO_MS_FORMATS_PEPXML_ASAPRATIO_CONTRIBUTION_BASE_HPP
 
// standard includes
#include <serial/serialbase.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 CAsapratio_lc_heavypeak;
class CAsapratio_lc_lightpeak;
 
 
// generated classes
 
 
/** @addtogroup dataspec_pepXML
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CAsapratio_contribution_Base --
///
 
class NCBI_PEPXML_EXPORT CAsapratio_contribution_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CAsapratio_contribution_Base(void);
    // destructor
    virtual ~CAsapratio_contribution_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 double TRatio;
        typedef double TError;
        typedef int TCharge;
        typedef int TUse;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_ratio,
            e_error,
            e_charge,
            e_use
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Ratio data member.
        ///
        /// Data member Ratio is mandatory;
        /// its type is defined as 'typedef double TRatio'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetRatio(void) const;
    
        /// Check if it is safe to call GetRatio method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetRatio(void) const;
    
        /// Reset Ratio data member.
        void ResetRatio(void);
    
        /// Get the Ratio member data.
        ///
        /// @return
        ///   Copy of the member data.
        TRatio GetRatio(void) const;
    
        /// Assign a value to Ratio data member.
        ///
        /// @param value
        ///   Value to assign
        void SetRatio(TRatio value);
    
        /// Assign a value to Ratio data member.
        ///
        /// @return
        ///   Reference to the data value.
        TRatio& SetRatio(void);
    
        /// Check if a value has been assigned to Error data member.
        ///
        /// Data member Error is mandatory;
        /// its type is defined as 'typedef double TError'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetError(void) const;
    
        /// Check if it is safe to call GetError method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetError(void) const;
    
        /// Reset Error data member.
        void ResetError(void);
    
        /// Get the Error member data.
        ///
        /// @return
        ///   Copy of the member data.
        TError GetError(void) const;
    
        /// Assign a value to Error data member.
        ///
        /// @param value
        ///   Value to assign
        void SetError(TError value);
    
        /// Assign a value to Error data member.
        ///
        /// @return
        ///   Reference to the data value.
        TError& SetError(void);
    
        /// 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);
    
        /// Check if a value has been assigned to Use data member.
        ///
        /// Data member Use is mandatory;
        /// its type is defined as 'typedef int TUse'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetUse(void) const;
    
        /// Check if it is safe to call GetUse method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetUse(void) const;
    
        /// Reset Use data member.
        void ResetUse(void);
    
        /// Get the Use member data.
        ///
        /// @return
        ///   Copy of the member data.
        TUse GetUse(void) const;
    
        /// Assign a value to Use data member.
        ///
        /// @param value
        ///   Value to assign
        void SetUse(TUse value);
    
        /// Assign a value to Use data member.
        ///
        /// @return
        ///   Reference to the data value.
        TUse& SetUse(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];
        double m_Ratio;
        double m_Error;
        int m_Charge;
        int m_Use;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef CAsapratio_lc_lightpeak TAsapratio_lc_lightpeak;
    typedef CAsapratio_lc_heavypeak TAsapratio_lc_heavypeak;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_asapratio_lc_lightpeak,
        e_asapratio_lc_heavypeak
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> 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 Asapratio_lc_lightpeak data member.
    ///
    /// Data member Asapratio_lc_lightpeak is mandatory;
    /// its type is defined as 'typedef CAsapratio_lc_lightpeak TAsapratio_lc_lightpeak'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAsapratio_lc_lightpeak(void) const;
 
    /// Check if value of Asapratio_lc_lightpeak member is getatable.
    ///
    /// @return
    ///   - false; the data member of type 'NULL' has no value.
    bool CanGetAsapratio_lc_lightpeak(void) const;
 
    /// Reset Asapratio_lc_lightpeak data member.
    void ResetAsapratio_lc_lightpeak(void);
 
    /// Get the Asapratio_lc_lightpeak member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAsapratio_lc_lightpeak& GetAsapratio_lc_lightpeak(void) const;
 
    /// Assign a value to Asapratio_lc_lightpeak data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAsapratio_lc_lightpeak(TAsapratio_lc_lightpeak& value);
 
    /// Assign a value to Asapratio_lc_lightpeak data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAsapratio_lc_lightpeak& SetAsapratio_lc_lightpeak(void);
 
    /// Check if a value has been assigned to Asapratio_lc_heavypeak data member.
    ///
    /// Data member Asapratio_lc_heavypeak is mandatory;
    /// its type is defined as 'typedef CAsapratio_lc_heavypeak TAsapratio_lc_heavypeak'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAsapratio_lc_heavypeak(void) const;
 
    /// Check if value of Asapratio_lc_heavypeak member is getatable.
    ///
    /// @return
    ///   - false; the data member of type 'NULL' has no value.
    bool CanGetAsapratio_lc_heavypeak(void) const;
 
    /// Reset Asapratio_lc_heavypeak data member.
    void ResetAsapratio_lc_heavypeak(void);
 
    /// Get the Asapratio_lc_heavypeak member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAsapratio_lc_heavypeak& GetAsapratio_lc_heavypeak(void) const;
 
    /// Assign a value to Asapratio_lc_heavypeak data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAsapratio_lc_heavypeak(TAsapratio_lc_heavypeak& value);
 
    /// Assign a value to Asapratio_lc_heavypeak data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAsapratio_lc_heavypeak& SetAsapratio_lc_heavypeak(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CAsapratio_contribution_Base(const CAsapratio_contribution_Base&);
    CAsapratio_contribution_Base& operator=(const CAsapratio_contribution_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
    CRef< TAsapratio_lc_lightpeak > m_Asapratio_lc_lightpeak;
    CRef< TAsapratio_lc_heavypeak > m_Asapratio_lc_heavypeak;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CAsapratio_contribution_Base::C_Attlist::IsSetRatio(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::CanGetRatio(void) const
{
    return IsSetRatio();
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::ResetRatio(void)
{
    m_Ratio = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TRatio CAsapratio_contribution_Base::C_Attlist::GetRatio(void) const
{
    if (!CanGetRatio()) {
        ThrowUnassigned(0);
    }
    return m_Ratio;
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::SetRatio(CAsapratio_contribution_Base::C_Attlist::TRatio value)
{
    m_Ratio = value;
    m_set_State[0] |= 0x3;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TRatio& CAsapratio_contribution_Base::C_Attlist::SetRatio(void)
{
#ifdef _DEBUG
    if (!IsSetRatio()) {
        memset(&m_Ratio,UnassignedByte(),sizeof(m_Ratio));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Ratio;
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::IsSetError(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::CanGetError(void) const
{
    return IsSetError();
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::ResetError(void)
{
    m_Error = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TError CAsapratio_contribution_Base::C_Attlist::GetError(void) const
{
    if (!CanGetError()) {
        ThrowUnassigned(1);
    }
    return m_Error;
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::SetError(CAsapratio_contribution_Base::C_Attlist::TError value)
{
    m_Error = value;
    m_set_State[0] |= 0xc;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TError& CAsapratio_contribution_Base::C_Attlist::SetError(void)
{
#ifdef _DEBUG
    if (!IsSetError()) {
        memset(&m_Error,UnassignedByte(),sizeof(m_Error));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Error;
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::IsSetCharge(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::CanGetCharge(void) const
{
    return IsSetCharge();
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::ResetCharge(void)
{
    m_Charge = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TCharge CAsapratio_contribution_Base::C_Attlist::GetCharge(void) const
{
    if (!CanGetCharge()) {
        ThrowUnassigned(2);
    }
    return m_Charge;
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::SetCharge(CAsapratio_contribution_Base::C_Attlist::TCharge value)
{
    m_Charge = value;
    m_set_State[0] |= 0x30;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TCharge& CAsapratio_contribution_Base::C_Attlist::SetCharge(void)
{
#ifdef _DEBUG
    if (!IsSetCharge()) {
        memset(&m_Charge,UnassignedByte(),sizeof(m_Charge));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Charge;
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::IsSetUse(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CAsapratio_contribution_Base::C_Attlist::CanGetUse(void) const
{
    return IsSetUse();
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::ResetUse(void)
{
    m_Use = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TUse CAsapratio_contribution_Base::C_Attlist::GetUse(void) const
{
    if (!CanGetUse()) {
        ThrowUnassigned(3);
    }
    return m_Use;
}
 
inline
void CAsapratio_contribution_Base::C_Attlist::SetUse(CAsapratio_contribution_Base::C_Attlist::TUse value)
{
    m_Use = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CAsapratio_contribution_Base::C_Attlist::TUse& CAsapratio_contribution_Base::C_Attlist::SetUse(void)
{
#ifdef _DEBUG
    if (!IsSetUse()) {
        memset(&m_Use,UnassignedByte(),sizeof(m_Use));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Use;
}
 
inline
bool CAsapratio_contribution_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CAsapratio_contribution_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CAsapratio_contribution_Base::TAttlist& CAsapratio_contribution_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CAsapratio_contribution_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CAsapratio_contribution_Base::TAttlist& CAsapratio_contribution_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CAsapratio_contribution_Base::CanGetAsapratio_lc_lightpeak(void) const
{
    return true;
}
 
inline
const CAsapratio_contribution_Base::TAsapratio_lc_lightpeak& CAsapratio_contribution_Base::GetAsapratio_lc_lightpeak(void) const
{
    if ( !m_Asapratio_lc_lightpeak ) {
        const_cast<CAsapratio_contribution_Base*>(this)->ResetAsapratio_lc_lightpeak();
    }
    return (*m_Asapratio_lc_lightpeak);
}
 
inline
bool CAsapratio_contribution_Base::CanGetAsapratio_lc_heavypeak(void) const
{
    return true;
}
 
inline
const CAsapratio_contribution_Base::TAsapratio_lc_heavypeak& CAsapratio_contribution_Base::GetAsapratio_lc_heavypeak(void) const
{
    if ( !m_Asapratio_lc_heavypeak ) {
        const_cast<CAsapratio_contribution_Base*>(this)->ResetAsapratio_lc_heavypeak();
    }
    return (*m_Asapratio_lc_heavypeak);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_MS_FORMATS_PEPXML_ASAPRATIO_CONTRIBUTION_BASE_HPP