Declare_.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 Declare_.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_DECLARE_BASE_HPP
#define OBJTOOLS_EUTILS_EFETCH_DECLARE_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <string>
#include <objtools/eutils/efetch/ContExp.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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_pubmed_mathml3
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CDeclare_Base --
///
 
class CDeclare_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CDeclare_Base(void);
    // destructor
    virtual ~CDeclare_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();
    
        enum EAttlist_occurrence {
            eAttlist_occurrence_prefix         = 1,
            eAttlist_occurrence_infix          = 2,
            eAttlist_occurrence_function_model = 3
        };
        
        /// Access to EAttlist_occurrence's attributes (values, names) as defined in spec
        static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EAttlist_occurrence)(void);
        
        // types
        typedef string TType;
        typedef string TScope;
        typedef string TNargs;
        typedef EAttlist_occurrence TOccurrence;
        typedef string TEncoding;
        typedef string TDefinitionURL;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_type,
            e_scope,
            e_nargs,
            e_occurrence,
            e_encoding,
            e_definitionURL
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Type data member.
        ///
        /// Data member Type is optional;
        /// its type is defined as 'typedef string TType'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetType(void) const;
    
        /// Check if it is safe to call GetType method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetType(void) const;
    
        /// Reset Type data member.
        void ResetType(void);
    
        /// Get the Type member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TType& GetType(void) const;
    
        /// Assign a value to Type data member.
        ///
        /// @param value
        ///   Value to assign
        void SetType(const TType& value);
        void SetType(TType&& value);
    
        /// Assign a value to Type data member.
        ///
        /// @return
        ///   Reference to the data value.
        TType& SetType(void);
    
        /// Check if a value has been assigned to Scope data member.
        ///
        /// Data member Scope is optional;
        /// its type is defined as 'typedef string TScope'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetScope(void) const;
    
        /// Check if it is safe to call GetScope method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetScope(void) const;
    
        /// Reset Scope data member.
        void ResetScope(void);
    
        /// Get the Scope member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TScope& GetScope(void) const;
    
        /// Assign a value to Scope data member.
        ///
        /// @param value
        ///   Value to assign
        void SetScope(const TScope& value);
        void SetScope(TScope&& value);
    
        /// Assign a value to Scope data member.
        ///
        /// @return
        ///   Reference to the data value.
        TScope& SetScope(void);
    
        /// Check if a value has been assigned to Nargs data member.
        ///
        /// Data member Nargs is optional;
        /// its type is defined as 'typedef string TNargs'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetNargs(void) const;
    
        /// Check if it is safe to call GetNargs method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetNargs(void) const;
    
        /// Reset Nargs data member.
        void ResetNargs(void);
    
        /// Get the Nargs member data.
        ///
        /// @return
        ///   Reference to the member data.
        const TNargs& GetNargs(void) const;
    
        /// Assign a value to Nargs data member.
        ///
        /// @param value
        ///   Value to assign
        void SetNargs(const TNargs& value);
        void SetNargs(TNargs&& value);
    
        /// Assign a value to Nargs data member.
        ///
        /// @return
        ///   Reference to the data value.
        TNargs& SetNargs(void);
    
        /// Check if a value has been assigned to Occurrence data member.
        ///
        /// Data member Occurrence is optional;
        /// its type is defined as 'typedef EAttlist_occurrence TOccurrence'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetOccurrence(void) const;
    
        /// Check if it is safe to call GetOccurrence method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetOccurrence(void) const;
    
        /// Reset Occurrence data member.
        void ResetOccurrence(void);
    
        /// Get the Occurrence member data.
        ///
        /// @return
        ///   Copy of the member data.
        TOccurrence GetOccurrence(void) const;
    
        /// Assign a value to Occurrence data member.
        ///
        /// @param value
        ///   Value to assign
        void SetOccurrence(TOccurrence value);
    
        /// Assign a value to Occurrence data member.
        ///
        /// @return
        ///   Reference to the data value.
        TOccurrence& SetOccurrence(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_Type;
        string m_Scope;
        string m_Nargs;
        EAttlist_occurrence m_Occurrence;
        string m_Encoding;
        string m_DefinitionURL;
    };
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_E_ContExp --
    ///
    
    class C_E_ContExp : public CContExp
    {
        typedef CContExp Tparent;
    public:
        C_E_ContExp(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
    };
    // types
    typedef C_Attlist TAttlist;
    typedef list< CRef< C_E_ContExp > > TContExp;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Attlist,
        e_ContExp
    };
    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 ContExp data member.
    ///
    /// Data member ContExp is mandatory;
    /// its type is defined as 'typedef list< CRef< C_E_ContExp > > TContExp'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetContExp(void) const;
 
    /// Check if it is safe to call GetContExp method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetContExp(void) const;
 
    /// Reset ContExp data member.
    void ResetContExp(void);
 
    /// Get the ContExp member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TContExp& GetContExp(void) const;
 
    /// Assign a value to ContExp data member.
    ///
    /// @return
    ///   Reference to the data value.
    TContExp& SetContExp(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CDeclare_Base(const CDeclare_Base&);
    CDeclare_Base& operator=(const CDeclare_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAttlist > m_Attlist;
    list< CRef< C_E_ContExp > > m_ContExp;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CDeclare_Base::C_Attlist::IsSetType(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CDeclare_Base::C_Attlist::CanGetType(void) const
{
    return IsSetType();
}
 
inline
const CDeclare_Base::C_Attlist::TType& CDeclare_Base::C_Attlist::GetType(void) const
{
    if (!CanGetType()) {
        ThrowUnassigned(0);
    }
    return m_Type;
}
 
inline
void CDeclare_Base::C_Attlist::SetType(const CDeclare_Base::C_Attlist::TType& value)
{
    m_Type = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CDeclare_Base::C_Attlist::SetType(CDeclare_Base::C_Attlist::TType&& value)
{
    m_Type = std::forward<CDeclare_Base::C_Attlist::TType>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CDeclare_Base::C_Attlist::TType& CDeclare_Base::C_Attlist::SetType(void)
{
#ifdef _DEBUG
    if (!IsSetType()) {
        m_Type = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Type;
}
 
inline
bool CDeclare_Base::C_Attlist::IsSetScope(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CDeclare_Base::C_Attlist::CanGetScope(void) const
{
    return IsSetScope();
}
 
inline
const CDeclare_Base::C_Attlist::TScope& CDeclare_Base::C_Attlist::GetScope(void) const
{
    if (!CanGetScope()) {
        ThrowUnassigned(1);
    }
    return m_Scope;
}
 
inline
void CDeclare_Base::C_Attlist::SetScope(const CDeclare_Base::C_Attlist::TScope& value)
{
    m_Scope = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CDeclare_Base::C_Attlist::SetScope(CDeclare_Base::C_Attlist::TScope&& value)
{
    m_Scope = std::forward<CDeclare_Base::C_Attlist::TScope>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CDeclare_Base::C_Attlist::TScope& CDeclare_Base::C_Attlist::SetScope(void)
{
#ifdef _DEBUG
    if (!IsSetScope()) {
        m_Scope = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Scope;
}
 
inline
bool CDeclare_Base::C_Attlist::IsSetNargs(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CDeclare_Base::C_Attlist::CanGetNargs(void) const
{
    return IsSetNargs();
}
 
inline
const CDeclare_Base::C_Attlist::TNargs& CDeclare_Base::C_Attlist::GetNargs(void) const
{
    if (!CanGetNargs()) {
        ThrowUnassigned(2);
    }
    return m_Nargs;
}
 
inline
void CDeclare_Base::C_Attlist::SetNargs(const CDeclare_Base::C_Attlist::TNargs& value)
{
    m_Nargs = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CDeclare_Base::C_Attlist::SetNargs(CDeclare_Base::C_Attlist::TNargs&& value)
{
    m_Nargs = std::forward<CDeclare_Base::C_Attlist::TNargs>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CDeclare_Base::C_Attlist::TNargs& CDeclare_Base::C_Attlist::SetNargs(void)
{
#ifdef _DEBUG
    if (!IsSetNargs()) {
        m_Nargs = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Nargs;
}
 
inline
bool CDeclare_Base::C_Attlist::IsSetOccurrence(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CDeclare_Base::C_Attlist::CanGetOccurrence(void) const
{
    return IsSetOccurrence();
}
 
inline
void CDeclare_Base::C_Attlist::ResetOccurrence(void)
{
    m_Occurrence = (EAttlist_occurrence)(0);
    m_set_State[0] &= ~0xc0;
}
 
inline
CDeclare_Base::C_Attlist::TOccurrence CDeclare_Base::C_Attlist::GetOccurrence(void) const
{
    if (!CanGetOccurrence()) {
        ThrowUnassigned(3);
    }
    return m_Occurrence;
}
 
inline
void CDeclare_Base::C_Attlist::SetOccurrence(CDeclare_Base::C_Attlist::TOccurrence value)
{
    m_Occurrence = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CDeclare_Base::C_Attlist::TOccurrence& CDeclare_Base::C_Attlist::SetOccurrence(void)
{
#ifdef _DEBUG
    if (!IsSetOccurrence()) {
        memset(&m_Occurrence,UnassignedByte(),sizeof(m_Occurrence));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Occurrence;
}
 
inline
bool CDeclare_Base::C_Attlist::IsSetEncoding(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CDeclare_Base::C_Attlist::CanGetEncoding(void) const
{
    return IsSetEncoding();
}
 
inline
const CDeclare_Base::C_Attlist::TEncoding& CDeclare_Base::C_Attlist::GetEncoding(void) const
{
    if (!CanGetEncoding()) {
        ThrowUnassigned(4);
    }
    return m_Encoding;
}
 
inline
void CDeclare_Base::C_Attlist::SetEncoding(const CDeclare_Base::C_Attlist::TEncoding& value)
{
    m_Encoding = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CDeclare_Base::C_Attlist::SetEncoding(CDeclare_Base::C_Attlist::TEncoding&& value)
{
    m_Encoding = std::forward<CDeclare_Base::C_Attlist::TEncoding>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CDeclare_Base::C_Attlist::TEncoding& CDeclare_Base::C_Attlist::SetEncoding(void)
{
#ifdef _DEBUG
    if (!IsSetEncoding()) {
        m_Encoding = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Encoding;
}
 
inline
bool CDeclare_Base::C_Attlist::IsSetDefinitionURL(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CDeclare_Base::C_Attlist::CanGetDefinitionURL(void) const
{
    return IsSetDefinitionURL();
}
 
inline
const CDeclare_Base::C_Attlist::TDefinitionURL& CDeclare_Base::C_Attlist::GetDefinitionURL(void) const
{
    if (!CanGetDefinitionURL()) {
        ThrowUnassigned(5);
    }
    return m_DefinitionURL;
}
 
inline
void CDeclare_Base::C_Attlist::SetDefinitionURL(const CDeclare_Base::C_Attlist::TDefinitionURL& value)
{
    m_DefinitionURL = value;
    m_set_State[0] |= 0xc00;
}
 
inline
void CDeclare_Base::C_Attlist::SetDefinitionURL(CDeclare_Base::C_Attlist::TDefinitionURL&& value)
{
    m_DefinitionURL = std::forward<CDeclare_Base::C_Attlist::TDefinitionURL>(value);
    m_set_State[0] |= 0xc00;
}
 
inline
CDeclare_Base::C_Attlist::TDefinitionURL& CDeclare_Base::C_Attlist::SetDefinitionURL(void)
{
#ifdef _DEBUG
    if (!IsSetDefinitionURL()) {
        m_DefinitionURL = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x400;
    return m_DefinitionURL;
}
 
inline
CDeclare_Base::C_E_ContExp::C_E_ContExp(void)
{
}
 
inline
bool CDeclare_Base::IsSetAttlist(void) const
{
    return m_Attlist.NotEmpty();
}
 
inline
bool CDeclare_Base::CanGetAttlist(void) const
{
    return true;
}
 
inline
const CDeclare_Base::TAttlist& CDeclare_Base::GetAttlist(void) const
{
    if ( !m_Attlist ) {
        const_cast<CDeclare_Base*>(this)->ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
CDeclare_Base::TAttlist& CDeclare_Base::SetAttlist(void)
{
    if ( !m_Attlist ) {
        ResetAttlist();
    }
    return (*m_Attlist);
}
 
inline
bool CDeclare_Base::IsSetContExp(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CDeclare_Base::CanGetContExp(void) const
{
    return true;
}
 
inline
const CDeclare_Base::TContExp& CDeclare_Base::GetContExp(void) const
{
    return m_ContExp;
}
 
inline
CDeclare_Base::TContExp& CDeclare_Base::SetContExp(void)
{
    m_set_State[0] |= 0x4;
    return m_ContExp;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJTOOLS_EUTILS_EFETCH_DECLARE_BASE_HPP