Blast4_ka_block_.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 Blast4_ka_block_.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/blast/blast.asn">blast.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blast/blast.def">blast.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_BLAST_BLAST4_KA_BLOCK_BASE_HPP
#define OBJECTS_BLAST_BLAST4_KA_BLOCK_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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Blast4
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CBlast4_ka_block_Base --
///
 
class NCBI_BLAST_EXPORT CBlast4_ka_block_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBlast4_ka_block_Base(void);
    // destructor
    virtual ~CBlast4_ka_block_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef double TLambda;
    typedef double TK;
    typedef double TH;
    typedef bool TGapped;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_lambda,
        e_k,
        e_h,
        e_gapped
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Lambda data member.
    ///
    /// Data member Lambda is mandatory;
    /// its type is defined as 'typedef double TLambda'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLambda(void) const;
 
    /// Check if it is safe to call GetLambda method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLambda(void) const;
 
    /// Reset Lambda data member.
    void ResetLambda(void);
 
    /// Get the Lambda member data.
    ///
    /// @return
    ///   Copy of the member data.
    TLambda GetLambda(void) const;
 
    /// Assign a value to Lambda data member.
    ///
    /// @param value
    ///   Value to assign
    void SetLambda(TLambda value);
 
    /// Assign a value to Lambda data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLambda& SetLambda(void);
 
    /// Check if a value has been assigned to K data member.
    ///
    /// Data member K is mandatory;
    /// its type is defined as 'typedef double TK'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetK(void) const;
 
    /// Check if it is safe to call GetK method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetK(void) const;
 
    /// Reset K data member.
    void ResetK(void);
 
    /// Get the K member data.
    ///
    /// @return
    ///   Copy of the member data.
    TK GetK(void) const;
 
    /// Assign a value to K data member.
    ///
    /// @param value
    ///   Value to assign
    void SetK(TK value);
 
    /// Assign a value to K data member.
    ///
    /// @return
    ///   Reference to the data value.
    TK& SetK(void);
 
    /// Check if a value has been assigned to H data member.
    ///
    /// Data member H is mandatory;
    /// its type is defined as 'typedef double TH'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetH(void) const;
 
    /// Check if it is safe to call GetH method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetH(void) const;
 
    /// Reset H data member.
    void ResetH(void);
 
    /// Get the H member data.
    ///
    /// @return
    ///   Copy of the member data.
    TH GetH(void) const;
 
    /// Assign a value to H data member.
    ///
    /// @param value
    ///   Value to assign
    void SetH(TH value);
 
    /// Assign a value to H data member.
    ///
    /// @return
    ///   Reference to the data value.
    TH& SetH(void);
 
    /// Check if a value has been assigned to Gapped data member.
    ///
    /// Data member Gapped is mandatory;
    /// its type is defined as 'typedef bool TGapped'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetGapped(void) const;
 
    /// Check if it is safe to call GetGapped method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetGapped(void) const;
 
    /// Reset Gapped data member.
    void ResetGapped(void);
 
    /// Get the Gapped member data.
    ///
    /// @return
    ///   Copy of the member data.
    TGapped GetGapped(void) const;
 
    /// Assign a value to Gapped data member.
    ///
    /// @param value
    ///   Value to assign
    void SetGapped(TGapped value);
 
    /// Assign a value to Gapped data member.
    ///
    /// @return
    ///   Reference to the data value.
    TGapped& SetGapped(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CBlast4_ka_block_Base(const CBlast4_ka_block_Base&);
    CBlast4_ka_block_Base& operator=(const CBlast4_ka_block_Base&);
 
    // data
    Uint4 m_set_State[1];
    double m_Lambda;
    double m_K;
    double m_H;
    bool m_Gapped;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CBlast4_ka_block_Base::IsSetLambda(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CBlast4_ka_block_Base::CanGetLambda(void) const
{
    return IsSetLambda();
}
 
inline
void CBlast4_ka_block_Base::ResetLambda(void)
{
    m_Lambda = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CBlast4_ka_block_Base::TLambda CBlast4_ka_block_Base::GetLambda(void) const
{
    if (!CanGetLambda()) {
        ThrowUnassigned(0);
    }
    return m_Lambda;
}
 
inline
void CBlast4_ka_block_Base::SetLambda(CBlast4_ka_block_Base::TLambda value)
{
    m_Lambda = value;
    m_set_State[0] |= 0x3;
}
 
inline
CBlast4_ka_block_Base::TLambda& CBlast4_ka_block_Base::SetLambda(void)
{
#ifdef _DEBUG
    if (!IsSetLambda()) {
        memset(&m_Lambda,UnassignedByte(),sizeof(m_Lambda));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Lambda;
}
 
inline
bool CBlast4_ka_block_Base::IsSetK(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CBlast4_ka_block_Base::CanGetK(void) const
{
    return IsSetK();
}
 
inline
void CBlast4_ka_block_Base::ResetK(void)
{
    m_K = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CBlast4_ka_block_Base::TK CBlast4_ka_block_Base::GetK(void) const
{
    if (!CanGetK()) {
        ThrowUnassigned(1);
    }
    return m_K;
}
 
inline
void CBlast4_ka_block_Base::SetK(CBlast4_ka_block_Base::TK value)
{
    m_K = value;
    m_set_State[0] |= 0xc;
}
 
inline
CBlast4_ka_block_Base::TK& CBlast4_ka_block_Base::SetK(void)
{
#ifdef _DEBUG
    if (!IsSetK()) {
        memset(&m_K,UnassignedByte(),sizeof(m_K));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_K;
}
 
inline
bool CBlast4_ka_block_Base::IsSetH(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CBlast4_ka_block_Base::CanGetH(void) const
{
    return IsSetH();
}
 
inline
void CBlast4_ka_block_Base::ResetH(void)
{
    m_H = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CBlast4_ka_block_Base::TH CBlast4_ka_block_Base::GetH(void) const
{
    if (!CanGetH()) {
        ThrowUnassigned(2);
    }
    return m_H;
}
 
inline
void CBlast4_ka_block_Base::SetH(CBlast4_ka_block_Base::TH value)
{
    m_H = value;
    m_set_State[0] |= 0x30;
}
 
inline
CBlast4_ka_block_Base::TH& CBlast4_ka_block_Base::SetH(void)
{
#ifdef _DEBUG
    if (!IsSetH()) {
        memset(&m_H,UnassignedByte(),sizeof(m_H));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_H;
}
 
inline
bool CBlast4_ka_block_Base::IsSetGapped(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CBlast4_ka_block_Base::CanGetGapped(void) const
{
    return IsSetGapped();
}
 
inline
void CBlast4_ka_block_Base::ResetGapped(void)
{
    m_Gapped = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CBlast4_ka_block_Base::TGapped CBlast4_ka_block_Base::GetGapped(void) const
{
    if (!CanGetGapped()) {
        ThrowUnassigned(3);
    }
    return m_Gapped;
}
 
inline
void CBlast4_ka_block_Base::SetGapped(CBlast4_ka_block_Base::TGapped value)
{
    m_Gapped = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CBlast4_ka_block_Base::TGapped& CBlast4_ka_block_Base::SetGapped(void)
{
#ifdef _DEBUG
    if (!IsSetGapped()) {
        memset(&m_Gapped,UnassignedByte(),sizeof(m_Gapped));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Gapped;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_BLAST_BLAST4_KA_BLOCK_BASE_HPP