Cdd_book_ref_.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 Cdd_book_ref_.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/cdd/cdd.asn">cdd.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cdd/cdd.def">cdd.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_CDD_CDD_BOOK_REF_BASE_HPP
#define OBJECTS_CDD_CDD_BOOK_REF_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_NCBI_Cdd
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// record a link to Entrez Books
///
/// CCdd_book_ref_Base --
///
 
class NCBI_CDD_EXPORT CCdd_book_ref_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CCdd_book_ref_Base(void);
    // destructor
    virtual ~CCdd_book_ref_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    enum ETextelement {
        eTextelement_unassigned =   0,  ///< type of element 
        eTextelement_section    =   1,  ///< a section or paragraph
        eTextelement_figgrp     =   2,  ///< a figure or set of figures
        eTextelement_table      =   3,  ///< a table
        eTextelement_chapter    =   4,  ///< a whole chapter
        eTextelement_biblist    =   5,  ///< a lisf of references
        eTextelement_box        =   6,  ///< an inserted box
        eTextelement_glossary   =   7,  ///< glossary
        eTextelement_appendix   =   8,  ///< appendix
        eTextelement_other      = 255
    };
    
    /// Access to ETextelement's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ETextelement)(void);
    
    // types
    typedef string TBookname;
    typedef ETextelement TTextelement;
    typedef int TElementid;
    typedef int TSubelementid;
    typedef string TCelementid;
    typedef string TCsubelementid;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_bookname,
        e_textelement,
        e_elementid,
        e_subelementid,
        e_celementid,
        e_csubelementid
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
 
    // getters
    // setters
 
    /// abbreviated book title
    /// Check if a value has been assigned to Bookname data member.
    ///
    /// Data member Bookname is mandatory;
    /// its type is defined as 'typedef string TBookname'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBookname(void) const;
 
    /// Check if it is safe to call GetBookname method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBookname(void) const;
 
    /// Reset Bookname data member.
    void ResetBookname(void);
 
    /// Get the Bookname member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBookname& GetBookname(void) const;
 
    /// Assign a value to Bookname data member.
    ///
    /// @param value
    ///   Value to assign
    void SetBookname(const TBookname& value);
    void SetBookname(TBookname&& value);
 
    /// Assign a value to Bookname data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBookname& SetBookname(void);
 
    /// Check if a value has been assigned to Textelement data member.
    ///
    /// Data member Textelement is mandatory;
    /// its type is defined as 'typedef ETextelement TTextelement'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTextelement(void) const;
 
    /// Check if it is safe to call GetTextelement method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTextelement(void) const;
 
    /// Reset Textelement data member.
    void ResetTextelement(void);
 
    /// Get the Textelement member data.
    ///
    /// @return
    ///   Copy of the member data.
    TTextelement GetTextelement(void) const;
 
    /// Assign a value to Textelement data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTextelement(TTextelement value);
 
    /// Assign a value to Textelement data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTextelement& SetTextelement(void);
 
    /// numerical address of the text-element
    /// Check if a value has been assigned to Elementid data member.
    ///
    /// Data member Elementid is optional;
    /// its type is defined as 'typedef int TElementid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetElementid(void) const;
 
    /// Check if it is safe to call GetElementid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetElementid(void) const;
 
    /// Reset Elementid data member.
    void ResetElementid(void);
 
    /// Get the Elementid member data.
    ///
    /// @return
    ///   Copy of the member data.
    TElementid GetElementid(void) const;
 
    /// Assign a value to Elementid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetElementid(TElementid value);
 
    /// Assign a value to Elementid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TElementid& SetElementid(void);
 
    /// exact address, used with section
    /// Check if a value has been assigned to Subelementid data member.
    ///
    /// Data member Subelementid is optional;
    /// its type is defined as 'typedef int TSubelementid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSubelementid(void) const;
 
    /// Check if it is safe to call GetSubelementid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSubelementid(void) const;
 
    /// Reset Subelementid data member.
    void ResetSubelementid(void);
 
    /// Get the Subelementid member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSubelementid GetSubelementid(void) const;
 
    /// Assign a value to Subelementid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSubelementid(TSubelementid value);
 
    /// Assign a value to Subelementid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSubelementid& SetSubelementid(void);
 
    /// address of the text element, if character string
    /// Check if a value has been assigned to Celementid data member.
    ///
    /// Data member Celementid is optional;
    /// its type is defined as 'typedef string TCelementid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCelementid(void) const;
 
    /// Check if it is safe to call GetCelementid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCelementid(void) const;
 
    /// Reset Celementid data member.
    void ResetCelementid(void);
 
    /// Get the Celementid member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCelementid& GetCelementid(void) const;
 
    /// Assign a value to Celementid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCelementid(const TCelementid& value);
    void SetCelementid(TCelementid&& value);
 
    /// Assign a value to Celementid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCelementid& SetCelementid(void);
 
    /// exact address, if character string
    /// Check if a value has been assigned to Csubelementid data member.
    ///
    /// Data member Csubelementid is optional;
    /// its type is defined as 'typedef string TCsubelementid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCsubelementid(void) const;
 
    /// Check if it is safe to call GetCsubelementid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCsubelementid(void) const;
 
    /// Reset Csubelementid data member.
    void ResetCsubelementid(void);
 
    /// Get the Csubelementid member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCsubelementid& GetCsubelementid(void) const;
 
    /// Assign a value to Csubelementid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCsubelementid(const TCsubelementid& value);
    void SetCsubelementid(TCsubelementid&& value);
 
    /// Assign a value to Csubelementid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCsubelementid& SetCsubelementid(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CCdd_book_ref_Base(const CCdd_book_ref_Base&);
    CCdd_book_ref_Base& operator=(const CCdd_book_ref_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Bookname;
    ETextelement m_Textelement;
    int m_Elementid;
    int m_Subelementid;
    string m_Celementid;
    string m_Csubelementid;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CCdd_book_ref_Base::IsSetBookname(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CCdd_book_ref_Base::CanGetBookname(void) const
{
    return IsSetBookname();
}
 
inline
const CCdd_book_ref_Base::TBookname& CCdd_book_ref_Base::GetBookname(void) const
{
    if (!CanGetBookname()) {
        ThrowUnassigned(0);
    }
    return m_Bookname;
}
 
inline
void CCdd_book_ref_Base::SetBookname(const CCdd_book_ref_Base::TBookname& value)
{
    m_Bookname = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CCdd_book_ref_Base::SetBookname(CCdd_book_ref_Base::TBookname&& value)
{
    m_Bookname = std::forward<CCdd_book_ref_Base::TBookname>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CCdd_book_ref_Base::TBookname& CCdd_book_ref_Base::SetBookname(void)
{
#ifdef _DEBUG
    if (!IsSetBookname()) {
        m_Bookname = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Bookname;
}
 
inline
bool CCdd_book_ref_Base::IsSetTextelement(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CCdd_book_ref_Base::CanGetTextelement(void) const
{
    return IsSetTextelement();
}
 
inline
void CCdd_book_ref_Base::ResetTextelement(void)
{
    m_Textelement = (ETextelement)(0);
    m_set_State[0] &= ~0xc;
}
 
inline
CCdd_book_ref_Base::TTextelement CCdd_book_ref_Base::GetTextelement(void) const
{
    if (!CanGetTextelement()) {
        ThrowUnassigned(1);
    }
    return m_Textelement;
}
 
inline
void CCdd_book_ref_Base::SetTextelement(CCdd_book_ref_Base::TTextelement value)
{
    m_Textelement = value;
    m_set_State[0] |= 0xc;
}
 
inline
CCdd_book_ref_Base::TTextelement& CCdd_book_ref_Base::SetTextelement(void)
{
#ifdef _DEBUG
    if (!IsSetTextelement()) {
        memset(&m_Textelement,UnassignedByte(),sizeof(m_Textelement));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Textelement;
}
 
inline
bool CCdd_book_ref_Base::IsSetElementid(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CCdd_book_ref_Base::CanGetElementid(void) const
{
    return IsSetElementid();
}
 
inline
void CCdd_book_ref_Base::ResetElementid(void)
{
    m_Elementid = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CCdd_book_ref_Base::TElementid CCdd_book_ref_Base::GetElementid(void) const
{
    if (!CanGetElementid()) {
        ThrowUnassigned(2);
    }
    return m_Elementid;
}
 
inline
void CCdd_book_ref_Base::SetElementid(CCdd_book_ref_Base::TElementid value)
{
    m_Elementid = value;
    m_set_State[0] |= 0x30;
}
 
inline
CCdd_book_ref_Base::TElementid& CCdd_book_ref_Base::SetElementid(void)
{
#ifdef _DEBUG
    if (!IsSetElementid()) {
        memset(&m_Elementid,UnassignedByte(),sizeof(m_Elementid));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Elementid;
}
 
inline
bool CCdd_book_ref_Base::IsSetSubelementid(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CCdd_book_ref_Base::CanGetSubelementid(void) const
{
    return IsSetSubelementid();
}
 
inline
void CCdd_book_ref_Base::ResetSubelementid(void)
{
    m_Subelementid = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CCdd_book_ref_Base::TSubelementid CCdd_book_ref_Base::GetSubelementid(void) const
{
    if (!CanGetSubelementid()) {
        ThrowUnassigned(3);
    }
    return m_Subelementid;
}
 
inline
void CCdd_book_ref_Base::SetSubelementid(CCdd_book_ref_Base::TSubelementid value)
{
    m_Subelementid = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CCdd_book_ref_Base::TSubelementid& CCdd_book_ref_Base::SetSubelementid(void)
{
#ifdef _DEBUG
    if (!IsSetSubelementid()) {
        memset(&m_Subelementid,UnassignedByte(),sizeof(m_Subelementid));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Subelementid;
}
 
inline
bool CCdd_book_ref_Base::IsSetCelementid(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CCdd_book_ref_Base::CanGetCelementid(void) const
{
    return IsSetCelementid();
}
 
inline
const CCdd_book_ref_Base::TCelementid& CCdd_book_ref_Base::GetCelementid(void) const
{
    if (!CanGetCelementid()) {
        ThrowUnassigned(4);
    }
    return m_Celementid;
}
 
inline
void CCdd_book_ref_Base::SetCelementid(const CCdd_book_ref_Base::TCelementid& value)
{
    m_Celementid = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CCdd_book_ref_Base::SetCelementid(CCdd_book_ref_Base::TCelementid&& value)
{
    m_Celementid = std::forward<CCdd_book_ref_Base::TCelementid>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CCdd_book_ref_Base::TCelementid& CCdd_book_ref_Base::SetCelementid(void)
{
#ifdef _DEBUG
    if (!IsSetCelementid()) {
        m_Celementid = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Celementid;
}
 
inline
bool CCdd_book_ref_Base::IsSetCsubelementid(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CCdd_book_ref_Base::CanGetCsubelementid(void) const
{
    return IsSetCsubelementid();
}
 
inline
const CCdd_book_ref_Base::TCsubelementid& CCdd_book_ref_Base::GetCsubelementid(void) const
{
    if (!CanGetCsubelementid()) {
        ThrowUnassigned(5);
    }
    return m_Csubelementid;
}
 
inline
void CCdd_book_ref_Base::SetCsubelementid(const CCdd_book_ref_Base::TCsubelementid& value)
{
    m_Csubelementid = value;
    m_set_State[0] |= 0xc00;
}
 
inline
void CCdd_book_ref_Base::SetCsubelementid(CCdd_book_ref_Base::TCsubelementid&& value)
{
    m_Csubelementid = std::forward<CCdd_book_ref_Base::TCsubelementid>(value);
    m_set_State[0] |= 0xc00;
}
 
inline
CCdd_book_ref_Base::TCsubelementid& CCdd_book_ref_Base::SetCsubelementid(void)
{
#ifdef _DEBUG
    if (!IsSetCsubelementid()) {
        m_Csubelementid = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Csubelementid;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_CDD_CDD_BOOK_REF_BASE_HPP