ChemicalList_.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 ChemicalList_.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_CHEMICALLIST_BASE_HPP
#define eutils__OBJTOOLS_EUTILS_EFETCH_CHEMICALLIST_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 CChemical;
 
 
// generated classes
 
 
/** @addtogroup dataspec_efetch
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CChemicalList_Base --
///
 
class CChemicalList_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CChemicalList_Base(void);
    // destructor
    virtual ~CChemicalList_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CChemical C_E;
    typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CChemical > > TChemical;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Chemical
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 2> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Chemical data member.
    ///
    /// Data member Chemical is mandatory;
    /// its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CChemical > > TChemical'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetChemical(void) const;
 
    /// Check if it is safe to call GetChemical method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetChemical(void) const;
 
    /// Reset Chemical data member.
    void ResetChemical(void);
 
    /// Get the Chemical member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TChemical& GetChemical(void) const;
 
    /// Assign a value to Chemical data member.
    ///
    /// @return
    ///   Reference to the data value.
    TChemical& SetChemical(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CChemicalList_Base(const CChemicalList_Base&);
    CChemicalList_Base& operator=(const CChemicalList_Base&);
 
    // data
    Uint4 m_set_State[1];
    NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< CChemical > > m_Chemical;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CChemicalList_Base::IsSetChemical(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CChemicalList_Base::CanGetChemical(void) const
{
    return true;
}
 
inline
const CChemicalList_Base::TChemical& CChemicalList_Base::GetChemical(void) const
{
    return m_Chemical;
}
 
inline
CChemicalList_Base::TChemical& CChemicalList_Base::SetChemical(void)
{
    m_set_State[0] |= 0x1;
    return m_Chemical;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_eutils_SCOPE // namespace eutils::
 
 
#endif // eutils__OBJTOOLS_EUTILS_EFETCH_CHEMICALLIST_BASE_HPP