ID2S_Seq_descr_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_Seq_descr_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_SEQ_DESCR_INFO_BASE_HPP
#define OBJECTS_SEQSPLIT_ID2S_SEQ_DESCR_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::
 
 
// forward declarations
class CID2S_Bioseq_Ids;
class CID2S_Bioseq_set_Ids;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Seq_split
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CID2S_Seq_descr_Info_Base --
///
 
class NCBI_ID2_EXPORT CID2S_Seq_descr_Info_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CID2S_Seq_descr_Info_Base(void);
    // destructor
    virtual ~CID2S_Seq_descr_Info_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef unsigned TType_mask;
    typedef CID2S_Bioseq_Ids TBioseqs;
    typedef CID2S_Bioseq_set_Ids TBioseq_sets;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_type_mask,
        e_bioseqs,
        e_bioseq_sets
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// mask of Seq-descr types,
    /// Check if a value has been assigned to Type_mask data member.
    ///
    /// Data member Type_mask is mandatory;
    /// its type is defined as 'typedef unsigned TType_mask'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetType_mask(void) const;
 
    /// Check if it is safe to call GetType_mask method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetType_mask(void) const;
 
    /// Reset Type_mask data member.
    void ResetType_mask(void);
 
    /// Get the Type_mask member data.
    ///
    /// @return
    ///   Copy of the member data.
    TType_mask GetType_mask(void) const;
 
    /// Assign a value to Type_mask data member.
    ///
    /// @param value
    ///   Value to assign
    void SetType_mask(TType_mask value);
 
    /// Assign a value to Type_mask data member.
    ///
    /// @return
    ///   Reference to the data value.
    TType_mask& SetType_mask(void);
 
    /// Check if a value has been assigned to Bioseqs data member.
    ///
    /// Data member Bioseqs is optional;
    /// its type is defined as 'typedef CID2S_Bioseq_Ids TBioseqs'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBioseqs(void) const;
 
    /// Check if it is safe to call GetBioseqs method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBioseqs(void) const;
 
    /// Reset Bioseqs data member.
    void ResetBioseqs(void);
 
    /// Get the Bioseqs member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBioseqs& GetBioseqs(void) const;
 
    /// Assign a value to Bioseqs data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetBioseqs(TBioseqs& value);
 
    /// Assign a value to Bioseqs data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBioseqs& SetBioseqs(void);
 
    /// Check if a value has been assigned to Bioseq_sets data member.
    ///
    /// Data member Bioseq_sets is optional;
    /// its type is defined as 'typedef CID2S_Bioseq_set_Ids TBioseq_sets'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBioseq_sets(void) const;
 
    /// Check if it is safe to call GetBioseq_sets method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBioseq_sets(void) const;
 
    /// Reset Bioseq_sets data member.
    void ResetBioseq_sets(void);
 
    /// Get the Bioseq_sets member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBioseq_sets& GetBioseq_sets(void) const;
 
    /// Assign a value to Bioseq_sets data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetBioseq_sets(TBioseq_sets& value);
 
    /// Assign a value to Bioseq_sets data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBioseq_sets& SetBioseq_sets(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CID2S_Seq_descr_Info_Base(const CID2S_Seq_descr_Info_Base&);
    CID2S_Seq_descr_Info_Base& operator=(const CID2S_Seq_descr_Info_Base&);
 
    // data
    Uint4 m_set_State[1];
    unsigned m_Type_mask;
    CRef< TBioseqs > m_Bioseqs;
    CRef< TBioseq_sets > m_Bioseq_sets;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CID2S_Seq_descr_Info_Base::IsSetType_mask(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CID2S_Seq_descr_Info_Base::CanGetType_mask(void) const
{
    return IsSetType_mask();
}
 
inline
void CID2S_Seq_descr_Info_Base::ResetType_mask(void)
{
    m_Type_mask = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CID2S_Seq_descr_Info_Base::TType_mask CID2S_Seq_descr_Info_Base::GetType_mask(void) const
{
    if (!CanGetType_mask()) {
        ThrowUnassigned(0);
    }
    return m_Type_mask;
}
 
inline
void CID2S_Seq_descr_Info_Base::SetType_mask(CID2S_Seq_descr_Info_Base::TType_mask value)
{
    m_Type_mask = value;
    m_set_State[0] |= 0x3;
}
 
inline
CID2S_Seq_descr_Info_Base::TType_mask& CID2S_Seq_descr_Info_Base::SetType_mask(void)
{
#ifdef _DEBUG
    if (!IsSetType_mask()) {
        memset(&m_Type_mask,UnassignedByte(),sizeof(m_Type_mask));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Type_mask;
}
 
inline
bool CID2S_Seq_descr_Info_Base::IsSetBioseqs(void) const
{
    return m_Bioseqs.NotEmpty();
}
 
inline
bool CID2S_Seq_descr_Info_Base::CanGetBioseqs(void) const
{
    return IsSetBioseqs();
}
 
inline
const CID2S_Seq_descr_Info_Base::TBioseqs& CID2S_Seq_descr_Info_Base::GetBioseqs(void) const
{
    if (!CanGetBioseqs()) {
        ThrowUnassigned(1);
    }
    return (*m_Bioseqs);
}
 
inline
bool CID2S_Seq_descr_Info_Base::IsSetBioseq_sets(void) const
{
    return m_Bioseq_sets.NotEmpty();
}
 
inline
bool CID2S_Seq_descr_Info_Base::CanGetBioseq_sets(void) const
{
    return IsSetBioseq_sets();
}
 
inline
const CID2S_Seq_descr_Info_Base::TBioseq_sets& CID2S_Seq_descr_Info_Base::GetBioseq_sets(void) const
{
    if (!CanGetBioseq_sets()) {
        ThrowUnassigned(2);
    }
    return (*m_Bioseq_sets);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQSPLIT_ID2S_SEQ_DESCR_INFO_BASE_HPP