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 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/build-system/project_tree_builder/msvc71_project.dtd">msvc71_project.dtd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/build-system/project_tree_builder/msvc71_project.def">msvc71_project.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef BUILD_SYSTEM_PROJECT_TREE_BUILDER_FILTER_BASE_HPP
#define BUILD_SYSTEM_PROJECT_TREE_BUILDER_FILTER_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#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 CFFile;
class CFilter;
 
 
// generated classes
 
 
/** @addtogroup dataspec_msvc71_project
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CFilter_Base --
///
 
class CFilter_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CFilter_Base(void);
    // destructor
    virtual ~CFilter_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class C_Attlist : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Attlist(void);
        // destructor
        ~C_Attlist(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef string TName;
        typedef string TFilter;
        typedef string TUniqueIdentifier;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_Name,
            e_Filter,
            e_UniqueIdentifier
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Name data member.
        ///
        /// Data member Name is mandatory;
        /// its type is defined as 'typedef string TName'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetName(void) const;
    
        /// Check if it is safe to call GetName method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetName(void) const;
    
        /// Reset Name data member.
        void ResetName(void);
    
        /// Get the Name member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TName& GetName(void) const;
    
        /// Assign a value to Name data member.
        ///
        /// @param value
        ///   Value to assign
        void SetName(const TName& value);
        void SetName(TName&& value);
    
        /// Assign a value to Name data member.
        ///
        /// @return
        ///   Reference to the data value.
        TName& SetName(void);
    
        /// Check if a value has been assigned to Filter data member.
        ///
        /// Data member Filter is mandatory;
        /// its type is defined as 'typedef string TFilter'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetFilter(void) const;
    
        /// Check if it is safe to call GetFilter method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetFilter(void) const;
    
        /// Reset Filter data member.
        void ResetFilter(void);
    
        /// Get the Filter member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TFilter& GetFilter(void) const;
    
        /// Assign a value to Filter data member.
        ///
        /// @param value
        ///   Value to assign
        void SetFilter(const TFilter& value);
        void SetFilter(TFilter&& value);
    
        /// Assign a value to Filter data member.
        ///
        /// @return
        ///   Reference to the data value.
        TFilter& SetFilter(void);
    
        /// Check if a value has been assigned to UniqueIdentifier data member.
        ///
        /// Data member UniqueIdentifier is optional;
        /// its type is defined as 'typedef string TUniqueIdentifier'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetUniqueIdentifier(void) const;
    
        /// Check if it is safe to call GetUniqueIdentifier method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetUniqueIdentifier(void) const;
    
        /// Reset UniqueIdentifier data member.
        void ResetUniqueIdentifier(void);
    
        /// Get the UniqueIdentifier member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TUniqueIdentifier& GetUniqueIdentifier(void) const;
    
        /// Assign a value to UniqueIdentifier data member.
        ///
        /// @param value
        ///   Value to assign
        void SetUniqueIdentifier(const TUniqueIdentifier& value);
        void SetUniqueIdentifier(TUniqueIdentifier&& value);
    
        /// Assign a value to UniqueIdentifier data member.
        ///
        /// @return
        ///   Reference to the data value.
        TUniqueIdentifier& SetUniqueIdentifier(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];
        string m_Name;
        string m_Filter;
        string m_UniqueIdentifier;
    };
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_FF --
    ///
    
    class C_FF : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_FF(void);
        // destructor
        ~C_FF(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        /////////////////////////////////////////////////////////////////////////////
        ///
        /// C_E_FF --
        ///
        
        class C_E_FF : public CSerialObject
        {
            typedef CSerialObject Tparent;
        public:
            // constructor
            C_E_FF(void);
            // destructor
            ~C_E_FF(void);
        
            // type info
            DECLARE_INTERNAL_TYPE_INFO();
        
        
            /// Choice variants.
            enum E_Choice {
                e_not_set = 0,  ///< No variant selected
                e_File,
                e_Filter
            };
            /// Maximum+1 value of the choice variant enumerator.
            enum E_ChoiceStopper {
                e_MaxChoice = 3 ///< == e_Filter+1
            };
        
            /// Reset the whole object
            void Reset(void);
        
            /// Reset the selection (set it to e_not_set).
            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 CFFile TFile;
            typedef CFilter TFilter;
        
            // getters
            // setters
        
        
            /// Check if variant File is selected.
            ///
            /// File type is defined as 'typedef CFFile TFile'.
            /// @return
            ///   - true, if the variant is selected.
            ///   - false, otherwise.
            bool IsFile(void) const;
        
            /// Get the variant data.
            ///
            /// @return
            ///   Reference to the data.
            const TFile& GetFile(void) const;
        
            /// Select the variant.
            ///
            /// @return
            ///   Reference to the variant data.
            TFile& SetFile(void);
            /// Select the variant and set its data.
            ///
            /// @param value
            ///   Reference to the data.
            void SetFile(TFile& value);
        
        
            /// Check if variant Filter is selected.
            ///
            /// Filter type is defined as 'typedef CFilter TFilter'.
            /// @return
            ///   - true, if the variant is selected.
            ///   - false, otherwise.
            bool IsFilter(void) const;
        
            /// Get the variant data.
            ///
            /// @return
            ///   Reference to the data.
            const TFilter& GetFilter(void) const;
        
            /// Select the variant.
            ///
            /// @return
            ///   Reference to the variant data.
            TFilter& SetFilter(void);
            /// Select the variant and set its data.
            ///
            /// @param value
            ///   Reference to the data.
            void SetFilter(TFilter& value);
        
        
        private:
            // copy constructor and assignment operator
            C_E_FF(const C_E_FF& );
            C_E_FF& operator=(const C_E_FF& );
            // 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;
        };
        // types
        typedef C_E_FF C_E;
        typedef list< CRef< C_E_FF > > TFF;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_FF
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 2> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to FF data member.
        ///
        /// Data member FF is optional;
        /// its type is defined as 'typedef list< CRef< C_E_FF > > TFF'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetFF(void) const;
    
        /// Check if it is safe to call GetFF method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetFF(void) const;
    
        /// Reset FF data member.
        void ResetFF(void);
    
        /// Get the FF member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TFF& GetFF(void) const;
    
        /// Assign a value to FF data member.
        ///
        /// @return
        ///   Reference to the data value.
        TFF& SetFF(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_FF(const C_FF&);
        C_FF& operator=(const C_FF&);
    
        // data
        Uint4 m_set_State[1];
        list< CRef< C_E_FF > > m_FF;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef C_FF TFF;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_FF
    };
    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 FF data member.
    ///
    /// Data member FF is optional;
    /// its type is defined as 'typedef C_FF TFF'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFF(void) const;
 
    /// Check if it is safe to call GetFF method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFF(void) const;
 
    /// Reset FF data member.
    void ResetFF(void);
 
    /// Get the FF member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TFF& GetFF(void) const;
 
    /// Assign a value to FF data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetFF(TFF& value);
 
    /// Assign a value to FF data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFF& SetFF(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CFilter_Base(const CFilter_Base&);
    CFilter_Base& operator=(const CFilter_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
    CRef< TFF > m_FF;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CFilter_Base::C_Attlist::IsSetName(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CFilter_Base::C_Attlist::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CFilter_Base::C_Attlist::TName& CFilter_Base::C_Attlist::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(0);
    }
    return m_Name;
}
 
inline
void CFilter_Base::C_Attlist::SetName(const CFilter_Base::C_Attlist::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CFilter_Base::C_Attlist::SetName(CFilter_Base::C_Attlist::TName&& value)
{
    m_Name = std::forward<CFilter_Base::C_Attlist::TName>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CFilter_Base::C_Attlist::TName& CFilter_Base::C_Attlist::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Name;
}
 
inline
bool CFilter_Base::C_Attlist::IsSetFilter(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CFilter_Base::C_Attlist::CanGetFilter(void) const
{
    return IsSetFilter();
}
 
inline
const CFilter_Base::C_Attlist::TFilter& CFilter_Base::C_Attlist::GetFilter(void) const
{
    if (!CanGetFilter()) {
        ThrowUnassigned(1);
    }
    return m_Filter;
}
 
inline
void CFilter_Base::C_Attlist::SetFilter(const CFilter_Base::C_Attlist::TFilter& value)
{
    m_Filter = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CFilter_Base::C_Attlist::SetFilter(CFilter_Base::C_Attlist::TFilter&& value)
{
    m_Filter = std::forward<CFilter_Base::C_Attlist::TFilter>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CFilter_Base::C_Attlist::TFilter& CFilter_Base::C_Attlist::SetFilter(void)
{
#ifdef _DEBUG
    if (!IsSetFilter()) {
        m_Filter = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Filter;
}
 
inline
bool CFilter_Base::C_Attlist::IsSetUniqueIdentifier(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CFilter_Base::C_Attlist::CanGetUniqueIdentifier(void) const
{
    return IsSetUniqueIdentifier();
}
 
inline
const CFilter_Base::C_Attlist::TUniqueIdentifier& CFilter_Base::C_Attlist::GetUniqueIdentifier(void) const
{
    if (!CanGetUniqueIdentifier()) {
        ThrowUnassigned(2);
    }
    return m_UniqueIdentifier;
}
 
inline
void CFilter_Base::C_Attlist::SetUniqueIdentifier(const CFilter_Base::C_Attlist::TUniqueIdentifier& value)
{
    m_UniqueIdentifier = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CFilter_Base::C_Attlist::SetUniqueIdentifier(CFilter_Base::C_Attlist::TUniqueIdentifier&& value)
{
    m_UniqueIdentifier = std::forward<CFilter_Base::C_Attlist::TUniqueIdentifier>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CFilter_Base::C_Attlist::TUniqueIdentifier& CFilter_Base::C_Attlist::SetUniqueIdentifier(void)
{
#ifdef _DEBUG
    if (!IsSetUniqueIdentifier()) {
        m_UniqueIdentifier = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_UniqueIdentifier;
}
 
inline
CFilter_Base::C_FF::C_E_FF::E_Choice CFilter_Base::C_FF::C_E_FF::Which(void) const
{
    return m_choice;
}
 
inline
void CFilter_Base::C_FF::C_E_FF::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CFilter_Base::C_FF::C_E_FF::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 CFilter_Base::C_FF::C_E_FF::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CFilter_Base::C_FF::C_E_FF::IsFile(void) const
{
    return m_choice == e_File;
}
 
inline
bool CFilter_Base::C_FF::C_E_FF::IsFilter(void) const
{
    return m_choice == e_Filter;
}
 
inline
bool CFilter_Base::C_FF::IsSetFF(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CFilter_Base::C_FF::CanGetFF(void) const
{
    return true;
}
 
inline
const CFilter_Base::C_FF::TFF& CFilter_Base::C_FF::GetFF(void) const
{
    return m_FF;
}
 
inline
CFilter_Base::C_FF::TFF& CFilter_Base::C_FF::SetFF(void)
{
    m_set_State[0] |= 0x1;
    return m_FF;
}
 
inline
bool CFilter_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CFilter_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CFilter_Base::TAttlist& CFilter_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CFilter_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CFilter_Base::TAttlist& CFilter_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CFilter_Base::IsSetFF(void) const
{
    return m_FF.NotEmpty();
}
 
inline
bool CFilter_Base::CanGetFF(void) const
{
    return IsSetFF();
}
 
inline
const CFilter_Base::TFF& CFilter_Base::GetFF(void) const
{
    if (!CanGetFF()) {
        ThrowUnassigned(1);
    }
    return (*m_FF);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // BUILD_SYSTEM_PROJECT_TREE_BUILDER_FILTER_BASE_HPP