Region_pntrs_.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 Region_pntrs_.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/mmdb3/mmdb3.asn">mmdb3.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mmdb3/mmdb3.def">mmdb3.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MMDB3_REGION_PNTRS_BASE_HPP
#define OBJECTS_MMDB3_REGION_PNTRS_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <objects/mmdb2/Model_id.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 CRegion_boundary;
class CRegion_coordinates;
 
 
// generated classes
 
 
/** @addtogroup dataspec_MMDB_Features
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// Region motifs describe features defined by spatial location, such as the
/// site specified by a coordinate value, or a rgeion within a bounding volume.
///
/// CRegion_pntrs_Base --
///
 
class NCBI_MMDB3_EXPORT CRegion_pntrs_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CRegion_pntrs_Base(void);
    // destructor
    virtual ~CRegion_pntrs_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Region --
    ///
    
    class NCBI_MMDB3_EXPORT C_Region : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Region(void);
        // destructor
        ~C_Region(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
    
        /// Choice variants.
        enum E_Choice {
            e_not_set = 0,  ///< No variant selected
            e_Site,
            e_Boundary
        };
        /// Maximum+1 value of the choice variant enumerator.
        enum E_ChoiceStopper {
            e_MaxChoice = 3 ///< == e_Boundary+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 list< CRef< CRegion_coordinates > > TSite;
        typedef list< CRef< CRegion_boundary > > TBoundary;
    
        // getters
        // setters
    
    
        /// Check if variant Site is selected.
        ///
        /// Site type is defined as 'typedef list< CRef< CRegion_coordinates > > TSite'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsSite(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TSite& GetSite(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TSite& SetSite(void);
    
    
        /// Check if variant Boundary is selected.
        ///
        /// Boundary type is defined as 'typedef list< CRef< CRegion_boundary > > TBoundary'.
        /// @return
        ///   - true, if the variant is selected.
        ///   - false, otherwise.
        bool IsBoundary(void) const;
    
        /// Get the variant data.
        ///
        /// @return
        ///   Reference to the data.
        const TBoundary& GetBoundary(void) const;
    
        /// Select the variant.
        ///
        /// @return
        ///   Reference to the variant data.
        TBoundary& SetBoundary(void);
    
    
    private:
        // copy constructor and assignment operator
        C_Region(const C_Region& );
        C_Region& operator=(const C_Region& );
        // choice state
        E_Choice m_choice;
        // helper methods
        void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
    
        static const char* const sm_SelectionNames[];
        // data
        union {
            NCBI_NS_NCBI::CUnionBuffer<TSite> m_Site;
            NCBI_NS_NCBI::CUnionBuffer<TBoundary> m_Boundary;
            void* m_dummy_pointer_for_alignment;
        };
    };
    // types
    typedef CModel_id TModel_id;
    typedef C_Region TRegion;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_model_id,
        e_region
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Model_id data member.
    ///
    /// Data member Model_id is mandatory;
    /// its type is defined as 'typedef CModel_id TModel_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetModel_id(void) const;
 
    /// Check if it is safe to call GetModel_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetModel_id(void) const;
 
    /// Reset Model_id data member.
    void ResetModel_id(void);
 
    /// Get the Model_id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TModel_id& GetModel_id(void) const;
 
    /// Assign a value to Model_id data member.
    ///
    /// @param value
    ///   Value to assign
    void SetModel_id(const TModel_id& value);
 
    /// Assign a value to Model_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TModel_id& SetModel_id(void);
 
    /// Check if a value has been assigned to Region data member.
    ///
    /// Data member Region is mandatory;
    /// its type is defined as 'typedef C_Region TRegion'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRegion(void) const;
 
    /// Check if it is safe to call GetRegion method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRegion(void) const;
 
    /// Reset Region data member.
    void ResetRegion(void);
 
    /// Get the Region member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRegion& GetRegion(void) const;
 
    /// Assign a value to Region data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetRegion(TRegion& value);
 
    /// Assign a value to Region data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRegion& SetRegion(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CRegion_pntrs_Base(const CRegion_pntrs_Base&);
    CRegion_pntrs_Base& operator=(const CRegion_pntrs_Base&);
 
    // data
    Uint4 m_set_State[1];
    CModel_id m_Model_id;
    CRef< TRegion > m_Region;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CRegion_pntrs_Base::C_Region::E_Choice CRegion_pntrs_Base::C_Region::Which(void) const
{
    return m_choice;
}
 
inline
void CRegion_pntrs_Base::C_Region::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CRegion_pntrs_Base::C_Region::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 CRegion_pntrs_Base::C_Region::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CRegion_pntrs_Base::C_Region::IsSite(void) const
{
    return m_choice == e_Site;
}
 
inline
const CRegion_pntrs_Base::C_Region::TSite& CRegion_pntrs_Base::C_Region::GetSite(void) const
{
    CheckSelected(e_Site);
    return *m_Site;
}
 
inline
CRegion_pntrs_Base::C_Region::TSite& CRegion_pntrs_Base::C_Region::SetSite(void)
{
    Select(e_Site, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_Site;
}
 
inline
bool CRegion_pntrs_Base::C_Region::IsBoundary(void) const
{
    return m_choice == e_Boundary;
}
 
inline
const CRegion_pntrs_Base::C_Region::TBoundary& CRegion_pntrs_Base::C_Region::GetBoundary(void) const
{
    CheckSelected(e_Boundary);
    return *m_Boundary;
}
 
inline
CRegion_pntrs_Base::C_Region::TBoundary& CRegion_pntrs_Base::C_Region::SetBoundary(void)
{
    Select(e_Boundary, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_Boundary;
}
 
inline
bool CRegion_pntrs_Base::IsSetModel_id(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CRegion_pntrs_Base::CanGetModel_id(void) const
{
    return IsSetModel_id();
}
 
inline
void CRegion_pntrs_Base::ResetModel_id(void)
{
    m_Model_id = CModel_id(0);
    m_set_State[0] &= ~0x3;
}
 
inline
const CRegion_pntrs_Base::TModel_id& CRegion_pntrs_Base::GetModel_id(void) const
{
    if (!CanGetModel_id()) {
        ThrowUnassigned(0);
    }
    return m_Model_id;
}
 
inline
void CRegion_pntrs_Base::SetModel_id(const CRegion_pntrs_Base::TModel_id& value)
{
    m_Model_id = value;
    m_set_State[0] |= 0x3;
}
 
inline
CRegion_pntrs_Base::TModel_id& CRegion_pntrs_Base::SetModel_id(void)
{
    m_set_State[0] |= 0x1;
    return m_Model_id;
}
 
inline
bool CRegion_pntrs_Base::IsSetRegion(void) const
{
    return m_Region.NotEmpty();
}
 
inline
bool CRegion_pntrs_Base::CanGetRegion(void) const
{
    return true;
}
 
inline
const CRegion_pntrs_Base::TRegion& CRegion_pntrs_Base::GetRegion(void) const
{
    if ( !m_Region ) {
        const_cast<CRegion_pntrs_Base*>(this)->ResetRegion();
    }
    return (*m_Region);
}
 
inline
CRegion_pntrs_Base::TRegion& CRegion_pntrs_Base::SetRegion(void)
{
    if ( !m_Region ) {
        ResetRegion();
    }
    return (*m_Region);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MMDB3_REGION_PNTRS_BASE_HPP