Data_filter_.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 Data_filter_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.xsd">pepXML.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/ms/formats/pepxml/pepXML.def">pepXML.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef ALGO_MS_FORMATS_PEPXML_DATA_FILTER_BASE_HPP
#define ALGO_MS_FORMATS_PEPXML_DATA_FILTER_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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_pepXML
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CData_filter_Base --
///
 
class NCBI_PEPXML_EXPORT CData_filter_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CData_filter_Base(void);
    // destructor
    virtual ~CData_filter_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class NCBI_PEPXML_EXPORT C_Attlist : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Attlist(void);
        // destructor
        ~C_Attlist(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef int TNumber;
        typedef string TParent_file;
        typedef string TWindows_parent;
        typedef string TDescription;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_number,
            e_parent_file,
            e_windows_parent,
            e_description
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
    
        // getters
        // setters
    
        /// 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);
    
        /// Check if a value has been assigned to Parent_file data member.
        ///
        /// Data member Parent_file is mandatory;
        /// its type is defined as 'typedef string TParent_file'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetParent_file(void) const;
    
        /// Check if it is safe to call GetParent_file method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetParent_file(void) const;
    
        /// Reset Parent_file data member.
        void ResetParent_file(void);
    
        /// Get the Parent_file member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TParent_file& GetParent_file(void) const;
    
        /// Assign a value to Parent_file data member.
        ///
        /// @param value
        ///   Value to assign
        void SetParent_file(const TParent_file& value);
        void SetParent_file(TParent_file&& value);
    
        /// Assign a value to Parent_file data member.
        ///
        /// @return
        ///   Reference to the data value.
        TParent_file& SetParent_file(void);
    
        /// Check if a value has been assigned to Windows_parent data member.
        ///
        /// Data member Windows_parent is optional;
        /// its type is defined as 'typedef string TWindows_parent'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetWindows_parent(void) const;
    
        /// Check if it is safe to call GetWindows_parent method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetWindows_parent(void) const;
    
        /// Reset Windows_parent data member.
        void ResetWindows_parent(void);
    
        /// Get the Windows_parent member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TWindows_parent& GetWindows_parent(void) const;
    
        /// Assign a value to Windows_parent data member.
        ///
        /// @param value
        ///   Value to assign
        void SetWindows_parent(const TWindows_parent& value);
        void SetWindows_parent(TWindows_parent&& value);
    
        /// Assign a value to Windows_parent data member.
        ///
        /// @return
        ///   Reference to the data value.
        TWindows_parent& SetWindows_parent(void);
    
        /// Check if a value has been assigned to Description data member.
        ///
        /// Data member Description is mandatory;
        /// its type is defined as 'typedef string TDescription'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetDescription(void) const;
    
        /// Check if it is safe to call GetDescription method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetDescription(void) const;
    
        /// Reset Description data member.
        void ResetDescription(void);
    
        /// Get the Description member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TDescription& GetDescription(void) const;
    
        /// Assign a value to Description data member.
        ///
        /// @param value
        ///   Value to assign
        void SetDescription(const TDescription& value);
        void SetDescription(TDescription&& value);
    
        /// Assign a value to Description data member.
        ///
        /// @return
        ///   Reference to the data value.
        TDescription& SetDescription(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Attlist(const C_Attlist&);
        C_Attlist& operator=(const C_Attlist&);
    
        // data
        Uint4 m_set_State[1];
        int m_Number;
        string m_Parent_file;
        string m_Windows_parent;
        string m_Description;
    };
    // types
    typedef C_Attlist TAttlist;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_data_filter
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Attlist data member.
    ///
    /// Data member Attlist is mandatory;
    /// its type is defined as 'typedef C_Attlist TAttlist'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAttlist(void) const;
 
    /// Check if it is safe to call GetAttlist method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAttlist(void) const;
 
    /// Reset Attlist data member.
    void ResetAttlist(void);
 
    /// Get the Attlist member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAttlist& GetAttlist(void) const;
 
    /// Assign a value to Attlist data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAttlist(TAttlist& value);
 
    /// Assign a value to Attlist data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAttlist& SetAttlist(void);
 
    /// Check if a value has been assigned to Data_filter data member.
    ///
    /// Data member Data_filter is mandatory
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetData_filter(void) const;
 
    /// Check if value of Data_filter member is getatable.
    ///
    /// @return
    ///   - false; the data member of type 'NULL' has no value.
    bool CanGetData_filter(void) const;
 
    /// Reset Data_filter data member.
    void ResetData_filter(void);
 
    /// Set NULL data member (assign 'NULL' value to Data_filter data member).
    void SetData_filter(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CData_filter_Base(const CData_filter_Base&);
    CData_filter_Base& operator=(const CData_filter_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CData_filter_Base::C_Attlist::IsSetNumber(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CData_filter_Base::C_Attlist::CanGetNumber(void) const
{
    return IsSetNumber();
}
 
inline
void CData_filter_Base::C_Attlist::ResetNumber(void)
{
    m_Number = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CData_filter_Base::C_Attlist::TNumber CData_filter_Base::C_Attlist::GetNumber(void) const
{
    if (!CanGetNumber()) {
        ThrowUnassigned(0);
    }
    return m_Number;
}
 
inline
void CData_filter_Base::C_Attlist::SetNumber(CData_filter_Base::C_Attlist::TNumber value)
{
    m_Number = value;
    m_set_State[0] |= 0x3;
}
 
inline
CData_filter_Base::C_Attlist::TNumber& CData_filter_Base::C_Attlist::SetNumber(void)
{
#ifdef _DEBUG
    if (!IsSetNumber()) {
        memset(&m_Number,UnassignedByte(),sizeof(m_Number));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Number;
}
 
inline
bool CData_filter_Base::C_Attlist::IsSetParent_file(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CData_filter_Base::C_Attlist::CanGetParent_file(void) const
{
    return IsSetParent_file();
}
 
inline
const CData_filter_Base::C_Attlist::TParent_file& CData_filter_Base::C_Attlist::GetParent_file(void) const
{
    if (!CanGetParent_file()) {
        ThrowUnassigned(1);
    }
    return m_Parent_file;
}
 
inline
void CData_filter_Base::C_Attlist::SetParent_file(const CData_filter_Base::C_Attlist::TParent_file& value)
{
    m_Parent_file = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CData_filter_Base::C_Attlist::SetParent_file(CData_filter_Base::C_Attlist::TParent_file&& value)
{
    m_Parent_file = std::forward<CData_filter_Base::C_Attlist::TParent_file>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CData_filter_Base::C_Attlist::TParent_file& CData_filter_Base::C_Attlist::SetParent_file(void)
{
#ifdef _DEBUG
    if (!IsSetParent_file()) {
        m_Parent_file = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Parent_file;
}
 
inline
bool CData_filter_Base::C_Attlist::IsSetWindows_parent(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CData_filter_Base::C_Attlist::CanGetWindows_parent(void) const
{
    return IsSetWindows_parent();
}
 
inline
const CData_filter_Base::C_Attlist::TWindows_parent& CData_filter_Base::C_Attlist::GetWindows_parent(void) const
{
    if (!CanGetWindows_parent()) {
        ThrowUnassigned(2);
    }
    return m_Windows_parent;
}
 
inline
void CData_filter_Base::C_Attlist::SetWindows_parent(const CData_filter_Base::C_Attlist::TWindows_parent& value)
{
    m_Windows_parent = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CData_filter_Base::C_Attlist::SetWindows_parent(CData_filter_Base::C_Attlist::TWindows_parent&& value)
{
    m_Windows_parent = std::forward<CData_filter_Base::C_Attlist::TWindows_parent>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CData_filter_Base::C_Attlist::TWindows_parent& CData_filter_Base::C_Attlist::SetWindows_parent(void)
{
#ifdef _DEBUG
    if (!IsSetWindows_parent()) {
        m_Windows_parent = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Windows_parent;
}
 
inline
bool CData_filter_Base::C_Attlist::IsSetDescription(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CData_filter_Base::C_Attlist::CanGetDescription(void) const
{
    return IsSetDescription();
}
 
inline
const CData_filter_Base::C_Attlist::TDescription& CData_filter_Base::C_Attlist::GetDescription(void) const
{
    if (!CanGetDescription()) {
        ThrowUnassigned(3);
    }
    return m_Description;
}
 
inline
void CData_filter_Base::C_Attlist::SetDescription(const CData_filter_Base::C_Attlist::TDescription& value)
{
    m_Description = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CData_filter_Base::C_Attlist::SetDescription(CData_filter_Base::C_Attlist::TDescription&& value)
{
    m_Description = std::forward<CData_filter_Base::C_Attlist::TDescription>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CData_filter_Base::C_Attlist::TDescription& CData_filter_Base::C_Attlist::SetDescription(void)
{
#ifdef _DEBUG
    if (!IsSetDescription()) {
        m_Description = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Description;
}
 
inline
bool CData_filter_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CData_filter_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CData_filter_Base::TAttlist& CData_filter_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CData_filter_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CData_filter_Base::TAttlist& CData_filter_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    SetData_filter();
    return (*m_Attlist);
}
 
inline
bool CData_filter_Base::IsSetData_filter(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CData_filter_Base::CanGetData_filter(void) const
{
    return false;
}
 
inline
void CData_filter_Base::ResetData_filter(void)
{
    m_set_State[0] &= ~0xc;
}
 
inline
void CData_filter_Base::SetData_filter(void)
{
    m_set_State[0] |= 0xc;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_MS_FORMATS_PEPXML_DATA_FILTER_BASE_HPP