MSHitSet_.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 MSHitSet_.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_MSHITSET_BASE_HPP
#define OBJECTS_OMSSA_MSHITSET_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <string>
#include <vector>
#include <objects/omssa/MSHitError.hpp>
#include <objects/omssa/MSUserAnnot.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 CMSHits;
class CNameValue;
 
 
// generated classes
 
 
/** @addtogroup dataspec_OMSSA
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// contains a set of hits to a single spectrum
///
/// CMSHitSet_Base --
///
 
class NCBI_OMSSA_EXPORT CMSHitSet_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CMSHitSet_Base(void);
    // destructor
    virtual ~CMSHitSet_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TNumber;
    typedef int TError;
    typedef vector< CRef< CMSHits > > THits;
    typedef list< string > TIds;
    typedef list< CRef< CNameValue > > TNamevalue;
    typedef int TSettingid;
    typedef int TUserannotation;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_number,
        e_error,
        e_hits,
        e_ids,
        e_namevalue,
        e_settingid,
        e_userannotation
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 8> TmemberIndex;
 
    // getters
    // setters
 
    /// unique number of spectrum
    /// Check if a value has been assigned to Number data member.
    ///
    /// Data member Number is mandatory;
    /// its type is defined as 'typedef int TNumber'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNumber(void) const;
 
    /// Check if it is safe to call GetNumber method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNumber(void) const;
 
    /// Reset Number data member.
    void ResetNumber(void);
 
    /// Get the Number member data.
    ///
    /// @return
    ///   Copy of the member data.
    TNumber GetNumber(void) const;
 
    /// Assign a value to Number data member.
    ///
    /// @param value
    ///   Value to assign
    void SetNumber(TNumber value);
 
    /// Assign a value to Number data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNumber& SetNumber(void);
 
    /// error, if any
    /// Check if a value has been assigned to Error data member.
    ///
    /// Data member Error is optional;
    /// its type is defined as 'typedef int TError'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetError(void) const;
 
    /// Check if it is safe to call GetError method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetError(void) const;
 
    /// Reset Error data member.
    void ResetError(void);
 
    /// Get the Error member data.
    ///
    /// @return
    ///   Copy of the member data.
    TError GetError(void) const;
 
    /// Assign a value to Error data member.
    ///
    /// @param value
    ///   Value to assign
    void SetError(TError value);
 
    /// Assign a value to Error data member.
    ///
    /// @return
    ///   Reference to the data value.
    TError& SetError(void);
 
    /// set of hit to spectrum
    /// Check if a value has been assigned to Hits data member.
    ///
    /// Data member Hits is optional;
    /// its type is defined as 'typedef vector< CRef< CMSHits > > THits'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetHits(void) const;
 
    /// Check if it is safe to call GetHits method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetHits(void) const;
 
    /// Reset Hits data member.
    void ResetHits(void);
 
    /// Get the Hits member data.
    ///
    /// @return
    ///   Reference to the member data.
    const THits& GetHits(void) const;
 
    /// Assign a value to Hits data member.
    ///
    /// @return
    ///   Reference to the data value.
    THits& SetHits(void);
 
    /// filenames or other ids of spectra searched
    /// Check if a value has been assigned to Ids data member.
    ///
    /// Data member Ids is optional;
    /// its type is defined as 'typedef list< string > TIds'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIds(void) const;
 
    /// Check if it is safe to call GetIds method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIds(void) const;
 
    /// Reset Ids data member.
    void ResetIds(void);
 
    /// Get the Ids member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TIds& GetIds(void) const;
 
    /// Assign a value to Ids data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIds& SetIds(void);
 
    /// extra info: retention times, etc.
    /// Check if a value has been assigned to Namevalue data member.
    ///
    /// Data member Namevalue is optional;
    /// its type is defined as 'typedef list< CRef< CNameValue > > TNamevalue'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNamevalue(void) const;
 
    /// Check if it is safe to call GetNamevalue method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNamevalue(void) const;
 
    /// Reset Namevalue data member.
    void ResetNamevalue(void);
 
    /// Get the Namevalue member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TNamevalue& GetNamevalue(void) const;
 
    /// Assign a value to Namevalue data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNamevalue& SetNamevalue(void);
 
    /// id of the search setting used
    /// Check if a value has been assigned to Settingid data member.
    ///
    /// Data member Settingid is optional;
    /// its type is defined as 'typedef int TSettingid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSettingid(void) const;
 
    /// Check if it is safe to call GetSettingid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSettingid(void) const;
 
    /// Reset Settingid data member.
    void ResetSettingid(void);
 
    /// Get the Settingid member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSettingid GetSettingid(void) const;
 
    /// Assign a value to Settingid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSettingid(TSettingid value);
 
    /// Assign a value to Settingid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSettingid& SetSettingid(void);
 
    /// allows users to flag certain
    /// Check if a value has been assigned to Userannotation data member.
    ///
    /// Data member Userannotation is optional;
    /// its type is defined as 'typedef int TUserannotation'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUserannotation(void) const;
 
    /// Check if it is safe to call GetUserannotation method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUserannotation(void) const;
 
    /// Reset Userannotation data member.
    void ResetUserannotation(void);
 
    /// Get the Userannotation member data.
    ///
    /// @return
    ///   Copy of the member data.
    TUserannotation GetUserannotation(void) const;
 
    /// Assign a value to Userannotation data member.
    ///
    /// @param value
    ///   Value to assign
    void SetUserannotation(TUserannotation value);
 
    /// Assign a value to Userannotation data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUserannotation& SetUserannotation(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMSHitSet_Base(const CMSHitSet_Base&);
    CMSHitSet_Base& operator=(const CMSHitSet_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Number;
    int m_Error;
    vector< CRef< CMSHits > > m_Hits;
    list< string > m_Ids;
    list< CRef< CNameValue > > m_Namevalue;
    int m_Settingid;
    int m_Userannotation;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMSHitSet_Base::IsSetNumber(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetNumber(void) const
{
    return IsSetNumber();
}
 
inline
void CMSHitSet_Base::ResetNumber(void)
{
    m_Number = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CMSHitSet_Base::TNumber CMSHitSet_Base::GetNumber(void) const
{
    if (!CanGetNumber()) {
        ThrowUnassigned(0);
    }
    return m_Number;
}
 
inline
void CMSHitSet_Base::SetNumber(CMSHitSet_Base::TNumber value)
{
    m_Number = value;
    m_set_State[0] |= 0x3;
}
 
inline
CMSHitSet_Base::TNumber& CMSHitSet_Base::SetNumber(void)
{
#ifdef _DEBUG
    if (!IsSetNumber()) {
        memset(&m_Number,UnassignedByte(),sizeof(m_Number));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Number;
}
 
inline
bool CMSHitSet_Base::IsSetError(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetError(void) const
{
    return IsSetError();
}
 
inline
void CMSHitSet_Base::ResetError(void)
{
    m_Error = (int)(0);
    m_set_State[0] &= ~0xc;
}
 
inline
CMSHitSet_Base::TError CMSHitSet_Base::GetError(void) const
{
    if (!CanGetError()) {
        ThrowUnassigned(1);
    }
    return m_Error;
}
 
inline
void CMSHitSet_Base::SetError(CMSHitSet_Base::TError value)
{
    m_Error = value;
    m_set_State[0] |= 0xc;
}
 
inline
CMSHitSet_Base::TError& CMSHitSet_Base::SetError(void)
{
#ifdef _DEBUG
    if (!IsSetError()) {
        memset(&m_Error,UnassignedByte(),sizeof(m_Error));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Error;
}
 
inline
bool CMSHitSet_Base::IsSetHits(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetHits(void) const
{
    return true;
}
 
inline
const CMSHitSet_Base::THits& CMSHitSet_Base::GetHits(void) const
{
    return m_Hits;
}
 
inline
CMSHitSet_Base::THits& CMSHitSet_Base::SetHits(void)
{
    m_set_State[0] |= 0x10;
    return m_Hits;
}
 
inline
bool CMSHitSet_Base::IsSetIds(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetIds(void) const
{
    return true;
}
 
inline
const CMSHitSet_Base::TIds& CMSHitSet_Base::GetIds(void) const
{
    return m_Ids;
}
 
inline
CMSHitSet_Base::TIds& CMSHitSet_Base::SetIds(void)
{
    m_set_State[0] |= 0x40;
    return m_Ids;
}
 
inline
bool CMSHitSet_Base::IsSetNamevalue(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetNamevalue(void) const
{
    return true;
}
 
inline
const CMSHitSet_Base::TNamevalue& CMSHitSet_Base::GetNamevalue(void) const
{
    return m_Namevalue;
}
 
inline
CMSHitSet_Base::TNamevalue& CMSHitSet_Base::SetNamevalue(void)
{
    m_set_State[0] |= 0x100;
    return m_Namevalue;
}
 
inline
bool CMSHitSet_Base::IsSetSettingid(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetSettingid(void) const
{
    return IsSetSettingid();
}
 
inline
void CMSHitSet_Base::ResetSettingid(void)
{
    m_Settingid = 0;
    m_set_State[0] &= ~0xc00;
}
 
inline
CMSHitSet_Base::TSettingid CMSHitSet_Base::GetSettingid(void) const
{
    if (!CanGetSettingid()) {
        ThrowUnassigned(5);
    }
    return m_Settingid;
}
 
inline
void CMSHitSet_Base::SetSettingid(CMSHitSet_Base::TSettingid value)
{
    m_Settingid = value;
    m_set_State[0] |= 0xc00;
}
 
inline
CMSHitSet_Base::TSettingid& CMSHitSet_Base::SetSettingid(void)
{
#ifdef _DEBUG
    if (!IsSetSettingid()) {
        memset(&m_Settingid,UnassignedByte(),sizeof(m_Settingid));
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Settingid;
}
 
inline
bool CMSHitSet_Base::IsSetUserannotation(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CMSHitSet_Base::CanGetUserannotation(void) const
{
    return IsSetUserannotation();
}
 
inline
void CMSHitSet_Base::ResetUserannotation(void)
{
    m_Userannotation = (int)(0);
    m_set_State[0] &= ~0x3000;
}
 
inline
CMSHitSet_Base::TUserannotation CMSHitSet_Base::GetUserannotation(void) const
{
    if (!CanGetUserannotation()) {
        ThrowUnassigned(6);
    }
    return m_Userannotation;
}
 
inline
void CMSHitSet_Base::SetUserannotation(CMSHitSet_Base::TUserannotation value)
{
    m_Userannotation = value;
    m_set_State[0] |= 0x3000;
}
 
inline
CMSHitSet_Base::TUserannotation& CMSHitSet_Base::SetUserannotation(void)
{
#ifdef _DEBUG
    if (!IsSetUserannotation()) {
        memset(&m_Userannotation,UnassignedByte(),sizeof(m_Userannotation));
    }
#endif
    m_set_State[0] |= 0x1000;
    return m_Userannotation;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_OMSSA_MSHITSET_BASE_HPP