ID2S_Bioseq_Info_.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 ID2S_Bioseq_Info_.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/seqsplit/seqsplit.asn">seqsplit.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqsplit/seqsplit.def">seqsplit.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQSPLIT_ID2S_BIOSEQ_INFO_BASE_HPP
#define OBJECTS_SEQSPLIT_ID2S_BIOSEQ_INFO_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_Seq_split
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CID2S_Bioseq_Info_Base --
///
 
class NCBI_ID2_EXPORT CID2S_Bioseq_Info_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CID2S_Bioseq_Info_Base(void);
    // destructor
    virtual ~CID2S_Bioseq_Info_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TGap_count;
    typedef bool TSeq_map_has_ref;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_gap_count,
        e_seq_map_has_ref
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Gap_count data member.
    ///
    /// Data member Gap_count is optional;
    /// its type is defined as 'typedef int TGap_count'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetGap_count(void) const;
 
    /// Check if it is safe to call GetGap_count method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetGap_count(void) const;
 
    /// Reset Gap_count data member.
    void ResetGap_count(void);
 
    /// Get the Gap_count member data.
    ///
    /// @return
    ///   Copy of the member data.
    TGap_count GetGap_count(void) const;
 
    /// Assign a value to Gap_count data member.
    ///
    /// @param value
    ///   Value to assign
    void SetGap_count(TGap_count value);
 
    /// Assign a value to Gap_count data member.
    ///
    /// @return
    ///   Reference to the data value.
    TGap_count& SetGap_count(void);
 
    /// Check if a value has been assigned to Seq_map_has_ref data member.
    ///
    /// Data member Seq_map_has_ref is optional;
    /// its type is defined as 'typedef bool TSeq_map_has_ref'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSeq_map_has_ref(void) const;
 
    /// Check if it is safe to call GetSeq_map_has_ref method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSeq_map_has_ref(void) const;
 
    /// Reset Seq_map_has_ref data member.
    void ResetSeq_map_has_ref(void);
 
    /// Get the Seq_map_has_ref member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSeq_map_has_ref GetSeq_map_has_ref(void) const;
 
    /// Assign a value to Seq_map_has_ref data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSeq_map_has_ref(TSeq_map_has_ref value);
 
    /// Assign a value to Seq_map_has_ref data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSeq_map_has_ref& SetSeq_map_has_ref(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CID2S_Bioseq_Info_Base(const CID2S_Bioseq_Info_Base&);
    CID2S_Bioseq_Info_Base& operator=(const CID2S_Bioseq_Info_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Gap_count;
    bool m_Seq_map_has_ref;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CID2S_Bioseq_Info_Base::IsSetGap_count(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CID2S_Bioseq_Info_Base::CanGetGap_count(void) const
{
    return IsSetGap_count();
}
 
inline
void CID2S_Bioseq_Info_Base::ResetGap_count(void)
{
    m_Gap_count = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CID2S_Bioseq_Info_Base::TGap_count CID2S_Bioseq_Info_Base::GetGap_count(void) const
{
    if (!CanGetGap_count()) {
        ThrowUnassigned(0);
    }
    return m_Gap_count;
}
 
inline
void CID2S_Bioseq_Info_Base::SetGap_count(CID2S_Bioseq_Info_Base::TGap_count value)
{
    m_Gap_count = value;
    m_set_State[0] |= 0x3;
}
 
inline
CID2S_Bioseq_Info_Base::TGap_count& CID2S_Bioseq_Info_Base::SetGap_count(void)
{
#ifdef _DEBUG
    if (!IsSetGap_count()) {
        memset(&m_Gap_count,UnassignedByte(),sizeof(m_Gap_count));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Gap_count;
}
 
inline
bool CID2S_Bioseq_Info_Base::IsSetSeq_map_has_ref(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CID2S_Bioseq_Info_Base::CanGetSeq_map_has_ref(void) const
{
    return IsSetSeq_map_has_ref();
}
 
inline
void CID2S_Bioseq_Info_Base::ResetSeq_map_has_ref(void)
{
    m_Seq_map_has_ref = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CID2S_Bioseq_Info_Base::TSeq_map_has_ref CID2S_Bioseq_Info_Base::GetSeq_map_has_ref(void) const
{
    if (!CanGetSeq_map_has_ref()) {
        ThrowUnassigned(1);
    }
    return m_Seq_map_has_ref;
}
 
inline
void CID2S_Bioseq_Info_Base::SetSeq_map_has_ref(CID2S_Bioseq_Info_Base::TSeq_map_has_ref value)
{
    m_Seq_map_has_ref = value;
    m_set_State[0] |= 0xc;
}
 
inline
CID2S_Bioseq_Info_Base::TSeq_map_has_ref& CID2S_Bioseq_Info_Base::SetSeq_map_has_ref(void)
{
#ifdef _DEBUG
    if (!IsSetSeq_map_has_ref()) {
        memset(&m_Seq_map_has_ref,UnassignedByte(),sizeof(m_Seq_map_has_ref));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Seq_map_has_ref;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQSPLIT_ID2S_BIOSEQ_INFO_BASE_HPP