Align_stats_.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 Align_stats_.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/mmdb3/mmdb3.asn">mmdb3.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mmdb3/mmdb3.def">mmdb3.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MMDB3_ALIGN_STATS_BASE_HPP
#define OBJECTS_MMDB3_ALIGN_STATS_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_MMDB_Features
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CAlign_stats_Base --
///
 
class NCBI_MMDB3_EXPORT CAlign_stats_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CAlign_stats_Base(void);
    // destructor
    virtual ~CAlign_stats_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TDescr;
    typedef int TScale_factor;
    typedef int TVast_score;
    typedef int TVast_mlogp;
    typedef int TAlign_res;
    typedef int TRmsd;
    typedef int TBlast_score;
    typedef int TBlast_mlogp;
    typedef int TOther_score;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_descr,
        e_scale_factor,
        e_vast_score,
        e_vast_mlogp,
        e_align_res,
        e_rmsd,
        e_blast_score,
        e_blast_mlogp,
        e_other_score
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 10> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Descr data member.
    ///
    /// Data member Descr is optional;
    /// its type is defined as 'typedef string TDescr'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDescr(void) const;
 
    /// Check if it is safe to call GetDescr method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDescr(void) const;
 
    /// Reset Descr data member.
    void ResetDescr(void);
 
    /// Get the Descr member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDescr& GetDescr(void) const;
 
    /// Assign a value to Descr data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDescr(const TDescr& value);
    void SetDescr(TDescr&& value);
 
    /// Assign a value to Descr data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDescr& SetDescr(void);
 
    /// Check if a value has been assigned to Scale_factor data member.
    ///
    /// Data member Scale_factor is optional;
    /// its type is defined as 'typedef int TScale_factor'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetScale_factor(void) const;
 
    /// Check if it is safe to call GetScale_factor method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetScale_factor(void) const;
 
    /// Reset Scale_factor data member.
    void ResetScale_factor(void);
 
    /// Get the Scale_factor member data.
    ///
    /// @return
    ///   Copy of the member data.
    TScale_factor GetScale_factor(void) const;
 
    /// Assign a value to Scale_factor data member.
    ///
    /// @param value
    ///   Value to assign
    void SetScale_factor(TScale_factor value);
 
    /// Assign a value to Scale_factor data member.
    ///
    /// @return
    ///   Reference to the data value.
    TScale_factor& SetScale_factor(void);
 
    /// Check if a value has been assigned to Vast_score data member.
    ///
    /// Data member Vast_score is optional;
    /// its type is defined as 'typedef int TVast_score'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVast_score(void) const;
 
    /// Check if it is safe to call GetVast_score method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVast_score(void) const;
 
    /// Reset Vast_score data member.
    void ResetVast_score(void);
 
    /// Get the Vast_score member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVast_score GetVast_score(void) const;
 
    /// Assign a value to Vast_score data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVast_score(TVast_score value);
 
    /// Assign a value to Vast_score data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVast_score& SetVast_score(void);
 
    /// Check if a value has been assigned to Vast_mlogp data member.
    ///
    /// Data member Vast_mlogp is optional;
    /// its type is defined as 'typedef int TVast_mlogp'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVast_mlogp(void) const;
 
    /// Check if it is safe to call GetVast_mlogp method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVast_mlogp(void) const;
 
    /// Reset Vast_mlogp data member.
    void ResetVast_mlogp(void);
 
    /// Get the Vast_mlogp member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVast_mlogp GetVast_mlogp(void) const;
 
    /// Assign a value to Vast_mlogp data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVast_mlogp(TVast_mlogp value);
 
    /// Assign a value to Vast_mlogp data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVast_mlogp& SetVast_mlogp(void);
 
    /// Check if a value has been assigned to Align_res data member.
    ///
    /// Data member Align_res is optional;
    /// its type is defined as 'typedef int TAlign_res'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAlign_res(void) const;
 
    /// Check if it is safe to call GetAlign_res method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAlign_res(void) const;
 
    /// Reset Align_res data member.
    void ResetAlign_res(void);
 
    /// Get the Align_res member data.
    ///
    /// @return
    ///   Copy of the member data.
    TAlign_res GetAlign_res(void) const;
 
    /// Assign a value to Align_res data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAlign_res(TAlign_res value);
 
    /// Assign a value to Align_res data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAlign_res& SetAlign_res(void);
 
    /// Check if a value has been assigned to Rmsd data member.
    ///
    /// Data member Rmsd is optional;
    /// its type is defined as 'typedef int TRmsd'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRmsd(void) const;
 
    /// Check if it is safe to call GetRmsd method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRmsd(void) const;
 
    /// Reset Rmsd data member.
    void ResetRmsd(void);
 
    /// Get the Rmsd member data.
    ///
    /// @return
    ///   Copy of the member data.
    TRmsd GetRmsd(void) const;
 
    /// Assign a value to Rmsd data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRmsd(TRmsd value);
 
    /// Assign a value to Rmsd data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRmsd& SetRmsd(void);
 
    /// Check if a value has been assigned to Blast_score data member.
    ///
    /// Data member Blast_score is optional;
    /// its type is defined as 'typedef int TBlast_score'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBlast_score(void) const;
 
    /// Check if it is safe to call GetBlast_score method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBlast_score(void) const;
 
    /// Reset Blast_score data member.
    void ResetBlast_score(void);
 
    /// Get the Blast_score member data.
    ///
    /// @return
    ///   Copy of the member data.
    TBlast_score GetBlast_score(void) const;
 
    /// Assign a value to Blast_score data member.
    ///
    /// @param value
    ///   Value to assign
    void SetBlast_score(TBlast_score value);
 
    /// Assign a value to Blast_score data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBlast_score& SetBlast_score(void);
 
    /// Check if a value has been assigned to Blast_mlogp data member.
    ///
    /// Data member Blast_mlogp is optional;
    /// its type is defined as 'typedef int TBlast_mlogp'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBlast_mlogp(void) const;
 
    /// Check if it is safe to call GetBlast_mlogp method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBlast_mlogp(void) const;
 
    /// Reset Blast_mlogp data member.
    void ResetBlast_mlogp(void);
 
    /// Get the Blast_mlogp member data.
    ///
    /// @return
    ///   Copy of the member data.
    TBlast_mlogp GetBlast_mlogp(void) const;
 
    /// Assign a value to Blast_mlogp data member.
    ///
    /// @param value
    ///   Value to assign
    void SetBlast_mlogp(TBlast_mlogp value);
 
    /// Assign a value to Blast_mlogp data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBlast_mlogp& SetBlast_mlogp(void);
 
    /// Check if a value has been assigned to Other_score data member.
    ///
    /// Data member Other_score is optional;
    /// its type is defined as 'typedef int TOther_score'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOther_score(void) const;
 
    /// Check if it is safe to call GetOther_score method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOther_score(void) const;
 
    /// Reset Other_score data member.
    void ResetOther_score(void);
 
    /// Get the Other_score member data.
    ///
    /// @return
    ///   Copy of the member data.
    TOther_score GetOther_score(void) const;
 
    /// Assign a value to Other_score data member.
    ///
    /// @param value
    ///   Value to assign
    void SetOther_score(TOther_score value);
 
    /// Assign a value to Other_score data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOther_score& SetOther_score(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CAlign_stats_Base(const CAlign_stats_Base&);
    CAlign_stats_Base& operator=(const CAlign_stats_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Descr;
    int m_Scale_factor;
    int m_Vast_score;
    int m_Vast_mlogp;
    int m_Align_res;
    int m_Rmsd;
    int m_Blast_score;
    int m_Blast_mlogp;
    int m_Other_score;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CAlign_stats_Base::IsSetDescr(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetDescr(void) const
{
    return IsSetDescr();
}
 
inline
const CAlign_stats_Base::TDescr& CAlign_stats_Base::GetDescr(void) const
{
    if (!CanGetDescr()) {
        ThrowUnassigned(0);
    }
    return m_Descr;
}
 
inline
void CAlign_stats_Base::SetDescr(const CAlign_stats_Base::TDescr& value)
{
    m_Descr = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CAlign_stats_Base::SetDescr(CAlign_stats_Base::TDescr&& value)
{
    m_Descr = std::forward<CAlign_stats_Base::TDescr>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CAlign_stats_Base::TDescr& CAlign_stats_Base::SetDescr(void)
{
#ifdef _DEBUG
    if (!IsSetDescr()) {
        m_Descr = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Descr;
}
 
inline
bool CAlign_stats_Base::IsSetScale_factor(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetScale_factor(void) const
{
    return IsSetScale_factor();
}
 
inline
void CAlign_stats_Base::ResetScale_factor(void)
{
    m_Scale_factor = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CAlign_stats_Base::TScale_factor CAlign_stats_Base::GetScale_factor(void) const
{
    if (!CanGetScale_factor()) {
        ThrowUnassigned(1);
    }
    return m_Scale_factor;
}
 
inline
void CAlign_stats_Base::SetScale_factor(CAlign_stats_Base::TScale_factor value)
{
    m_Scale_factor = value;
    m_set_State[0] |= 0xc;
}
 
inline
CAlign_stats_Base::TScale_factor& CAlign_stats_Base::SetScale_factor(void)
{
#ifdef _DEBUG
    if (!IsSetScale_factor()) {
        memset(&m_Scale_factor,UnassignedByte(),sizeof(m_Scale_factor));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Scale_factor;
}
 
inline
bool CAlign_stats_Base::IsSetVast_score(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetVast_score(void) const
{
    return IsSetVast_score();
}
 
inline
void CAlign_stats_Base::ResetVast_score(void)
{
    m_Vast_score = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CAlign_stats_Base::TVast_score CAlign_stats_Base::GetVast_score(void) const
{
    if (!CanGetVast_score()) {
        ThrowUnassigned(2);
    }
    return m_Vast_score;
}
 
inline
void CAlign_stats_Base::SetVast_score(CAlign_stats_Base::TVast_score value)
{
    m_Vast_score = value;
    m_set_State[0] |= 0x30;
}
 
inline
CAlign_stats_Base::TVast_score& CAlign_stats_Base::SetVast_score(void)
{
#ifdef _DEBUG
    if (!IsSetVast_score()) {
        memset(&m_Vast_score,UnassignedByte(),sizeof(m_Vast_score));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Vast_score;
}
 
inline
bool CAlign_stats_Base::IsSetVast_mlogp(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetVast_mlogp(void) const
{
    return IsSetVast_mlogp();
}
 
inline
void CAlign_stats_Base::ResetVast_mlogp(void)
{
    m_Vast_mlogp = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CAlign_stats_Base::TVast_mlogp CAlign_stats_Base::GetVast_mlogp(void) const
{
    if (!CanGetVast_mlogp()) {
        ThrowUnassigned(3);
    }
    return m_Vast_mlogp;
}
 
inline
void CAlign_stats_Base::SetVast_mlogp(CAlign_stats_Base::TVast_mlogp value)
{
    m_Vast_mlogp = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CAlign_stats_Base::TVast_mlogp& CAlign_stats_Base::SetVast_mlogp(void)
{
#ifdef _DEBUG
    if (!IsSetVast_mlogp()) {
        memset(&m_Vast_mlogp,UnassignedByte(),sizeof(m_Vast_mlogp));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Vast_mlogp;
}
 
inline
bool CAlign_stats_Base::IsSetAlign_res(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetAlign_res(void) const
{
    return IsSetAlign_res();
}
 
inline
void CAlign_stats_Base::ResetAlign_res(void)
{
    m_Align_res = 0;
    m_set_State[0] &= ~0x300;
}
 
inline
CAlign_stats_Base::TAlign_res CAlign_stats_Base::GetAlign_res(void) const
{
    if (!CanGetAlign_res()) {
        ThrowUnassigned(4);
    }
    return m_Align_res;
}
 
inline
void CAlign_stats_Base::SetAlign_res(CAlign_stats_Base::TAlign_res value)
{
    m_Align_res = value;
    m_set_State[0] |= 0x300;
}
 
inline
CAlign_stats_Base::TAlign_res& CAlign_stats_Base::SetAlign_res(void)
{
#ifdef _DEBUG
    if (!IsSetAlign_res()) {
        memset(&m_Align_res,UnassignedByte(),sizeof(m_Align_res));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Align_res;
}
 
inline
bool CAlign_stats_Base::IsSetRmsd(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetRmsd(void) const
{
    return IsSetRmsd();
}
 
inline
void CAlign_stats_Base::ResetRmsd(void)
{
    m_Rmsd = 0;
    m_set_State[0] &= ~0xc00;
}
 
inline
CAlign_stats_Base::TRmsd CAlign_stats_Base::GetRmsd(void) const
{
    if (!CanGetRmsd()) {
        ThrowUnassigned(5);
    }
    return m_Rmsd;
}
 
inline
void CAlign_stats_Base::SetRmsd(CAlign_stats_Base::TRmsd value)
{
    m_Rmsd = value;
    m_set_State[0] |= 0xc00;
}
 
inline
CAlign_stats_Base::TRmsd& CAlign_stats_Base::SetRmsd(void)
{
#ifdef _DEBUG
    if (!IsSetRmsd()) {
        memset(&m_Rmsd,UnassignedByte(),sizeof(m_Rmsd));
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Rmsd;
}
 
inline
bool CAlign_stats_Base::IsSetBlast_score(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetBlast_score(void) const
{
    return IsSetBlast_score();
}
 
inline
void CAlign_stats_Base::ResetBlast_score(void)
{
    m_Blast_score = 0;
    m_set_State[0] &= ~0x3000;
}
 
inline
CAlign_stats_Base::TBlast_score CAlign_stats_Base::GetBlast_score(void) const
{
    if (!CanGetBlast_score()) {
        ThrowUnassigned(6);
    }
    return m_Blast_score;
}
 
inline
void CAlign_stats_Base::SetBlast_score(CAlign_stats_Base::TBlast_score value)
{
    m_Blast_score = value;
    m_set_State[0] |= 0x3000;
}
 
inline
CAlign_stats_Base::TBlast_score& CAlign_stats_Base::SetBlast_score(void)
{
#ifdef _DEBUG
    if (!IsSetBlast_score()) {
        memset(&m_Blast_score,UnassignedByte(),sizeof(m_Blast_score));
    }
#endif
    m_set_State[0] |= 0x1000;
    return m_Blast_score;
}
 
inline
bool CAlign_stats_Base::IsSetBlast_mlogp(void) const
{
    return ((m_set_State[0] & 0xc000) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetBlast_mlogp(void) const
{
    return IsSetBlast_mlogp();
}
 
inline
void CAlign_stats_Base::ResetBlast_mlogp(void)
{
    m_Blast_mlogp = 0;
    m_set_State[0] &= ~0xc000;
}
 
inline
CAlign_stats_Base::TBlast_mlogp CAlign_stats_Base::GetBlast_mlogp(void) const
{
    if (!CanGetBlast_mlogp()) {
        ThrowUnassigned(7);
    }
    return m_Blast_mlogp;
}
 
inline
void CAlign_stats_Base::SetBlast_mlogp(CAlign_stats_Base::TBlast_mlogp value)
{
    m_Blast_mlogp = value;
    m_set_State[0] |= 0xc000;
}
 
inline
CAlign_stats_Base::TBlast_mlogp& CAlign_stats_Base::SetBlast_mlogp(void)
{
#ifdef _DEBUG
    if (!IsSetBlast_mlogp()) {
        memset(&m_Blast_mlogp,UnassignedByte(),sizeof(m_Blast_mlogp));
    }
#endif
    m_set_State[0] |= 0x4000;
    return m_Blast_mlogp;
}
 
inline
bool CAlign_stats_Base::IsSetOther_score(void) const
{
    return ((m_set_State[0] & 0x30000) != 0);
}
 
inline
bool CAlign_stats_Base::CanGetOther_score(void) const
{
    return IsSetOther_score();
}
 
inline
void CAlign_stats_Base::ResetOther_score(void)
{
    m_Other_score = 0;
    m_set_State[0] &= ~0x30000;
}
 
inline
CAlign_stats_Base::TOther_score CAlign_stats_Base::GetOther_score(void) const
{
    if (!CanGetOther_score()) {
        ThrowUnassigned(8);
    }
    return m_Other_score;
}
 
inline
void CAlign_stats_Base::SetOther_score(CAlign_stats_Base::TOther_score value)
{
    m_Other_score = value;
    m_set_State[0] |= 0x30000;
}
 
inline
CAlign_stats_Base::TOther_score& CAlign_stats_Base::SetOther_score(void)
{
#ifdef _DEBUG
    if (!IsSetOther_score()) {
        memset(&m_Other_score,UnassignedByte(),sizeof(m_Other_score));
    }
#endif
    m_set_State[0] |= 0x10000;
    return m_Other_score;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MMDB3_ALIGN_STATS_BASE_HPP