Forall_.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 Forall_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/pubmed_mathml3.xsd">pubmed_mathml3.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/pubmed_mathml3.def">pubmed_mathml3.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJTOOLS_EUTILS_EFETCH_FORALL_BASE_HPP
#define OBJTOOLS_EUTILS_EFETCH_FORALL_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_pubmed_mathml3
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CForall_Base --
///
 
class CForall_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CForall_Base(void);
    // destructor
    virtual ~CForall_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 TId;
        typedef string TXref;
        typedef string TClass;
        typedef string TStyle;
        typedef string THref;
        typedef string TEncoding;
        typedef string TDefinitionURL;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_id,
            e_xref,
            e_class,
            e_style,
            e_href,
            e_encoding,
            e_definitionURL
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 8> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Id data member.
        ///
        /// Data member Id is optional;
        /// its type is defined as 'typedef string TId'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetId(void) const;
    
        /// Check if it is safe to call GetId method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetId(void) const;
    
        /// Reset Id data member.
        void ResetId(void);
    
        /// Get the Id member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TId& GetId(void) const;
    
        /// Assign a value to Id data member.
        ///
        /// @param value
        ///   Value to assign
        void SetId(const TId& value);
        void SetId(TId&& value);
    
        /// Assign a value to Id data member.
        ///
        /// @return
        ///   Reference to the data value.
        TId& SetId(void);
    
        /// Check if a value has been assigned to Xref data member.
        ///
        /// Data member Xref is optional;
        /// its type is defined as 'typedef string TXref'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetXref(void) const;
    
        /// Check if it is safe to call GetXref method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetXref(void) const;
    
        /// Reset Xref data member.
        void ResetXref(void);
    
        /// Get the Xref member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TXref& GetXref(void) const;
    
        /// Assign a value to Xref data member.
        ///
        /// @param value
        ///   Value to assign
        void SetXref(const TXref& value);
        void SetXref(TXref&& value);
    
        /// Assign a value to Xref data member.
        ///
        /// @return
        ///   Reference to the data value.
        TXref& SetXref(void);
    
        /// Check if a value has been assigned to Class data member.
        ///
        /// Data member Class is optional;
        /// its type is defined as 'typedef string TClass'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetClass(void) const;
    
        /// Check if it is safe to call GetClass method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetClass(void) const;
    
        /// Reset Class data member.
        void ResetClass(void);
    
        /// Get the Class member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TClass& GetClass(void) const;
    
        /// Assign a value to Class data member.
        ///
        /// @param value
        ///   Value to assign
        void SetClass(const TClass& value);
        void SetClass(TClass&& value);
    
        /// Assign a value to Class data member.
        ///
        /// @return
        ///   Reference to the data value.
        TClass& SetClass(void);
    
        /// Check if a value has been assigned to Style data member.
        ///
        /// Data member Style is optional;
        /// its type is defined as 'typedef string TStyle'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetStyle(void) const;
    
        /// Check if it is safe to call GetStyle method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetStyle(void) const;
    
        /// Reset Style data member.
        void ResetStyle(void);
    
        /// Get the Style member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TStyle& GetStyle(void) const;
    
        /// Assign a value to Style data member.
        ///
        /// @param value
        ///   Value to assign
        void SetStyle(const TStyle& value);
        void SetStyle(TStyle&& value);
    
        /// Assign a value to Style data member.
        ///
        /// @return
        ///   Reference to the data value.
        TStyle& SetStyle(void);
    
        /// Check if a value has been assigned to Href data member.
        ///
        /// Data member Href is optional;
        /// its type is defined as 'typedef string THref'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetHref(void) const;
    
        /// Check if it is safe to call GetHref method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetHref(void) const;
    
        /// Reset Href data member.
        void ResetHref(void);
    
        /// Get the Href member data.
        ///
        /// @return
        ///   Reference to the member data.
        const THref& GetHref(void) const;
    
        /// Assign a value to Href data member.
        ///
        /// @param value
        ///   Value to assign
        void SetHref(const THref& value);
        void SetHref(THref&& value);
    
        /// Assign a value to Href data member.
        ///
        /// @return
        ///   Reference to the data value.
        THref& SetHref(void);
    
        /// Check if a value has been assigned to Encoding data member.
        ///
        /// Data member Encoding is optional;
        /// its type is defined as 'typedef string TEncoding'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetEncoding(void) const;
    
        /// Check if it is safe to call GetEncoding method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetEncoding(void) const;
    
        /// Reset Encoding data member.
        void ResetEncoding(void);
    
        /// Get the Encoding member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TEncoding& GetEncoding(void) const;
    
        /// Assign a value to Encoding data member.
        ///
        /// @param value
        ///   Value to assign
        void SetEncoding(const TEncoding& value);
        void SetEncoding(TEncoding&& value);
    
        /// Assign a value to Encoding data member.
        ///
        /// @return
        ///   Reference to the data value.
        TEncoding& SetEncoding(void);
    
        /// Check if a value has been assigned to DefinitionURL data member.
        ///
        /// Data member DefinitionURL is optional;
        /// its type is defined as 'typedef string TDefinitionURL'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetDefinitionURL(void) const;
    
        /// Check if it is safe to call GetDefinitionURL method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetDefinitionURL(void) const;
    
        /// Reset DefinitionURL data member.
        void ResetDefinitionURL(void);
    
        /// Get the DefinitionURL member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TDefinitionURL& GetDefinitionURL(void) const;
    
        /// Assign a value to DefinitionURL data member.
        ///
        /// @param value
        ///   Value to assign
        void SetDefinitionURL(const TDefinitionURL& value);
        void SetDefinitionURL(TDefinitionURL&& value);
    
        /// Assign a value to DefinitionURL data member.
        ///
        /// @return
        ///   Reference to the data value.
        TDefinitionURL& SetDefinitionURL(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_Id;
        string m_Xref;
        string m_Class;
        string m_Style;
        string m_Href;
        string m_Encoding;
        string m_DefinitionURL;
    };
    // types
    typedef C_Attlist TAttlist;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_forall
    };
    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 Forall data member.
    ///
    /// Data member Forall is mandatory
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetForall(void) const;
 
    /// Check if value of Forall member is getatable.
    ///
    /// @return
    ///   - false; the data member of type 'NULL' has no value.
    bool CanGetForall(void) const;
 
    /// Reset Forall data member.
    void ResetForall(void);
 
    /// Set NULL data member (assign 'NULL' value to Forall data member).
    void SetForall(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CForall_Base(const CForall_Base&);
    CForall_Base& operator=(const CForall_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CForall_Base::C_Attlist::IsSetId(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetId(void) const
{
    return IsSetId();
}
 
inline
const CForall_Base::C_Attlist::TId& CForall_Base::C_Attlist::GetId(void) const
{
    if (!CanGetId()) {
        ThrowUnassigned(0);
    }
    return m_Id;
}
 
inline
void CForall_Base::C_Attlist::SetId(const CForall_Base::C_Attlist::TId& value)
{
    m_Id = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CForall_Base::C_Attlist::SetId(CForall_Base::C_Attlist::TId&& value)
{
    m_Id = std::forward<CForall_Base::C_Attlist::TId>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CForall_Base::C_Attlist::TId& CForall_Base::C_Attlist::SetId(void)
{
#ifdef _DEBUG
    if (!IsSetId()) {
        m_Id = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Id;
}
 
inline
bool CForall_Base::C_Attlist::IsSetXref(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetXref(void) const
{
    return IsSetXref();
}
 
inline
const CForall_Base::C_Attlist::TXref& CForall_Base::C_Attlist::GetXref(void) const
{
    if (!CanGetXref()) {
        ThrowUnassigned(1);
    }
    return m_Xref;
}
 
inline
void CForall_Base::C_Attlist::SetXref(const CForall_Base::C_Attlist::TXref& value)
{
    m_Xref = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CForall_Base::C_Attlist::SetXref(CForall_Base::C_Attlist::TXref&& value)
{
    m_Xref = std::forward<CForall_Base::C_Attlist::TXref>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CForall_Base::C_Attlist::TXref& CForall_Base::C_Attlist::SetXref(void)
{
#ifdef _DEBUG
    if (!IsSetXref()) {
        m_Xref = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Xref;
}
 
inline
bool CForall_Base::C_Attlist::IsSetClass(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetClass(void) const
{
    return IsSetClass();
}
 
inline
const CForall_Base::C_Attlist::TClass& CForall_Base::C_Attlist::GetClass(void) const
{
    if (!CanGetClass()) {
        ThrowUnassigned(2);
    }
    return m_Class;
}
 
inline
void CForall_Base::C_Attlist::SetClass(const CForall_Base::C_Attlist::TClass& value)
{
    m_Class = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CForall_Base::C_Attlist::SetClass(CForall_Base::C_Attlist::TClass&& value)
{
    m_Class = std::forward<CForall_Base::C_Attlist::TClass>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CForall_Base::C_Attlist::TClass& CForall_Base::C_Attlist::SetClass(void)
{
#ifdef _DEBUG
    if (!IsSetClass()) {
        m_Class = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Class;
}
 
inline
bool CForall_Base::C_Attlist::IsSetStyle(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetStyle(void) const
{
    return IsSetStyle();
}
 
inline
const CForall_Base::C_Attlist::TStyle& CForall_Base::C_Attlist::GetStyle(void) const
{
    if (!CanGetStyle()) {
        ThrowUnassigned(3);
    }
    return m_Style;
}
 
inline
void CForall_Base::C_Attlist::SetStyle(const CForall_Base::C_Attlist::TStyle& value)
{
    m_Style = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CForall_Base::C_Attlist::SetStyle(CForall_Base::C_Attlist::TStyle&& value)
{
    m_Style = std::forward<CForall_Base::C_Attlist::TStyle>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CForall_Base::C_Attlist::TStyle& CForall_Base::C_Attlist::SetStyle(void)
{
#ifdef _DEBUG
    if (!IsSetStyle()) {
        m_Style = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Style;
}
 
inline
bool CForall_Base::C_Attlist::IsSetHref(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetHref(void) const
{
    return IsSetHref();
}
 
inline
const CForall_Base::C_Attlist::THref& CForall_Base::C_Attlist::GetHref(void) const
{
    if (!CanGetHref()) {
        ThrowUnassigned(4);
    }
    return m_Href;
}
 
inline
void CForall_Base::C_Attlist::SetHref(const CForall_Base::C_Attlist::THref& value)
{
    m_Href = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CForall_Base::C_Attlist::SetHref(CForall_Base::C_Attlist::THref&& value)
{
    m_Href = std::forward<CForall_Base::C_Attlist::THref>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CForall_Base::C_Attlist::THref& CForall_Base::C_Attlist::SetHref(void)
{
#ifdef _DEBUG
    if (!IsSetHref()) {
        m_Href = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Href;
}
 
inline
bool CForall_Base::C_Attlist::IsSetEncoding(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetEncoding(void) const
{
    return IsSetEncoding();
}
 
inline
const CForall_Base::C_Attlist::TEncoding& CForall_Base::C_Attlist::GetEncoding(void) const
{
    if (!CanGetEncoding()) {
        ThrowUnassigned(5);
    }
    return m_Encoding;
}
 
inline
void CForall_Base::C_Attlist::SetEncoding(const CForall_Base::C_Attlist::TEncoding& value)
{
    m_Encoding = value;
    m_set_State[0] |= 0xc00;
}
 
inline
void CForall_Base::C_Attlist::SetEncoding(CForall_Base::C_Attlist::TEncoding&& value)
{
    m_Encoding = std::forward<CForall_Base::C_Attlist::TEncoding>(value);
    m_set_State[0] |= 0xc00;
}
 
inline
CForall_Base::C_Attlist::TEncoding& CForall_Base::C_Attlist::SetEncoding(void)
{
#ifdef _DEBUG
    if (!IsSetEncoding()) {
        m_Encoding = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Encoding;
}
 
inline
bool CForall_Base::C_Attlist::IsSetDefinitionURL(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CForall_Base::C_Attlist::CanGetDefinitionURL(void) const
{
    return IsSetDefinitionURL();
}
 
inline
const CForall_Base::C_Attlist::TDefinitionURL& CForall_Base::C_Attlist::GetDefinitionURL(void) const
{
    if (!CanGetDefinitionURL()) {
        ThrowUnassigned(6);
    }
    return m_DefinitionURL;
}
 
inline
void CForall_Base::C_Attlist::SetDefinitionURL(const CForall_Base::C_Attlist::TDefinitionURL& value)
{
    m_DefinitionURL = value;
    m_set_State[0] |= 0x3000;
}
 
inline
void CForall_Base::C_Attlist::SetDefinitionURL(CForall_Base::C_Attlist::TDefinitionURL&& value)
{
    m_DefinitionURL = std::forward<CForall_Base::C_Attlist::TDefinitionURL>(value);
    m_set_State[0] |= 0x3000;
}
 
inline
CForall_Base::C_Attlist::TDefinitionURL& CForall_Base::C_Attlist::SetDefinitionURL(void)
{
#ifdef _DEBUG
    if (!IsSetDefinitionURL()) {
        m_DefinitionURL = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1000;
    return m_DefinitionURL;
}
 
inline
bool CForall_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CForall_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CForall_Base::TAttlist& CForall_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CForall_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CForall_Base::TAttlist& CForall_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    SetForall();
    return (*m_Attlist);
}
 
inline
bool CForall_Base::IsSetForall(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CForall_Base::CanGetForall(void) const
{
    return false;
}
 
inline
void CForall_Base::ResetForall(void)
{
    m_set_State[0] &= ~0xc;
}
 
inline
void CForall_Base::SetForall(void)
{
    m_set_State[0] |= 0xc;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJTOOLS_EUTILS_EFETCH_FORALL_BASE_HPP