MSRequest_.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 MSRequest_.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/omssa/omssa.asn">omssa.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/omssa/omssa.def">omssa.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_OMSSA_MSREQUEST_BASE_HPP
#define OBJECTS_OMSSA_MSREQUEST_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 CMSModSpecSet;
class CMSSearchSettings;
class CMSSearchSettingsSet;
class CMSSpectrumset;
 
 
// generated classes
 
 
/** @addtogroup dataspec_OMSSA
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// The search request that is given to the OMSSA algorithm
///
/// CMSRequest_Base --
///
 
class NCBI_OMSSA_EXPORT CMSRequest_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CMSRequest_Base(void);
    // destructor
    virtual ~CMSRequest_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CMSSpectrumset TSpectra;
    typedef CMSSearchSettings TSettings;
    typedef string TRid;
    typedef CMSSearchSettingsSet TMoresettings;
    typedef CMSModSpecSet TModset;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_spectra,
        e_settings,
        e_rid,
        e_moresettings,
        e_modset
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// the set of spectra
    /// Check if a value has been assigned to Spectra data member.
    ///
    /// Data member Spectra is mandatory;
    /// its type is defined as 'typedef CMSSpectrumset TSpectra'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSpectra(void) const;
 
    /// Check if it is safe to call GetSpectra method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSpectra(void) const;
 
    /// Reset Spectra data member.
    void ResetSpectra(void);
 
    /// Get the Spectra member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSpectra& GetSpectra(void) const;
 
    /// Assign a value to Spectra data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSpectra(TSpectra& value);
 
    /// Assign a value to Spectra data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSpectra& SetSpectra(void);
 
    /// the search settings
    /// Check if a value has been assigned to Settings data member.
    ///
    /// Data member Settings is mandatory;
    /// its type is defined as 'typedef CMSSearchSettings TSettings'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSettings(void) const;
 
    /// Check if it is safe to call GetSettings method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSettings(void) const;
 
    /// Reset Settings data member.
    void ResetSettings(void);
 
    /// Get the Settings member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSettings& GetSettings(void) const;
 
    /// Assign a value to Settings data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSettings(TSettings& value);
 
    /// Assign a value to Settings data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSettings& SetSettings(void);
 
    /// request id
    /// Check if a value has been assigned to Rid data member.
    ///
    /// Data member Rid is optional;
    /// its type is defined as 'typedef string TRid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRid(void) const;
 
    /// Check if it is safe to call GetRid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRid(void) const;
 
    /// Reset Rid data member.
    void ResetRid(void);
 
    /// Get the Rid member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRid& GetRid(void) const;
 
    /// Assign a value to Rid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRid(const TRid& value);
    void SetRid(TRid&& value);
 
    /// Assign a value to Rid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRid& SetRid(void);
 
    /// additional search runs
    /// Check if a value has been assigned to Moresettings data member.
    ///
    /// Data member Moresettings is optional;
    /// its type is defined as 'typedef CMSSearchSettingsSet TMoresettings'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMoresettings(void) const;
 
    /// Check if it is safe to call GetMoresettings method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMoresettings(void) const;
 
    /// Reset Moresettings data member.
    void ResetMoresettings(void);
 
    /// Get the Moresettings member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMoresettings& GetMoresettings(void) const;
 
    /// Assign a value to Moresettings data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetMoresettings(TMoresettings& value);
 
    /// Assign a value to Moresettings data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMoresettings& SetMoresettings(void);
 
    /// list of mods that can be used in search
    /// Check if a value has been assigned to Modset data member.
    ///
    /// Data member Modset is optional;
    /// its type is defined as 'typedef CMSModSpecSet TModset'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetModset(void) const;
 
    /// Check if it is safe to call GetModset method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetModset(void) const;
 
    /// Reset Modset data member.
    void ResetModset(void);
 
    /// Get the Modset member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TModset& GetModset(void) const;
 
    /// Assign a value to Modset data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetModset(TModset& value);
 
    /// Assign a value to Modset data member.
    ///
    /// @return
    ///   Reference to the data value.
    TModset& SetModset(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMSRequest_Base(const CMSRequest_Base&);
    CMSRequest_Base& operator=(const CMSRequest_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TSpectra > m_Spectra;
    CRef< TSettings > m_Settings;
    string m_Rid;
    CRef< TMoresettings > m_Moresettings;
    CRef< TModset > m_Modset;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMSRequest_Base::IsSetSpectra(void) const
{
    return m_Spectra.NotEmpty();
}
 
inline
bool CMSRequest_Base::CanGetSpectra(void) const
{
    return true;
}
 
inline
const CMSRequest_Base::TSpectra& CMSRequest_Base::GetSpectra(void) const
{
    if ( !m_Spectra ) {
        const_cast<CMSRequest_Base*>(this)->ResetSpectra();
    }
    return (*m_Spectra);
}
 
inline
CMSRequest_Base::TSpectra& CMSRequest_Base::SetSpectra(void)
{
    if ( !m_Spectra ) {
        ResetSpectra();
    }
    return (*m_Spectra);
}
 
inline
bool CMSRequest_Base::IsSetSettings(void) const
{
    return m_Settings.NotEmpty();
}
 
inline
bool CMSRequest_Base::CanGetSettings(void) const
{
    return true;
}
 
inline
const CMSRequest_Base::TSettings& CMSRequest_Base::GetSettings(void) const
{
    if ( !m_Settings ) {
        const_cast<CMSRequest_Base*>(this)->ResetSettings();
    }
    return (*m_Settings);
}
 
inline
CMSRequest_Base::TSettings& CMSRequest_Base::SetSettings(void)
{
    if ( !m_Settings ) {
        ResetSettings();
    }
    return (*m_Settings);
}
 
inline
bool CMSRequest_Base::IsSetRid(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CMSRequest_Base::CanGetRid(void) const
{
    return IsSetRid();
}
 
inline
const CMSRequest_Base::TRid& CMSRequest_Base::GetRid(void) const
{
    if (!CanGetRid()) {
        ThrowUnassigned(2);
    }
    return m_Rid;
}
 
inline
void CMSRequest_Base::SetRid(const CMSRequest_Base::TRid& value)
{
    m_Rid = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CMSRequest_Base::SetRid(CMSRequest_Base::TRid&& value)
{
    m_Rid = std::forward<CMSRequest_Base::TRid>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CMSRequest_Base::TRid& CMSRequest_Base::SetRid(void)
{
#ifdef _DEBUG
    if (!IsSetRid()) {
        m_Rid = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Rid;
}
 
inline
bool CMSRequest_Base::IsSetMoresettings(void) const
{
    return m_Moresettings.NotEmpty();
}
 
inline
bool CMSRequest_Base::CanGetMoresettings(void) const
{
    return IsSetMoresettings();
}
 
inline
const CMSRequest_Base::TMoresettings& CMSRequest_Base::GetMoresettings(void) const
{
    if (!CanGetMoresettings()) {
        ThrowUnassigned(3);
    }
    return (*m_Moresettings);
}
 
inline
bool CMSRequest_Base::IsSetModset(void) const
{
    return m_Modset.NotEmpty();
}
 
inline
bool CMSRequest_Base::CanGetModset(void) const
{
    return IsSetModset();
}
 
inline
const CMSRequest_Base::TModset& CMSRequest_Base::GetModset(void) const
{
    if (!CanGetModset()) {
        ThrowUnassigned(4);
    }
    return (*m_Modset);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_OMSSA_MSREQUEST_BASE_HPP