Blast_get_searc_info_reply_.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 Blast_get_searc_info_reply_.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/blast/blast.asn">blast.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/blast/blast.def">blast.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_BLAST_BLAST_GET_SEARC_INFO_REPLY_BASE_HPP
#define OBJECTS_BLAST_BLAST_GET_SEARC_INFO_REPLY_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
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 CBlast4_parameters;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Blast4
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CBlast4_get_search_info_reply_Base --
///
 
class NCBI_BLAST_EXPORT CBlast4_get_search_info_reply_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBlast4_get_search_info_reply_Base(void);
    // destructor
    virtual ~CBlast4_get_search_info_reply_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TRequest_id;
    typedef CBlast4_parameters TInfo;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_request_id,
        e_info
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Request_id data member.
    ///
    /// Data member Request_id is mandatory;
    /// its type is defined as 'typedef string TRequest_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRequest_id(void) const;
 
    /// Check if it is safe to call GetRequest_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRequest_id(void) const;
 
    /// Reset Request_id data member.
    void ResetRequest_id(void);
 
    /// Get the Request_id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRequest_id& GetRequest_id(void) const;
 
    /// Assign a value to Request_id data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRequest_id(const TRequest_id& value);
    void SetRequest_id(TRequest_id&& value);
 
    /// Assign a value to Request_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRequest_id& SetRequest_id(void);
 
    /// Check if a value has been assigned to Info data member.
    ///
    /// Data member Info is optional;
    /// its type is defined as 'typedef CBlast4_parameters TInfo'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetInfo(void) const;
 
    /// Check if it is safe to call GetInfo method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetInfo(void) const;
 
    /// Reset Info data member.
    void ResetInfo(void);
 
    /// Get the Info member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TInfo& GetInfo(void) const;
 
    /// Assign a value to Info data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetInfo(TInfo& value);
 
    /// Assign a value to Info data member.
    ///
    /// @return
    ///   Reference to the data value.
    TInfo& SetInfo(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CBlast4_get_search_info_reply_Base(const CBlast4_get_search_info_reply_Base&);
    CBlast4_get_search_info_reply_Base& operator=(const CBlast4_get_search_info_reply_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Request_id;
    CRef< TInfo > m_Info;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CBlast4_get_search_info_reply_Base::IsSetRequest_id(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CBlast4_get_search_info_reply_Base::CanGetRequest_id(void) const
{
    return IsSetRequest_id();
}
 
inline
const CBlast4_get_search_info_reply_Base::TRequest_id& CBlast4_get_search_info_reply_Base::GetRequest_id(void) const
{
    if (!CanGetRequest_id()) {
        ThrowUnassigned(0);
    }
    return m_Request_id;
}
 
inline
void CBlast4_get_search_info_reply_Base::SetRequest_id(const CBlast4_get_search_info_reply_Base::TRequest_id& value)
{
    m_Request_id = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CBlast4_get_search_info_reply_Base::SetRequest_id(CBlast4_get_search_info_reply_Base::TRequest_id&& value)
{
    m_Request_id = std::forward<CBlast4_get_search_info_reply_Base::TRequest_id>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CBlast4_get_search_info_reply_Base::TRequest_id& CBlast4_get_search_info_reply_Base::SetRequest_id(void)
{
#ifdef _DEBUG
    if (!IsSetRequest_id()) {
        m_Request_id = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Request_id;
}
 
inline
bool CBlast4_get_search_info_reply_Base::IsSetInfo(void) const
{
    return m_Info.NotEmpty();
}
 
inline
bool CBlast4_get_search_info_reply_Base::CanGetInfo(void) const
{
    return IsSetInfo();
}
 
inline
const CBlast4_get_search_info_reply_Base::TInfo& CBlast4_get_search_info_reply_Base::GetInfo(void) const
{
    if (!CanGetInfo()) {
        ThrowUnassigned(1);
    }
    return (*m_Info);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_BLAST_BLAST_GET_SEARC_INFO_REPLY_BASE_HPP