BaseURL_.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 BaseURL_.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/docsum/docsum.asn">docsum.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/docsum/docsum.def">docsum.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_DOCSUM_BASEURL_BASE_HPP
#define OBJECTS_DOCSUM_BASEURL_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_Docsum_3_4
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///URL value from dbSNP_main.BaseURL links table. attributes provide
///             context information and URL id that is referenced within individual refSNP
///             objects.
///
/// CBaseURL_Base --
///
 
class NCBI_DOCSUM_EXPORT CBaseURL_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBaseURL_Base(void);
    // destructor
    virtual ~CBaseURL_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Attlist --
    ///
    
    class NCBI_DOCSUM_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 TUrlId;
        typedef string TResourceName;
        typedef string TResourceId;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_urlId,
            e_resourceName,
            e_resourceId
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
    
        // getters
        // setters
    
        ///Resource identifier from
        ///                             dbSNP_main.baseURL.
        /// Check if a value has been assigned to UrlId data member.
        ///
        /// Data member UrlId is optional;
        /// its type is defined as 'typedef int TUrlId'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetUrlId(void) const;
    
        /// Check if it is safe to call GetUrlId method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetUrlId(void) const;
    
        /// Reset UrlId data member.
        void ResetUrlId(void);
    
        /// Get the UrlId member data.
        ///
        /// @return
        ///   Copy of the member data.
        TUrlId GetUrlId(void) const;
    
        /// Assign a value to UrlId data member.
        ///
        /// @param value
        ///   Value to assign
        void SetUrlId(TUrlId value);
    
        /// Assign a value to UrlId data member.
        ///
        /// @return
        ///   Reference to the data value.
        TUrlId& SetUrlId(void);
    
        ///Name of linked resource
        /// Check if a value has been assigned to ResourceName data member.
        ///
        /// Data member ResourceName is optional;
        /// its type is defined as 'typedef string TResourceName'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetResourceName(void) const;
    
        /// Check if it is safe to call GetResourceName method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetResourceName(void) const;
    
        /// Reset ResourceName data member.
        void ResetResourceName(void);
    
        /// Get the ResourceName member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TResourceName& GetResourceName(void) const;
    
        /// Assign a value to ResourceName data member.
        ///
        /// @param value
        ///   Value to assign
        void SetResourceName(const TResourceName& value);
        void SetResourceName(TResourceName&& value);
    
        /// Assign a value to ResourceName data member.
        ///
        /// @return
        ///   Reference to the data value.
        TResourceName& SetResourceName(void);
    
        ///identifier expected by resource for
        ///                             URL
        /// Check if a value has been assigned to ResourceId data member.
        ///
        /// Data member ResourceId is optional;
        /// its type is defined as 'typedef string TResourceId'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetResourceId(void) const;
    
        /// Check if it is safe to call GetResourceId method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetResourceId(void) const;
    
        /// Reset ResourceId data member.
        void ResetResourceId(void);
    
        /// Get the ResourceId member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TResourceId& GetResourceId(void) const;
    
        /// Assign a value to ResourceId data member.
        ///
        /// @param value
        ///   Value to assign
        void SetResourceId(const TResourceId& value);
        void SetResourceId(TResourceId&& value);
    
        /// Assign a value to ResourceId data member.
        ///
        /// @return
        ///   Reference to the data value.
        TResourceId& SetResourceId(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_UrlId;
        string m_ResourceName;
        string m_ResourceId;
    };
    // types
    typedef C_Attlist TAttlist;
    typedef string TBaseURL;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_attlist,
        e_baseURL
    };
    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);
 
    ///URL value from dbSNP_main.BaseURL links table. attributes provide
    ///             context information and URL id that is referenced within individual refSNP
    ///             objects.
    /// Check if a value has been assigned to BaseURL data member.
    ///
    /// Data member BaseURL is mandatory;
    /// its type is defined as 'typedef string TBaseURL'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBaseURL(void) const;
 
    /// Check if it is safe to call GetBaseURL method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBaseURL(void) const;
 
    /// Reset BaseURL data member.
    void ResetBaseURL(void);
 
    /// Get the BaseURL member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBaseURL& GetBaseURL(void) const;
 
    /// Assign a value to BaseURL data member.
    ///
    /// @param value
    ///   Value to assign
    void SetBaseURL(const TBaseURL& value);
    void SetBaseURL(TBaseURL&& value);
 
    /// Assign a value to BaseURL data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBaseURL& SetBaseURL(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CBaseURL_Base(const CBaseURL_Base&);
    CBaseURL_Base& operator=(const CBaseURL_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
    string m_BaseURL;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CBaseURL_Base::C_Attlist::IsSetUrlId(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CBaseURL_Base::C_Attlist::CanGetUrlId(void) const
{
    return IsSetUrlId();
}
 
inline
void CBaseURL_Base::C_Attlist::ResetUrlId(void)
{
    m_UrlId = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CBaseURL_Base::C_Attlist::TUrlId CBaseURL_Base::C_Attlist::GetUrlId(void) const
{
    if (!CanGetUrlId()) {
        ThrowUnassigned(0);
    }
    return m_UrlId;
}
 
inline
void CBaseURL_Base::C_Attlist::SetUrlId(CBaseURL_Base::C_Attlist::TUrlId value)
{
    m_UrlId = value;
    m_set_State[0] |= 0x3;
}
 
inline
CBaseURL_Base::C_Attlist::TUrlId& CBaseURL_Base::C_Attlist::SetUrlId(void)
{
#ifdef _DEBUG
    if (!IsSetUrlId()) {
        memset(&m_UrlId,UnassignedByte(),sizeof(m_UrlId));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_UrlId;
}
 
inline
bool CBaseURL_Base::C_Attlist::IsSetResourceName(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CBaseURL_Base::C_Attlist::CanGetResourceName(void) const
{
    return IsSetResourceName();
}
 
inline
const CBaseURL_Base::C_Attlist::TResourceName& CBaseURL_Base::C_Attlist::GetResourceName(void) const
{
    if (!CanGetResourceName()) {
        ThrowUnassigned(1);
    }
    return m_ResourceName;
}
 
inline
void CBaseURL_Base::C_Attlist::SetResourceName(const CBaseURL_Base::C_Attlist::TResourceName& value)
{
    m_ResourceName = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CBaseURL_Base::C_Attlist::SetResourceName(CBaseURL_Base::C_Attlist::TResourceName&& value)
{
    m_ResourceName = std::forward<CBaseURL_Base::C_Attlist::TResourceName>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CBaseURL_Base::C_Attlist::TResourceName& CBaseURL_Base::C_Attlist::SetResourceName(void)
{
#ifdef _DEBUG
    if (!IsSetResourceName()) {
        m_ResourceName = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_ResourceName;
}
 
inline
bool CBaseURL_Base::C_Attlist::IsSetResourceId(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CBaseURL_Base::C_Attlist::CanGetResourceId(void) const
{
    return IsSetResourceId();
}
 
inline
const CBaseURL_Base::C_Attlist::TResourceId& CBaseURL_Base::C_Attlist::GetResourceId(void) const
{
    if (!CanGetResourceId()) {
        ThrowUnassigned(2);
    }
    return m_ResourceId;
}
 
inline
void CBaseURL_Base::C_Attlist::SetResourceId(const CBaseURL_Base::C_Attlist::TResourceId& value)
{
    m_ResourceId = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CBaseURL_Base::C_Attlist::SetResourceId(CBaseURL_Base::C_Attlist::TResourceId&& value)
{
    m_ResourceId = std::forward<CBaseURL_Base::C_Attlist::TResourceId>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CBaseURL_Base::C_Attlist::TResourceId& CBaseURL_Base::C_Attlist::SetResourceId(void)
{
#ifdef _DEBUG
    if (!IsSetResourceId()) {
        m_ResourceId = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_ResourceId;
}
 
inline
bool CBaseURL_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CBaseURL_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CBaseURL_Base::TAttlist& CBaseURL_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CBaseURL_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CBaseURL_Base::TAttlist& CBaseURL_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CBaseURL_Base::IsSetBaseURL(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CBaseURL_Base::CanGetBaseURL(void) const
{
    return IsSetBaseURL();
}
 
inline
const CBaseURL_Base::TBaseURL& CBaseURL_Base::GetBaseURL(void) const
{
    if (!CanGetBaseURL()) {
        ThrowUnassigned(1);
    }
    return m_BaseURL;
}
 
inline
void CBaseURL_Base::SetBaseURL(const CBaseURL_Base::TBaseURL& value)
{
    m_BaseURL = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CBaseURL_Base::SetBaseURL(CBaseURL_Base::TBaseURL&& value)
{
    m_BaseURL = std::forward<CBaseURL_Base::TBaseURL>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CBaseURL_Base::TBaseURL& CBaseURL_Base::SetBaseURL(void)
{
#ifdef _DEBUG
    if (!IsSetBaseURL()) {
        m_BaseURL = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_BaseURL;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_DOCSUM_BASEURL_BASE_HPP