Result_.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 Result_.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/egquery/egquery.dtd">egquery.dtd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/egquery/egquery.def">egquery.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef egquery__OBJTOOLS_EUTILS_EGQUERY_RESULT_BASE_HPP
#define egquery__OBJTOOLS_EUTILS_EGQUERY_RESULT_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
#ifndef BEGIN_egquery_SCOPE
#  define BEGIN_egquery_SCOPE BEGIN_SCOPE(egquery)
#  define END_egquery_SCOPE END_SCOPE(egquery)
#endif
BEGIN_egquery_SCOPE // namespace egquery::
 
 
// forward declarations
class CEGQueryResult;
 
 
// generated classes
 
 
/** @addtogroup dataspec_egquery
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CResult_Base --
///
 
class NCBI_EUTILS_EXPORT CResult_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CResult_Base(void);
    // destructor
    virtual ~CResult_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef NCBI_NS_STD::string TTerm;
    typedef CEGQueryResult TEGQueryResult;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Term,
        e_eGQueryResult
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// .+ 
    /// Check if a value has been assigned to Term data member.
    ///
    /// Data member Term is mandatory;
    /// its type is defined as 'typedef NCBI_NS_STD::string TTerm'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTerm(void) const;
 
    /// Check if it is safe to call GetTerm method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTerm(void) const;
 
    /// Reset Term data member.
    void ResetTerm(void);
 
    /// Get the Term member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTerm& GetTerm(void) const;
 
    /// Assign a value to Term data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTerm(const TTerm& value);
    void SetTerm(TTerm&& value);
 
    /// Assign a value to Term data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTerm& SetTerm(void);
 
    /// Check if a value has been assigned to EGQueryResult data member.
    ///
    /// Data member EGQueryResult is mandatory;
    /// its type is defined as 'typedef CEGQueryResult TEGQueryResult'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetEGQueryResult(void) const;
 
    /// Check if it is safe to call GetEGQueryResult method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetEGQueryResult(void) const;
 
    /// Reset EGQueryResult data member.
    void ResetEGQueryResult(void);
 
    /// Get the EGQueryResult member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TEGQueryResult& GetEGQueryResult(void) const;
 
    /// Assign a value to EGQueryResult data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetEGQueryResult(TEGQueryResult& value);
 
    /// Assign a value to EGQueryResult data member.
    ///
    /// @return
    ///   Reference to the data value.
    TEGQueryResult& SetEGQueryResult(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CResult_Base(const CResult_Base&);
    CResult_Base& operator=(const CResult_Base&);
 
    // data
    Uint4 m_set_State[1];
    NCBI_NS_STD::string m_Term;
    NCBI_NS_NCBI::CRef< TEGQueryResult > m_EGQueryResult;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CResult_Base::IsSetTerm(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CResult_Base::CanGetTerm(void) const
{
    return IsSetTerm();
}
 
inline
const CResult_Base::TTerm& CResult_Base::GetTerm(void) const
{
    if (!CanGetTerm()) {
        ThrowUnassigned(0);
    }
    return m_Term;
}
 
inline
void CResult_Base::SetTerm(const CResult_Base::TTerm& value)
{
    m_Term = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CResult_Base::SetTerm(CResult_Base::TTerm&& value)
{
    m_Term = std::forward<CResult_Base::TTerm>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CResult_Base::TTerm& CResult_Base::SetTerm(void)
{
#ifdef _DEBUG
    if (!IsSetTerm()) {
        m_Term = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Term;
}
 
inline
bool CResult_Base::IsSetEGQueryResult(void) const
{
    return m_EGQueryResult.NotEmpty();
}
 
inline
bool CResult_Base::CanGetEGQueryResult(void) const
{
    return true;
}
 
inline
const CResult_Base::TEGQueryResult& CResult_Base::GetEGQueryResult(void) const
{
    if ( !m_EGQueryResult ) {
        const_cast<CResult_Base*>(this)->ResetEGQueryResult();
    }
    return (*m_EGQueryResult);
}
 
inline
CResult_Base::TEGQueryResult& CResult_Base::SetEGQueryResult(void)
{
    if ( !m_EGQueryResult ) {
        ResetEGQueryResult();
    }
    return (*m_EGQueryResult);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_egquery_SCOPE // namespace egquery::
 
 
#endif // egquery__OBJTOOLS_EUTILS_EGQUERY_RESULT_BASE_HPP