db_env_.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: Db_Env_.hpp,v $
 * PRODUCTION Revision 1000.1  2004/04/12 17:19:22  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [CATCHUP_003] Dev-tree R1.5
 * PRODUCTION
 * ===========================================================================
 */

/* $Id: Db_Env_.hpp,v 1000.1 2004/04/12 17:19:22 gouriano Exp $
 * ===========================================================================
 *
 *                            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 Description:
 *   This code is generated by application DATATOOL
 *   using specifications from the data definition file
 *   'twebenv.asn'.
 *
 * ATTENTION:
 *   Don't edit or check-in this file to the CVS as this file will
 *   be overridden (by DATATOOL) without warning!
 * ===========================================================================
 */

#ifndef DB_ENV_BASE_HPP
#define DB_ENV_BASE_HPP

// standard includes
#include <serial/serialbase.hpp>

// generated includes
#include <list>
#include <string>


// forward declarations
class CArgument;
class CDb_Clipboard;
class CFilter_Value;


// generated classes

class CDb_Env_Base : public ncbi::CSerialObject
{
    typedef ncbi::CSerialObject Tparent;
public:
    // constructor
    CDb_Env_Base(void);
    // destructor
    virtual ~CDb_Env_Base(void);

    // type info
    DECLARE_INTERNAL_TYPE_INFO();

    // types
    typedef std::string TName;
    typedef std::list< ncbi::CRef< CArgument > > TArguments;
    typedef std::list< ncbi::CRef< CFilter_Value > > TFilters;
    typedef std::list< ncbi::CRef< CDb_Clipboard > > TClipboard;

    // getters
    // setters

    // mandatory
    // typedef std::string TName
    bool IsSetName(void) const;
    bool CanGetName(void) const;
    void ResetName(void);
    const TName& GetName(void) const;
    void SetName(const TName& value);
    TName& SetName(void);

    // optional
    // typedef std::list< ncbi::CRef< CArgument > > TArguments
    bool IsSetArguments(void) const;
    bool CanGetArguments(void) const;
    void ResetArguments(void);
    const TArguments& GetArguments(void) const;
    TArguments& SetArguments(void);

    // optional
    // typedef std::list< ncbi::CRef< CFilter_Value > > TFilters
    bool IsSetFilters(void) const;
    bool CanGetFilters(void) const;
    void ResetFilters(void);
    const TFilters& GetFilters(void) const;
    TFilters& SetFilters(void);

    // optional
    // typedef std::list< ncbi::CRef< CDb_Clipboard > > TClipboard
    bool IsSetClipboard(void) const;
    bool CanGetClipboard(void) const;
    void ResetClipboard(void);
    const TClipboard& GetClipboard(void) const;
    TClipboard& SetClipboard(void);

    // reset whole object
    virtual void Reset(void);


private:
    // Prohibit copy constructor and assignment operator
    CDb_Env_Base(const CDb_Env_Base&);
    CDb_Env_Base& operator=(const CDb_Env_Base&);

    // data
    Uint4 m_set_State[1];
    TName m_Name;
    TArguments m_Arguments;
    TFilters m_Filters;
    TClipboard m_Clipboard;
};






///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CDb_Env_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}

inline
bool CDb_Env_Base::CanGetName(void) const
{
    return IsSetName();
}

inline
const std::string& CDb_Env_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(0);
    }
    return m_Name;
}

inline
void CDb_Env_Base::SetName(const std::string& value)
{
    m_Name = value;
    m_set_State[0] |= 0x3;
}

inline
std::string& CDb_Env_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = ms_UnassignedStr;
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Name;
}

inline
bool CDb_Env_Base::IsSetArguments(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}

inline
bool CDb_Env_Base::CanGetArguments(void) const
{
    return true;
}

inline
const std::list< ncbi::CRef< CArgument > >& CDb_Env_Base::GetArguments(void) const
{
    return m_Arguments;
}

inline
std::list< ncbi::CRef< CArgument > >& CDb_Env_Base::SetArguments(void)
{
    m_set_State[0] |= 0x4;
    return m_Arguments;
}

inline
bool CDb_Env_Base::IsSetFilters(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}

inline
bool CDb_Env_Base::CanGetFilters(void) const
{
    return true;
}

inline
const std::list< ncbi::CRef< CFilter_Value > >& CDb_Env_Base::GetFilters(void) const
{
    return m_Filters;
}

inline
std::list< ncbi::CRef< CFilter_Value > >& CDb_Env_Base::SetFilters(void)
{
    m_set_State[0] |= 0x10;
    return m_Filters;
}

inline
bool CDb_Env_Base::IsSetClipboard(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}

inline
bool CDb_Env_Base::CanGetClipboard(void) const
{
    return true;
}

inline
const std::list< ncbi::CRef< CDb_Clipboard > >& CDb_Env_Base::GetClipboard(void) const
{
    return m_Clipboard;
}

inline
std::list< ncbi::CRef< CDb_Clipboard > >& CDb_Env_Base::SetClipboard(void)
{
    m_set_State[0] |= 0x40;
    return m_Clipboard;
}

///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////






#endif // DB_ENV_BASE_HPP