GBReference_.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 GBReference_.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/gbseq/gbseq.asn">gbseq.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/gbseq/gbseq.def">gbseq.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GBSEQ_GBREFERENCE_BASE_HPP
#define OBJECTS_GBSEQ_GBREFERENCE_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#include <string>
#include <objects/gbseq/GBAuthor.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 CGBXref;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GBSeq
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CGBReference_Base --
///
 
class NCBI_GBSEQ_EXPORT CGBReference_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGBReference_Base(void);
    // destructor
    virtual ~CGBReference_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TReference;
    typedef string TPosition;
    typedef list< CGBAuthor > TAuthors;
    typedef string TConsortium;
    typedef string TTitle;
    typedef string TJournal;
    typedef list< CRef< CGBXref > > TXref;
    typedef int TPubmed;
    typedef string TRemark;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_reference,
        e_position,
        e_authors,
        e_consortium,
        e_title,
        e_journal,
        e_xref,
        e_pubmed,
        e_remark
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 10> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Reference data member.
    ///
    /// Data member Reference is mandatory;
    /// its type is defined as 'typedef string TReference'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetReference(void) const;
 
    /// Check if it is safe to call GetReference method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetReference(void) const;
 
    /// Reset Reference data member.
    void ResetReference(void);
 
    /// Get the Reference member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TReference& GetReference(void) const;
 
    /// Assign a value to Reference data member.
    ///
    /// @param value
    ///   Value to assign
    void SetReference(const TReference& value);
    void SetReference(TReference&& value);
 
    /// Assign a value to Reference data member.
    ///
    /// @return
    ///   Reference to the data value.
    TReference& SetReference(void);
 
    /// Check if a value has been assigned to Position data member.
    ///
    /// Data member Position is optional;
    /// its type is defined as 'typedef string TPosition'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPosition(void) const;
 
    /// Check if it is safe to call GetPosition method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPosition(void) const;
 
    /// Reset Position data member.
    void ResetPosition(void);
 
    /// Get the Position member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPosition& GetPosition(void) const;
 
    /// Assign a value to Position data member.
    ///
    /// @param value
    ///   Value to assign
    void SetPosition(const TPosition& value);
    void SetPosition(TPosition&& value);
 
    /// Assign a value to Position data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPosition& SetPosition(void);
 
    /// Check if a value has been assigned to Authors data member.
    ///
    /// Data member Authors is optional;
    /// its type is defined as 'typedef list< CGBAuthor > TAuthors'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAuthors(void) const;
 
    /// Check if it is safe to call GetAuthors method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAuthors(void) const;
 
    /// Reset Authors data member.
    void ResetAuthors(void);
 
    /// Get the Authors member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAuthors& GetAuthors(void) const;
 
    /// Assign a value to Authors data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAuthors& SetAuthors(void);
 
    /// Check if a value has been assigned to Consortium data member.
    ///
    /// Data member Consortium is optional;
    /// its type is defined as 'typedef string TConsortium'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetConsortium(void) const;
 
    /// Check if it is safe to call GetConsortium method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetConsortium(void) const;
 
    /// Reset Consortium data member.
    void ResetConsortium(void);
 
    /// Get the Consortium member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TConsortium& GetConsortium(void) const;
 
    /// Assign a value to Consortium data member.
    ///
    /// @param value
    ///   Value to assign
    void SetConsortium(const TConsortium& value);
    void SetConsortium(TConsortium&& value);
 
    /// Assign a value to Consortium data member.
    ///
    /// @return
    ///   Reference to the data value.
    TConsortium& SetConsortium(void);
 
    /// Check if a value has been assigned to Title data member.
    ///
    /// Data member Title is optional;
    /// its type is defined as 'typedef string TTitle'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTitle(void) const;
 
    /// Check if it is safe to call GetTitle method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTitle(void) const;
 
    /// Reset Title data member.
    void ResetTitle(void);
 
    /// Get the Title member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTitle& GetTitle(void) const;
 
    /// Assign a value to Title data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTitle(const TTitle& value);
    void SetTitle(TTitle&& value);
 
    /// Assign a value to Title data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTitle& SetTitle(void);
 
    /// Check if a value has been assigned to Journal data member.
    ///
    /// Data member Journal is mandatory;
    /// its type is defined as 'typedef string TJournal'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetJournal(void) const;
 
    /// Check if it is safe to call GetJournal method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetJournal(void) const;
 
    /// Reset Journal data member.
    void ResetJournal(void);
 
    /// Get the Journal member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TJournal& GetJournal(void) const;
 
    /// Assign a value to Journal data member.
    ///
    /// @param value
    ///   Value to assign
    void SetJournal(const TJournal& value);
    void SetJournal(TJournal&& value);
 
    /// Assign a value to Journal data member.
    ///
    /// @return
    ///   Reference to the data value.
    TJournal& SetJournal(void);
 
    /// Check if a value has been assigned to Xref data member.
    ///
    /// Data member Xref is optional;
    /// its type is defined as 'typedef list< CRef< CGBXref > > 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.
    ///
    /// @return
    ///   Reference to the data value.
    TXref& SetXref(void);
 
    /// Check if a value has been assigned to Pubmed data member.
    ///
    /// Data member Pubmed is optional;
    /// its type is defined as 'typedef int TPubmed'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPubmed(void) const;
 
    /// Check if it is safe to call GetPubmed method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPubmed(void) const;
 
    /// Reset Pubmed data member.
    void ResetPubmed(void);
 
    /// Get the Pubmed member data.
    ///
    /// @return
    ///   Copy of the member data.
    TPubmed GetPubmed(void) const;
 
    /// Assign a value to Pubmed data member.
    ///
    /// @param value
    ///   Value to assign
    void SetPubmed(TPubmed value);
 
    /// Assign a value to Pubmed data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPubmed& SetPubmed(void);
 
    /// Check if a value has been assigned to Remark data member.
    ///
    /// Data member Remark is optional;
    /// its type is defined as 'typedef string TRemark'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRemark(void) const;
 
    /// Check if it is safe to call GetRemark method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRemark(void) const;
 
    /// Reset Remark data member.
    void ResetRemark(void);
 
    /// Get the Remark member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRemark& GetRemark(void) const;
 
    /// Assign a value to Remark data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRemark(const TRemark& value);
    void SetRemark(TRemark&& value);
 
    /// Assign a value to Remark data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRemark& SetRemark(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGBReference_Base(const CGBReference_Base&);
    CGBReference_Base& operator=(const CGBReference_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Reference;
    string m_Position;
    list< CGBAuthor > m_Authors;
    string m_Consortium;
    string m_Title;
    string m_Journal;
    list< CRef< CGBXref > > m_Xref;
    int m_Pubmed;
    string m_Remark;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGBReference_Base::IsSetReference(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CGBReference_Base::CanGetReference(void) const
{
    return IsSetReference();
}
 
inline
const CGBReference_Base::TReference& CGBReference_Base::GetReference(void) const
{
    if (!CanGetReference()) {
        ThrowUnassigned(0);
    }
    return m_Reference;
}
 
inline
void CGBReference_Base::SetReference(const CGBReference_Base::TReference& value)
{
    m_Reference = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CGBReference_Base::SetReference(CGBReference_Base::TReference&& value)
{
    m_Reference = std::forward<CGBReference_Base::TReference>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CGBReference_Base::TReference& CGBReference_Base::SetReference(void)
{
#ifdef _DEBUG
    if (!IsSetReference()) {
        m_Reference = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Reference;
}
 
inline
bool CGBReference_Base::IsSetPosition(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGBReference_Base::CanGetPosition(void) const
{
    return IsSetPosition();
}
 
inline
const CGBReference_Base::TPosition& CGBReference_Base::GetPosition(void) const
{
    if (!CanGetPosition()) {
        ThrowUnassigned(1);
    }
    return m_Position;
}
 
inline
void CGBReference_Base::SetPosition(const CGBReference_Base::TPosition& value)
{
    m_Position = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CGBReference_Base::SetPosition(CGBReference_Base::TPosition&& value)
{
    m_Position = std::forward<CGBReference_Base::TPosition>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CGBReference_Base::TPosition& CGBReference_Base::SetPosition(void)
{
#ifdef _DEBUG
    if (!IsSetPosition()) {
        m_Position = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Position;
}
 
inline
bool CGBReference_Base::IsSetAuthors(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGBReference_Base::CanGetAuthors(void) const
{
    return true;
}
 
inline
const CGBReference_Base::TAuthors& CGBReference_Base::GetAuthors(void) const
{
    return m_Authors;
}
 
inline
CGBReference_Base::TAuthors& CGBReference_Base::SetAuthors(void)
{
    m_set_State[0] |= 0x10;
    return m_Authors;
}
 
inline
bool CGBReference_Base::IsSetConsortium(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CGBReference_Base::CanGetConsortium(void) const
{
    return IsSetConsortium();
}
 
inline
const CGBReference_Base::TConsortium& CGBReference_Base::GetConsortium(void) const
{
    if (!CanGetConsortium()) {
        ThrowUnassigned(3);
    }
    return m_Consortium;
}
 
inline
void CGBReference_Base::SetConsortium(const CGBReference_Base::TConsortium& value)
{
    m_Consortium = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CGBReference_Base::SetConsortium(CGBReference_Base::TConsortium&& value)
{
    m_Consortium = std::forward<CGBReference_Base::TConsortium>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CGBReference_Base::TConsortium& CGBReference_Base::SetConsortium(void)
{
#ifdef _DEBUG
    if (!IsSetConsortium()) {
        m_Consortium = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Consortium;
}
 
inline
bool CGBReference_Base::IsSetTitle(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CGBReference_Base::CanGetTitle(void) const
{
    return IsSetTitle();
}
 
inline
const CGBReference_Base::TTitle& CGBReference_Base::GetTitle(void) const
{
    if (!CanGetTitle()) {
        ThrowUnassigned(4);
    }
    return m_Title;
}
 
inline
void CGBReference_Base::SetTitle(const CGBReference_Base::TTitle& value)
{
    m_Title = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CGBReference_Base::SetTitle(CGBReference_Base::TTitle&& value)
{
    m_Title = std::forward<CGBReference_Base::TTitle>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CGBReference_Base::TTitle& CGBReference_Base::SetTitle(void)
{
#ifdef _DEBUG
    if (!IsSetTitle()) {
        m_Title = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Title;
}
 
inline
bool CGBReference_Base::IsSetJournal(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CGBReference_Base::CanGetJournal(void) const
{
    return IsSetJournal();
}
 
inline
const CGBReference_Base::TJournal& CGBReference_Base::GetJournal(void) const
{
    if (!CanGetJournal()) {
        ThrowUnassigned(5);
    }
    return m_Journal;
}
 
inline
void CGBReference_Base::SetJournal(const CGBReference_Base::TJournal& value)
{
    m_Journal = value;
    m_set_State[0] |= 0xc00;
}
 
inline
void CGBReference_Base::SetJournal(CGBReference_Base::TJournal&& value)
{
    m_Journal = std::forward<CGBReference_Base::TJournal>(value);
    m_set_State[0] |= 0xc00;
}
 
inline
CGBReference_Base::TJournal& CGBReference_Base::SetJournal(void)
{
#ifdef _DEBUG
    if (!IsSetJournal()) {
        m_Journal = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Journal;
}
 
inline
bool CGBReference_Base::IsSetXref(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CGBReference_Base::CanGetXref(void) const
{
    return true;
}
 
inline
const CGBReference_Base::TXref& CGBReference_Base::GetXref(void) const
{
    return m_Xref;
}
 
inline
CGBReference_Base::TXref& CGBReference_Base::SetXref(void)
{
    m_set_State[0] |= 0x1000;
    return m_Xref;
}
 
inline
bool CGBReference_Base::IsSetPubmed(void) const
{
    return ((m_set_State[0] & 0xc000) != 0);
}
 
inline
bool CGBReference_Base::CanGetPubmed(void) const
{
    return IsSetPubmed();
}
 
inline
void CGBReference_Base::ResetPubmed(void)
{
    m_Pubmed = 0;
    m_set_State[0] &= ~0xc000;
}
 
inline
CGBReference_Base::TPubmed CGBReference_Base::GetPubmed(void) const
{
    if (!CanGetPubmed()) {
        ThrowUnassigned(7);
    }
    return m_Pubmed;
}
 
inline
void CGBReference_Base::SetPubmed(CGBReference_Base::TPubmed value)
{
    m_Pubmed = value;
    m_set_State[0] |= 0xc000;
}
 
inline
CGBReference_Base::TPubmed& CGBReference_Base::SetPubmed(void)
{
#ifdef _DEBUG
    if (!IsSetPubmed()) {
        memset(&m_Pubmed,UnassignedByte(),sizeof(m_Pubmed));
    }
#endif
    m_set_State[0] |= 0x4000;
    return m_Pubmed;
}
 
inline
bool CGBReference_Base::IsSetRemark(void) const
{
    return ((m_set_State[0] & 0x30000) != 0);
}
 
inline
bool CGBReference_Base::CanGetRemark(void) const
{
    return IsSetRemark();
}
 
inline
const CGBReference_Base::TRemark& CGBReference_Base::GetRemark(void) const
{
    if (!CanGetRemark()) {
        ThrowUnassigned(8);
    }
    return m_Remark;
}
 
inline
void CGBReference_Base::SetRemark(const CGBReference_Base::TRemark& value)
{
    m_Remark = value;
    m_set_State[0] |= 0x30000;
}
 
inline
void CGBReference_Base::SetRemark(CGBReference_Base::TRemark&& value)
{
    m_Remark = std::forward<CGBReference_Base::TRemark>(value);
    m_set_State[0] |= 0x30000;
}
 
inline
CGBReference_Base::TRemark& CGBReference_Base::SetRemark(void)
{
#ifdef _DEBUG
    if (!IsSetRemark()) {
        m_Remark = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10000;
    return m_Remark;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GBSEQ_GBREFERENCE_BASE_HPP