Blast4_reply_body_.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 Blast4_reply_body_.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_BLAST4_REPLY_BODY_BASE_HPP
#define OBJECTS_BLAST_BLAST4_REPLY_BODY_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
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_finish_params_reply;
class CBlast4_get_databases_ex_reply;
class CBlast4_get_databases_reply;
class CBlast4_get_matrices_reply;
class CBlast4_get_parameters_reply;
class CBlast4_get_paramsets_reply;
class CBlast4_get_programs_reply;
class CBlast4_get_protocol_info_reply;
class CBlast4_get_queries_reply;
class CBlast4_get_request_info_reply;
class CBlast4_get_search_info_reply;
class CBlast4_get_search_results_reply;
class CBlast4_get_seq_parts_reply;
class CBlast4_get_sequences_reply;
class CBlast4_get_windowmasked_taxids_reply;
class CBlast4_queue_search_reply;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Blast4
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CBlast4_reply_body_Base --
///
 
class NCBI_BLAST_EXPORT CBlast4_reply_body_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBlast4_reply_body_Base(void);
    // destructor
    virtual ~CBlast4_reply_body_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,              ///< No variant selected
        e_Finish_params,
        e_Get_databases,
        e_Get_matrices,
        e_Get_parameters,
        e_Get_paramsets,
        e_Get_programs,
        e_Get_search_results,
        e_Get_sequences,
        e_Queue_search,
        e_Get_queries,
        e_Get_request_info,
        e_Get_sequence_parts,
        e_Get_windowmasked_taxids,
        e_Get_protocol_info,
        e_Get_search_info,
        e_Get_databases_ex
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 17 ///< == e_Get_databases_ex+1
    };
 
    /// Reset the whole object
    virtual void Reset(void);
 
    /// Reset the selection (set it to e_not_set).
    virtual void ResetSelection(void);
 
    /// Which variant is currently selected.
    ///
    /// @return
    ///   Choice state enumerator.
    E_Choice Which(void) const;
 
    /// Verify selection, throw exception if it differs from the expected.
    ///
    /// @param index
    ///   Expected selection.
    void CheckSelected(E_Choice index) const;
 
    /// Throw 'InvalidSelection' exception.
    ///
    /// @param index
    ///   Expected selection.
    NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
 
    /// Retrieve selection name (for diagnostic purposes).
    ///
    /// @param index
    ///   One of possible selection states.
    /// @return
    ///   Name string.
    static string SelectionName(E_Choice index);
 
    /// Select the requested variant if needed.
    ///
    /// @param index
    ///   New selection state.
    /// @param reset
    ///   Flag that defines the resetting of the variant data. The data will
    ///   be reset if either the current selection differs from the new one,
    ///   or the flag is set to eDoResetVariant.
    void Select(E_Choice index, EResetVariant reset = eDoResetVariant);
    /// Select the requested variant if needed,
    /// allocating CObject variants from memory pool.
    void Select(E_Choice index,
                EResetVariant reset,
                CObjectMemoryPool* pool);
 
    // types
    typedef CBlast4_finish_params_reply TFinish_params;
    typedef CBlast4_get_databases_reply TGet_databases;
    typedef CBlast4_get_matrices_reply TGet_matrices;
    typedef CBlast4_get_parameters_reply TGet_parameters;
    typedef CBlast4_get_paramsets_reply TGet_paramsets;
    typedef CBlast4_get_programs_reply TGet_programs;
    typedef CBlast4_get_search_results_reply TGet_search_results;
    typedef CBlast4_get_sequences_reply TGet_sequences;
    typedef CBlast4_queue_search_reply TQueue_search;
    typedef CBlast4_get_queries_reply TGet_queries;
    typedef CBlast4_get_request_info_reply TGet_request_info;
    typedef CBlast4_get_seq_parts_reply TGet_sequence_parts;
    typedef CBlast4_get_windowmasked_taxids_reply TGet_windowmasked_taxids;
    typedef CBlast4_get_protocol_info_reply TGet_protocol_info;
    typedef CBlast4_get_search_info_reply TGet_search_info;
    typedef CBlast4_get_databases_ex_reply TGet_databases_ex;
 
    // getters
    // setters
 
 
    /// Check if variant Finish_params is selected.
    ///
    /// Finish_params type is defined as 'typedef CBlast4_finish_params_reply TFinish_params'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsFinish_params(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TFinish_params& GetFinish_params(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TFinish_params& SetFinish_params(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetFinish_params(TFinish_params& value);
 
 
    /// Check if variant Get_databases is selected.
    ///
    /// Get_databases type is defined as 'typedef CBlast4_get_databases_reply TGet_databases'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_databases(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_databases& GetGet_databases(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_databases& SetGet_databases(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_databases(TGet_databases& value);
 
 
    /// Check if variant Get_matrices is selected.
    ///
    /// Get_matrices type is defined as 'typedef CBlast4_get_matrices_reply TGet_matrices'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_matrices(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_matrices& GetGet_matrices(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_matrices& SetGet_matrices(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_matrices(TGet_matrices& value);
 
 
    /// Check if variant Get_parameters is selected.
    ///
    /// Get_parameters type is defined as 'typedef CBlast4_get_parameters_reply TGet_parameters'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_parameters(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_parameters& GetGet_parameters(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_parameters& SetGet_parameters(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_parameters(TGet_parameters& value);
 
 
    /// Check if variant Get_paramsets is selected.
    ///
    /// Get_paramsets type is defined as 'typedef CBlast4_get_paramsets_reply TGet_paramsets'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_paramsets(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_paramsets& GetGet_paramsets(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_paramsets& SetGet_paramsets(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_paramsets(TGet_paramsets& value);
 
 
    /// Check if variant Get_programs is selected.
    ///
    /// Get_programs type is defined as 'typedef CBlast4_get_programs_reply TGet_programs'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_programs(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_programs& GetGet_programs(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_programs& SetGet_programs(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_programs(TGet_programs& value);
 
 
    /// Check if variant Get_search_results is selected.
    ///
    /// Get_search_results type is defined as 'typedef CBlast4_get_search_results_reply TGet_search_results'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_search_results(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_search_results& GetGet_search_results(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_search_results& SetGet_search_results(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_search_results(TGet_search_results& value);
 
 
    /// Check if variant Get_sequences is selected.
    ///
    /// Get_sequences type is defined as 'typedef CBlast4_get_sequences_reply TGet_sequences'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_sequences(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_sequences& GetGet_sequences(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_sequences& SetGet_sequences(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_sequences(TGet_sequences& value);
 
 
    /// Check if variant Queue_search is selected.
    ///
    /// Queue_search type is defined as 'typedef CBlast4_queue_search_reply TQueue_search'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsQueue_search(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TQueue_search& GetQueue_search(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TQueue_search& SetQueue_search(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetQueue_search(TQueue_search& value);
 
 
    /// Check if variant Get_queries is selected.
    ///
    /// Get_queries type is defined as 'typedef CBlast4_get_queries_reply TGet_queries'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_queries(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_queries& GetGet_queries(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_queries& SetGet_queries(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_queries(TGet_queries& value);
 
 
    /// Check if variant Get_request_info is selected.
    ///
    /// Get_request_info type is defined as 'typedef CBlast4_get_request_info_reply TGet_request_info'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_request_info(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_request_info& GetGet_request_info(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_request_info& SetGet_request_info(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_request_info(TGet_request_info& value);
 
 
    /// Check if variant Get_sequence_parts is selected.
    ///
    /// Get_sequence_parts type is defined as 'typedef CBlast4_get_seq_parts_reply TGet_sequence_parts'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_sequence_parts(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_sequence_parts& GetGet_sequence_parts(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_sequence_parts& SetGet_sequence_parts(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_sequence_parts(TGet_sequence_parts& value);
 
 
    /// Check if variant Get_windowmasked_taxids is selected.
    ///
    /// Get_windowmasked_taxids type is defined as 'typedef CBlast4_get_windowmasked_taxids_reply TGet_windowmasked_taxids'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_windowmasked_taxids(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_windowmasked_taxids& GetGet_windowmasked_taxids(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_windowmasked_taxids& SetGet_windowmasked_taxids(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_windowmasked_taxids(TGet_windowmasked_taxids& value);
 
 
    /// Check if variant Get_protocol_info is selected.
    ///
    /// Get_protocol_info type is defined as 'typedef CBlast4_get_protocol_info_reply TGet_protocol_info'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_protocol_info(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_protocol_info& GetGet_protocol_info(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_protocol_info& SetGet_protocol_info(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_protocol_info(TGet_protocol_info& value);
 
 
    /// Check if variant Get_search_info is selected.
    ///
    /// Get_search_info type is defined as 'typedef CBlast4_get_search_info_reply TGet_search_info'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_search_info(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_search_info& GetGet_search_info(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_search_info& SetGet_search_info(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_search_info(TGet_search_info& value);
 
 
    /// Check if variant Get_databases_ex is selected.
    ///
    /// Get_databases_ex type is defined as 'typedef CBlast4_get_databases_ex_reply TGet_databases_ex'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsGet_databases_ex(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TGet_databases_ex& GetGet_databases_ex(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TGet_databases_ex& SetGet_databases_ex(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetGet_databases_ex(TGet_databases_ex& value);
 
 
