HG_CommentarySet_.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 HG_CommentarySet_.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/homologene/homologene.asn">homologene.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/homologene/homologene.def">homologene.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_HOMOLOGENE_HG_COMMENTARYSET_BASE_HPP
#define OBJECTS_HOMOLOGENE_HG_COMMENTARYSET_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#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::
 
 
// forward declarations
class CHG_Commentary;
 
 
// generated classes
 
 
/** @addtogroup dataspec_HomoloGene
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CHG_CommentarySet_Base --
///
 
class CHG_CommentarySet_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CHG_CommentarySet_Base(void);
    // destructor
    virtual ~CHG_CommentarySet_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int THg_id;
    typedef string TTitle;
    typedef list< CRef< CHG_Commentary > > TCommentaries;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_hg_id,
        e_title,
        e_commentaries
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Hg_id data member.
    ///
    /// Data member Hg_id is optional;
    /// its type is defined as 'typedef int THg_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetHg_id(void) const;
 
    /// Check if it is safe to call GetHg_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetHg_id(void) const;
 
    /// Reset Hg_id data member.
    void ResetHg_id(void);
 
    /// Get the Hg_id member data.
    ///
    /// @return
    ///   Copy of the member data.
    THg_id GetHg_id(void) const;
 
    /// Assign a value to Hg_id data member.
    ///
    /// @param value
    ///   Value to assign
    void SetHg_id(THg_id value);
 
    /// Assign a value to Hg_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    THg_id& SetHg_id(void);
 
    /// Check if a value has been assigned to Title data member.
    ///
    /// Data member Title is mandatory;
    /// 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 Commentaries data member.
    ///
    /// Data member Commentaries is mandatory;
    /// its type is defined as 'typedef list< CRef< CHG_Commentary > > TCommentaries'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCommentaries(void) const;
 
    /// Check if it is safe to call GetCommentaries method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCommentaries(void) const;
 
    /// Reset Commentaries data member.
    void ResetCommentaries(void);
 
    /// Get the Commentaries member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCommentaries& GetCommentaries(void) const;
 
    /// Assign a value to Commentaries data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCommentaries& SetCommentaries(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CHG_CommentarySet_Base(const CHG_CommentarySet_Base&);
    CHG_CommentarySet_Base& operator=(const CHG_CommentarySet_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Hg_id;
    string m_Title;
    list< CRef< CHG_Commentary > > m_Commentaries;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CHG_CommentarySet_Base::IsSetHg_id(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CHG_CommentarySet_Base::CanGetHg_id(void) const
{
    return IsSetHg_id();
}
 
inline
void CHG_CommentarySet_Base::ResetHg_id(void)
{
    m_Hg_id = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CHG_CommentarySet_Base::THg_id CHG_CommentarySet_Base::GetHg_id(void) const
{
    if (!CanGetHg_id()) {
        ThrowUnassigned(0);
    }
    return m_Hg_id;
}
 
inline
void CHG_CommentarySet_Base::SetHg_id(CHG_CommentarySet_Base::THg_id value)
{
    m_Hg_id = value;
    m_set_State[0] |= 0x3;
}
 
inline
CHG_CommentarySet_Base::THg_id& CHG_CommentarySet_Base::SetHg_id(void)
{
#ifdef _DEBUG
    if (!IsSetHg_id()) {
        memset(&m_Hg_id,UnassignedByte(),sizeof(m_Hg_id));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Hg_id;
}
 
inline
bool CHG_CommentarySet_Base::IsSetTitle(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CHG_CommentarySet_Base::CanGetTitle(void) const
{
    return IsSetTitle();
}
 
inline
const CHG_CommentarySet_Base::TTitle& CHG_CommentarySet_Base::GetTitle(void) const
{
    if (!CanGetTitle()) {
        ThrowUnassigned(1);
    }
    return m_Title;
}
 
inline
void CHG_CommentarySet_Base::SetTitle(const CHG_CommentarySet_Base::TTitle& value)
{
    m_Title = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CHG_CommentarySet_Base::SetTitle(CHG_CommentarySet_Base::TTitle&& value)
{
    m_Title = std::forward<CHG_CommentarySet_Base::TTitle>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CHG_CommentarySet_Base::TTitle& CHG_CommentarySet_Base::SetTitle(void)
{
#ifdef _DEBUG
    if (!IsSetTitle()) {
        m_Title = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Title;
}
 
inline
bool CHG_CommentarySet_Base::IsSetCommentaries(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CHG_CommentarySet_Base::CanGetCommentaries(void) const
{
    return true;
}
 
inline
const CHG_CommentarySet_Base::TCommentaries& CHG_CommentarySet_Base::GetCommentaries(void) const
{
    return m_Commentaries;
}
 
inline
CHG_CommentarySet_Base::TCommentaries& CHG_CommentarySet_Base::SetCommentaries(void)
{
    m_set_State[0] |= 0x10;
    return m_Commentaries;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_HOMOLOGENE_HG_COMMENTARYSET_BASE_HPP