Blast4_queue_search_reques_.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_queue_search_reques_.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_QUEUE_SEARCH_REQUES_BASE_HPP
#define OBJECTS_BLAST_BLAST4_QUEUE_SEARCH_REQUES_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;
class CBlast4_queries;
class CBlast4_subject;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Blast4
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// Options have been broken down into three groups as part of the BLAST
/// API work.  The algorithm options essentially correspond to those
/// options available via the CBlastOptions class.
/// For definitions of the names used in the Blast4-parameter structures, see
/// c++/{include,src}/objects/blast/names.[hc]pp in the NCBI C++ toolkit.
///   algorithm-options: Options for BLAST (ie. seq comparison) algorithm.
///   program-options:   Options for controlling program execution and/or 
///                      database filtering
///   format-options:    Options for formatting BLAST results, clients should
///                      use this only if applicable, otherwise they should be
///                      ignored
///
/// CBlast4_queue_search_request_Base --
///
 
class NCBI_BLAST_EXPORT CBlast4_queue_search_request_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBlast4_queue_search_request_Base(void);
    // destructor
    virtual ~CBlast4_queue_search_request_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TProgram;
    typedef string TService;
    typedef CBlast4_queries TQueries;
    typedef CBlast4_subject TSubject;
    typedef string TParamset;
    typedef CBlast4_parameters TAlgorithm_options;
    typedef CBlast4_parameters TProgram_options;
    typedef CBlast4_parameters TFormat_options;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_program,
        e_service,
        e_queries,
        e_subject,
        e_paramset,
        e_algorithm_options,
        e_program_options,
        e_format_options
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 9> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Program data member.
    ///
    /// Data member Program is mandatory;
    /// its type is defined as 'typedef string TProgram'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetProgram(void) const;
 
    /// Check if it is safe to call GetProgram method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetProgram(void) const;
 
    /// Reset Program data member.
    void ResetProgram(void);
 
    /// Get the Program member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TProgram& GetProgram(void) const;
 
    /// Assign a value to Program data member.
    ///
    /// @param value
    ///   Value to assign
    void SetProgram(const TProgram& value);
    void SetProgram(TProgram&& value);
 
    /// Assign a value to Program data member.
    ///
    /// @return
    ///   Reference to the data value.
    TProgram& SetProgram(void);
 
    /// Check if a value has been assigned to Service data member.
    ///
    /// Data member Service is mandatory;
    /// its type is defined as 'typedef string TService'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetService(void) const;
 
    /// Check if it is safe to call GetService method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetService(void) const;
 
    /// Reset Service data member.
    void ResetService(void);
 
    /// Get the Service member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TService& GetService(void) const;
 
    /// Assign a value to Service data member.
    ///
    /// @param value
    ///   Value to assign
    void SetService(const TService& value);
    void SetService(TService&& value);
 
    /// Assign a value to Service data member.
    ///
    /// @return
    ///   Reference to the data value.
    TService& SetService(void);
 
    /// Check if a value has been assigned to Queries data member.
    ///
    /// Data member Queries is mandatory;
    /// its type is defined as 'typedef CBlast4_queries TQueries'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetQueries(void) const;
 
    /// Check if it is safe to call GetQueries method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetQueries(void) const;
 
    /// Reset Queries data member.
    void ResetQueries(void);
 
    /// Get the Queries member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TQueries& GetQueries(void) const;
 
    /// Assign a value to Queries data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetQueries(TQueries& value);
 
    /// Assign a value to Queries data member.
    ///
    /// @return
    ///   Reference to the data value.
    TQueries& SetQueries(void);
 
    /// Check if a value has been assigned to Subject data member.
    ///
    /// Data member Subject is mandatory;
    /// its type is defined as 'typedef CBlast4_subject TSubject'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSubject(void) const;
 
    /// Check if it is safe to call GetSubject method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSubject(void) const;
 
    /// Reset Subject data member.
    void ResetSubject(void);
 
    /// Get the Subject member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSubject& GetSubject(void) const;
 
    /// Assign a value to Subject data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSubject(TSubject& value);
 
    /// Assign a value to Subject data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSubject& SetSubject(void);
 
    /// This field contains a task description
    /// Check if a value has been assigned to Paramset data member.
    ///
    /// Data member Paramset is optional;
    /// its type is defined as 'typedef string TParamset'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetParamset(void) const;
 
    /// Check if it is safe to call GetParamset method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetParamset(void) const;
 
    /// Reset Paramset data member.
    void ResetParamset(void);
 
    /// Get the Paramset member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TParamset& GetParamset(void) const;
 
    /// Assign a value to Paramset data member.
    ///
    /// @param value
    ///   Value to assign
    void SetParamset(const TParamset& value);
    void SetParamset(TParamset&& value);
 
    /// Assign a value to Paramset data member.
    ///
    /// @return
    ///   Reference to the data value.
    TParamset& SetParamset(void);
 
    /// Check if a value has been assigned to Algorithm_options data member.
    ///
    /// Data member Algorithm_options is optional;
    /// its type is defined as 'typedef CBlast4_parameters TAlgorithm_options'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAlgorithm_options(void) const;
 
    /// Check if it is safe to call GetAlgorithm_options method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAlgorithm_options(void) const;
 
    /// Reset Algorithm_options data member.
    void ResetAlgorithm_options(void);
 
    /// Get the Algorithm_options member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAlgorithm_options& GetAlgorithm_options(void) const;
 
    /// Assign a value to Algorithm_options data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAlgorithm_options(TAlgorithm_options& value);
 
    /// Assign a value to Algorithm_options data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAlgorithm_options& SetAlgorithm_options(void);
 
    /// Check if a value has been assigned to Program_options data member.
    ///
    /// Data member Program_options is optional;
    /// its type is defined as 'typedef CBlast4_parameters TProgram_options'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetProgram_options(void) const;
 
    /// Check if it is safe to call GetProgram_options method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetProgram_options(void) const;
 
    /// Reset Program_options data member.
    void ResetProgram_options(void);
 
    /// Get the Program_options member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TProgram_options& GetProgram_options(void) const;
 
    /// Assign a value to Program_options data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetProgram_options(TProgram_options& value);
 
    /// Assign a value to Program_options data member.
    ///
    /// @return
    ///   Reference to the data value.
    TProgram_options& SetProgram_options(void);
 
    /// Check if a value has been assigned to Format_options data member.
    ///
    /// Data member Format_options is optional;
    /// its type is defined as 'typedef CBlast4_parameters TFormat_options'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFormat_options(void) const;
 
    /// Check if it is safe to call GetFormat_options method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFormat_options(void) const;
 
    /// Reset Format_options data member.
    void ResetFormat_options(void);
 
    /// Get the Format_options member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TFormat_options& GetFormat_options(void) const;
 
    /// Assign a value to Format_options data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetFormat_options(TFormat_options& value);
 
    /// Assign a value to Format_options data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFormat_options& SetFormat_options(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CBlast4_queue_search_request_Base(const CBlast4_queue_search_request_Base&);
    CBlast4_queue_search_request_Base& operator=(const CBlast4_queue_search_request_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Program;
    string m_Service;
    CRef< TQueries > m_Queries;
    CRef< TSubject > m_Subject;
    string m_Paramset;
    CRef< TAlgorithm_options > m_Algorithm_options;
    CRef< TProgram_options > m_Program_options;
    CRef< TFormat_options > m_Format_options;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CBlast4_queue_search_request_Base::IsSetProgram(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetProgram(void) const
{
    return IsSetProgram();
}
 
inline
const CBlast4_queue_search_request_Base::TProgram& CBlast4_queue_search_request_Base::GetProgram(void) const
{
    if (!CanGetProgram()) {
        ThrowUnassigned(0);
    }
    return m_Program;
}
 
inline
void CBlast4_queue_search_request_Base::SetProgram(const CBlast4_queue_search_request_Base::TProgram& value)
{
    m_Program = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CBlast4_queue_search_request_Base::SetProgram(CBlast4_queue_search_request_Base::TProgram&& value)
{
    m_Program = std::forward<CBlast4_queue_search_request_Base::TProgram>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CBlast4_queue_search_request_Base::TProgram& CBlast4_queue_search_request_Base::SetProgram(void)
{
#ifdef _DEBUG
    if (!IsSetProgram()) {
        m_Program = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Program;
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetService(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetService(void) const
{
    return IsSetService();
}
 
inline
const CBlast4_queue_search_request_Base::TService& CBlast4_queue_search_request_Base::GetService(void) const
{
    if (!CanGetService()) {
        ThrowUnassigned(1);
    }
    return m_Service;
}
 
inline
void CBlast4_queue_search_request_Base::SetService(const CBlast4_queue_search_request_Base::TService& value)
{
    m_Service = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CBlast4_queue_search_request_Base::SetService(CBlast4_queue_search_request_Base::TService&& value)
{
    m_Service = std::forward<CBlast4_queue_search_request_Base::TService>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CBlast4_queue_search_request_Base::TService& CBlast4_queue_search_request_Base::SetService(void)
{
#ifdef _DEBUG
    if (!IsSetService()) {
        m_Service = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Service;
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetQueries(void) const
{
    return m_Queries.NotEmpty();
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetQueries(void) const
{
    return true;
}
 
inline
const CBlast4_queue_search_request_Base::TQueries& CBlast4_queue_search_request_Base::GetQueries(void) const
{
    if ( !m_Queries ) {
        const_cast<CBlast4_queue_search_request_Base*>(this)->ResetQueries();
    }
    return (*m_Queries);
}
 
inline
CBlast4_queue_search_request_Base::TQueries& CBlast4_queue_search_request_Base::SetQueries(void)
{
    if ( !m_Queries ) {
        ResetQueries();
    }
    return (*m_Queries);
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetSubject(void) const
{
    return m_Subject.NotEmpty();
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetSubject(void) const
{
    return true;
}
 
inline
const CBlast4_queue_search_request_Base::TSubject& CBlast4_queue_search_request_Base::GetSubject(void) const
{
    if ( !m_Subject ) {
        const_cast<CBlast4_queue_search_request_Base*>(this)->ResetSubject();
    }
    return (*m_Subject);
}
 
inline
CBlast4_queue_search_request_Base::TSubject& CBlast4_queue_search_request_Base::SetSubject(void)
{
    if ( !m_Subject ) {
        ResetSubject();
    }
    return (*m_Subject);
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetParamset(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetParamset(void) const
{
    return IsSetParamset();
}
 
inline
const CBlast4_queue_search_request_Base::TParamset& CBlast4_queue_search_request_Base::GetParamset(void) const
{
    if (!CanGetParamset()) {
        ThrowUnassigned(4);
    }
    return m_Paramset;
}
 
inline
void CBlast4_queue_search_request_Base::SetParamset(const CBlast4_queue_search_request_Base::TParamset& value)
{
    m_Paramset = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CBlast4_queue_search_request_Base::SetParamset(CBlast4_queue_search_request_Base::TParamset&& value)
{
    m_Paramset = std::forward<CBlast4_queue_search_request_Base::TParamset>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CBlast4_queue_search_request_Base::TParamset& CBlast4_queue_search_request_Base::SetParamset(void)
{
#ifdef _DEBUG
    if (!IsSetParamset()) {
        m_Paramset = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Paramset;
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetAlgorithm_options(void) const
{
    return m_Algorithm_options.NotEmpty();
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetAlgorithm_options(void) const
{
    return IsSetAlgorithm_options();
}
 
inline
const CBlast4_queue_search_request_Base::TAlgorithm_options& CBlast4_queue_search_request_Base::GetAlgorithm_options(void) const
{
    if (!CanGetAlgorithm_options()) {
        ThrowUnassigned(5);
    }
    return (*m_Algorithm_options);
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetProgram_options(void) const
{
    return m_Program_options.NotEmpty();
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetProgram_options(void) const
{
    return IsSetProgram_options();
}
 
inline
const CBlast4_queue_search_request_Base::TProgram_options& CBlast4_queue_search_request_Base::GetProgram_options(void) const
{
    if (!CanGetProgram_options()) {
        ThrowUnassigned(6);
    }
    return (*m_Program_options);
}
 
inline
bool CBlast4_queue_search_request_Base::IsSetFormat_options(void) const
{
    return m_Format_options.NotEmpty();
}
 
inline
bool CBlast4_queue_search_request_Base::CanGetFormat_options(void) const
{
    return IsSetFormat_options();
}
 
inline
const CBlast4_queue_search_request_Base::TFormat_options& CBlast4_queue_search_request_Base::GetFormat_options(void) const
{
    if (!CanGetFormat_options()) {
        ThrowUnassigned(7);
    }
    return (*m_Format_options);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_BLAST_BLAST4_QUEUE_SEARCH_REQUES_BASE_HPP