private:
    // copy constructor and assignment operator
    CBlast4_reply_body_Base(const CBlast4_reply_body_Base& );
    CBlast4_reply_body_Base& operator=(const CBlast4_reply_body_Base& );
    // choice state
    E_Choice m_choice;
    // helper methods
    void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
 
    static const char* const sm_SelectionNames[];
    // data
    NCBI_NS_NCBI::CSerialObject *m_object;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CBlast4_reply_body_Base::E_Choice CBlast4_reply_body_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CBlast4_reply_body_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CBlast4_reply_body_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CBlast4_reply_body_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CBlast4_reply_body_Base::IsFinish_params(void) const
{
    return m_choice == e_Finish_params;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_databases(void) const
{
    return m_choice == e_Get_databases;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_matrices(void) const
{
    return m_choice == e_Get_matrices;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_parameters(void) const
{
    return m_choice == e_Get_parameters;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_paramsets(void) const
{
    return m_choice == e_Get_paramsets;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_programs(void) const
{
    return m_choice == e_Get_programs;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_search_results(void) const
{
    return m_choice == e_Get_search_results;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_sequences(void) const
{
    return m_choice == e_Get_sequences;
}
 
inline
bool CBlast4_reply_body_Base::IsQueue_search(void) const
{
    return m_choice == e_Queue_search;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_queries(void) const
{
    return m_choice == e_Get_queries;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_request_info(void) const
{
    return m_choice == e_Get_request_info;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_sequence_parts(void) const
{
    return m_choice == e_Get_sequence_parts;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_windowmasked_taxids(void) const
{
    return m_choice == e_Get_windowmasked_taxids;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_protocol_info(void) const
{
    return m_choice == e_Get_protocol_info;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_search_info(void) const
{
    return m_choice == e_Get_search_info;
}
 
inline
bool CBlast4_reply_body_Base::IsGet_databases_ex(void) const
{
    return m_choice == e_Get_databases_ex;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_BLAST_BLAST4_REPLY_BODY_BASE_HPP