DataBankList_.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 DataBankList_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/efetch.xsd">efetch.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/efetch.def">efetch.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef eutils__OBJTOOLS_EUTILS_EFETCH_DATABANKLIST_BASE_HPP
#define eutils__OBJTOOLS_EUTILS_EFETCH_DATABANKLIST_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
 
#ifndef BEGIN_eutils_SCOPE
#  define BEGIN_eutils_SCOPE BEGIN_SCOPE(eutils)
#  define END_eutils_SCOPE END_SCOPE(eutils)
#endif
BEGIN_eutils_SCOPE // namespace eutils::
 
 
// forward declarations
class CDataBank;
 
 
// generated classes
 
 
/** @addtogroup dataspec_efetch
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CDataBankList_Base --
///
 
class CDataBankList_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CDataBankList_Base(void);
    // destructor
    virtual ~CDataBankList_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class C_Attlist : public NCBI_NS_NCBI::CSerialObject
    {
        typedef NCBI_NS_NCBI::CSerialObject Tparent;
    public:
        // constructor
        C_Attlist(void);
        // destructor
        ~C_Attlist(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        enum EAttlist_CompleteYN {
            eAttlist_CompleteYN_Y = 1,
            eAttlist_CompleteYN_N = 2
        };
        
        /// Access to EAttlist_CompleteYN's attributes (values, names) as defined in spec
        static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_CompleteYN)(void);
        
        // types
        typedef EAttlist_CompleteYN TCompleteYN;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_CompleteYN
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 2> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to CompleteYN data member.
        ///
        /// Data member CompleteYN is optional with default eAttlist_CompleteYN_Y;
        /// its type is defined as 'typedef EAttlist_CompleteYN TCompleteYN'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetCompleteYN(void) const;
    
        /// Check if it is safe to call GetCompleteYN method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetCompleteYN(void) const;
    
        /// Reset CompleteYN data member.
        void ResetCompleteYN(void);
    
        /// Assign default value to CompleteYN data member.
        void SetDefaultCompleteYN(void);
    
        /// Get the CompleteYN member data.
        ///
        /// @return
        ///   Copy of the member data.
        TCompleteYN GetCompleteYN(void) const;
    
        /// Assign a value to CompleteYN data member.
        ///
        /// @param value
        ///   Value to assign
        void SetCompleteYN(TCompleteYN value);
    
        /// Assign a value to CompleteYN data member.
        ///
        /// @return
        ///   Reference to the data value.
        TCompleteYN& SetCompleteYN(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Attlist(const C_Attlist&);
        C_Attlist& operator=(const C_Attlist&);
    
        // data
        Uint4 m_set_State[1];
        EAttlist_CompleteYN m_CompleteYN;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CDataBank > > TDataBank;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_DataBank
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Attlist data member.
    ///
    /// Data member Attlist is mandatory;
    /// its type is defined as 'typedef C_Attlist TAttlist'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAttlist(void) const;
 
    /// Check if it is safe to call GetAttlist method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAttlist(void) const;
 
    /// Reset Attlist data member.
    void ResetAttlist(void);
 
    /// Get the Attlist member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAttlist& GetAttlist(void) const;
 
    /// Assign a value to Attlist data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAttlist(TAttlist& value);
 
    /// Assign a value to Attlist data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAttlist& SetAttlist(void);
 
    /// Check if a value has been assigned to DataBank data member.
    ///
    /// Data member DataBank is mandatory;
    /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CDataBank > > TDataBank'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDataBank(void) const;
 
    /// Check if it is safe to call GetDataBank method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDataBank(void) const;
 
    /// Reset DataBank data member.
    void ResetDataBank(void);
 
    /// Get the DataBank member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDataBank& GetDataBank(void) const;
 
    /// Assign a value to DataBank data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDataBank& SetDataBank(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CDataBankList_Base(const CDataBankList_Base&);
    CDataBankList_Base& operator=(const CDataBankList_Base&);
 
    // data
    Uint4 m_set_State[1];
    NCBI_NS_NCBI::CRef< TAttlist > m_Attlist;
    NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CDataBank > > m_DataBank;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CDataBankList_Base::C_Attlist::IsSetCompleteYN(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CDataBankList_Base::C_Attlist::CanGetCompleteYN(void) const
{
    return true;
}
 
inline
void CDataBankList_Base::C_Attlist::ResetCompleteYN(void)
{
    m_CompleteYN = eAttlist_CompleteYN_Y;
    m_set_State[0] &= ~0x3;
}
 
inline
void CDataBankList_Base::C_Attlist::SetDefaultCompleteYN(void)
{
    ResetCompleteYN();
    m_set_State[0] |= 0x1;
}
 
inline
CDataBankList_Base::C_Attlist::TCompleteYN CDataBankList_Base::C_Attlist::GetCompleteYN(void) const
{
    return m_CompleteYN;
}
 
inline
void CDataBankList_Base::C_Attlist::SetCompleteYN(CDataBankList_Base::C_Attlist::TCompleteYN value)
{
    m_CompleteYN = value;
    m_set_State[0] |= 0x3;
}
 
inline
CDataBankList_Base::C_Attlist::TCompleteYN& CDataBankList_Base::C_Attlist::SetCompleteYN(void)
{
#ifdef _DEBUG
    if (!IsSetCompleteYN()) {
        memset(&m_CompleteYN,UnassignedByte(),sizeof(m_CompleteYN));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_CompleteYN;
}
 
inline
bool CDataBankList_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CDataBankList_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CDataBankList_Base::TAttlist& CDataBankList_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CDataBankList_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CDataBankList_Base::TAttlist& CDataBankList_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CDataBankList_Base::IsSetDataBank(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CDataBankList_Base::CanGetDataBank(void) const
{
    return true;
}
 
inline
const CDataBankList_Base::TDataBank& CDataBankList_Base::GetDataBank(void) const
{
    return m_DataBank;
}
 
inline
CDataBankList_Base::TDataBank& CDataBankList_Base::SetDataBank(void)
{
    m_set_State[0] |= 0x4;
    return m_DataBank;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_eutils_SCOPE // namespace eutils::
 
 
#endif // eutils__OBJTOOLS_EUTILS_EFETCH_DATABANKLIST_BASE_HPP