Entrez2_term_list_.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 Entrez2_term_list_.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/entrez2/entrez2.asn">entrez2.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/entrez2/entrez2.def">entrez2.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_ENTREZ2_ENTREZ2_TERM_LIST_BASE_HPP
#define OBJECTS_ENTREZ2_ENTREZ2_TERM_LIST_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
 
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 CEntrez2_term;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Entrez2
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CEntrez2_term_list_Base --
///
 
class NCBI_ENTREZ2_EXPORT CEntrez2_term_list_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CEntrez2_term_list_Base(void);
    // destructor
    virtual ~CEntrez2_term_list_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TPos;
    typedef int TNum;
    typedef list< CRef< CEntrez2_term > > TList;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_pos,
        e_num,
        e_list
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// position of first term in list
    /// Check if a value has been assigned to Pos data member.
    ///
    /// Data member Pos is mandatory;
    /// its type is defined as 'typedef int TPos'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPos(void) const;
 
    /// Check if it is safe to call GetPos method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPos(void) const;
 
    /// Reset Pos data member.
    void ResetPos(void);
 
    /// Get the Pos member data.
    ///
    /// @return
    ///   Copy of the member data.
    TPos GetPos(void) const;
 
    /// Assign a value to Pos data member.
    ///
    /// @param value
    ///   Value to assign
    void SetPos(TPos value);
 
    /// Assign a value to Pos data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPos& SetPos(void);
 
    /// number of terms in list
    /// Check if a value has been assigned to Num data member.
    ///
    /// Data member Num is mandatory;
    /// its type is defined as 'typedef int TNum'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNum(void) const;
 
    /// Check if it is safe to call GetNum method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNum(void) const;
 
    /// Reset Num data member.
    void ResetNum(void);
 
    /// Get the Num member data.
    ///
    /// @return
    ///   Copy of the member data.
    TNum GetNum(void) const;
 
    /// Assign a value to Num data member.
    ///
    /// @param value
    ///   Value to assign
    void SetNum(TNum value);
 
    /// Assign a value to Num data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNum& SetNum(void);
 
    /// Check if a value has been assigned to List data member.
    ///
    /// Data member List is mandatory;
    /// its type is defined as 'typedef list< CRef< CEntrez2_term > > TList'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetList(void) const;
 
    /// Check if it is safe to call GetList method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetList(void) const;
 
    /// Reset List data member.
    void ResetList(void);
 
    /// Get the List member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TList& GetList(void) const;
 
    /// Assign a value to List data member.
    ///
    /// @return
    ///   Reference to the data value.
    TList& SetList(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CEntrez2_term_list_Base(const CEntrez2_term_list_Base&);
    CEntrez2_term_list_Base& operator=(const CEntrez2_term_list_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Pos;
    int m_Num;
    list< CRef< CEntrez2_term > > m_List;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CEntrez2_term_list_Base::IsSetPos(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CEntrez2_term_list_Base::CanGetPos(void) const
{
    return IsSetPos();
}
 
inline
void CEntrez2_term_list_Base::ResetPos(void)
{
    m_Pos = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CEntrez2_term_list_Base::TPos CEntrez2_term_list_Base::GetPos(void) const
{
    if (!CanGetPos()) {
        ThrowUnassigned(0);
    }
    return m_Pos;
}
 
inline
void CEntrez2_term_list_Base::SetPos(CEntrez2_term_list_Base::TPos value)
{
    m_Pos = value;
    m_set_State[0] |= 0x3;
}
 
inline
CEntrez2_term_list_Base::TPos& CEntrez2_term_list_Base::SetPos(void)
{
#ifdef _DEBUG
    if (!IsSetPos()) {
        memset(&m_Pos,UnassignedByte(),sizeof(m_Pos));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Pos;
}
 
inline
bool CEntrez2_term_list_Base::IsSetNum(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CEntrez2_term_list_Base::CanGetNum(void) const
{
    return IsSetNum();
}
 
inline
void CEntrez2_term_list_Base::ResetNum(void)
{
    m_Num = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CEntrez2_term_list_Base::TNum CEntrez2_term_list_Base::GetNum(void) const
{
    if (!CanGetNum()) {
        ThrowUnassigned(1);
    }
    return m_Num;
}
 
inline
void CEntrez2_term_list_Base::SetNum(CEntrez2_term_list_Base::TNum value)
{
    m_Num = value;
    m_set_State[0] |= 0xc;
}
 
inline
CEntrez2_term_list_Base::TNum& CEntrez2_term_list_Base::SetNum(void)
{
#ifdef _DEBUG
    if (!IsSetNum()) {
        memset(&m_Num,UnassignedByte(),sizeof(m_Num));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Num;
}
 
inline
bool CEntrez2_term_list_Base::IsSetList(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CEntrez2_term_list_Base::CanGetList(void) const
{
    return true;
}
 
inline
const CEntrez2_term_list_Base::TList& CEntrez2_term_list_Base::GetList(void) const
{
    return m_List;
}
 
inline
CEntrez2_term_list_Base::TList& CEntrez2_term_list_Base::SetList(void)
{
    m_set_State[0] |= 0x10;
    return m_List;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_ENTREZ2_ENTREZ2_TERM_LIST_BASE_HPP