Submit_block_.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 Submit_block_.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/submit/submit.asn">submit.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/submit/submit.def">submit.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SUBMIT_SUBMIT_BLOCK_BASE_HPP
#define OBJECTS_SUBMIT_SUBMIT_BLOCK_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::
 
 
// forward declarations
class CCit_sub;
class CContact_info;
class CDate;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Submit
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CSubmit_block_Base --
///
 
class NCBI_SUBMIT_EXPORT CSubmit_block_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CSubmit_block_Base(void);
    // destructor
    virtual ~CSubmit_block_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /// type of submission
    enum ESubtype {
        eSubtype_new      =   1,  ///< new data
        eSubtype_update   =   2,  ///< update by author
        eSubtype_revision =   3,  ///< 3rd party (non-author) update
        eSubtype_other    = 255
    };
    
    /// Access to ESubtype's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ESubtype)(void);
    
    // types
    typedef CContact_info TContact;
    typedef CCit_sub TCit;
    typedef bool THup;
    typedef CDate TReldate;
    typedef int TSubtype;
    typedef string TTool;
    typedef string TUser_tag;
    typedef string TComment;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_contact,
        e_cit,
        e_hup,
        e_reldate,
        e_subtype,
        e_tool,
        e_user_tag,
        e_comment
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 9> TmemberIndex;
 
    // getters
    // setters
 
    /// who to contact
    /// Check if a value has been assigned to Contact data member.
    ///
    /// Data member Contact is mandatory;
    /// its type is defined as 'typedef CContact_info TContact'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetContact(void) const;
 
    /// Check if it is safe to call GetContact method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetContact(void) const;
 
    /// Reset Contact data member.
    void ResetContact(void);
 
    /// Get the Contact member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TContact& GetContact(void) const;
 
    /// Assign a value to Contact data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetContact(TContact& value);
 
    /// Assign a value to Contact data member.
    ///
    /// @return
    ///   Reference to the data value.
    TContact& SetContact(void);
 
    /// citation for this submission
    /// Check if a value has been assigned to Cit data member.
    ///
    /// Data member Cit is mandatory;
    /// its type is defined as 'typedef CCit_sub TCit'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCit(void) const;
 
    /// Check if it is safe to call GetCit method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCit(void) const;
 
    /// Reset Cit data member.
    void ResetCit(void);
 
    /// Get the Cit member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCit& GetCit(void) const;
 
    /// Assign a value to Cit data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetCit(TCit& value);
 
    /// Assign a value to Cit data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCit& SetCit(void);
 
    /// hold until publish
    /// Check if a value has been assigned to Hup data member.
    ///
    /// Data member Hup is optional with default false;
    /// its type is defined as 'typedef bool THup'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetHup(void) const;
 
    /// Check if it is safe to call GetHup method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetHup(void) const;
 
    /// Reset Hup data member.
    void ResetHup(void);
 
    /// Assign default value to Hup data member.
    void SetDefaultHup(void);
 
    /// Get the Hup member data.
    ///
    /// @return
    ///   Copy of the member data.
    THup GetHup(void) const;
 
    /// Assign a value to Hup data member.
    ///
    /// @param value
    ///   Value to assign
    void SetHup(THup value);
 
    /// Assign a value to Hup data member.
    ///
    /// @return
    ///   Reference to the data value.
    THup& SetHup(void);
 
    /// release by date
    /// Check if a value has been assigned to Reldate data member.
    ///
    /// Data member Reldate is optional;
    /// its type is defined as 'typedef CDate TReldate'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetReldate(void) const;
 
    /// Check if it is safe to call GetReldate method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetReldate(void) const;
 
    /// Reset Reldate data member.
    void ResetReldate(void);
 
    /// Get the Reldate member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TReldate& GetReldate(void) const;
 
    /// Assign a value to Reldate data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetReldate(TReldate& value);
 
    /// Assign a value to Reldate data member.
    ///
    /// @return
    ///   Reference to the data value.
    TReldate& SetReldate(void);
 
    /// Check if a value has been assigned to Subtype data member.
    ///
    /// Data member Subtype is optional;
    /// its type is defined as 'typedef int TSubtype'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSubtype(void) const;
 
    /// Check if it is safe to call GetSubtype method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSubtype(void) const;
 
    /// Reset Subtype data member.
    void ResetSubtype(void);
 
    /// Get the Subtype member data.
    ///
    /// @return
    ///   Copy of the member data.
    TSubtype GetSubtype(void) const;
 
    /// Assign a value to Subtype data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSubtype(TSubtype value);
 
    /// Assign a value to Subtype data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSubtype& SetSubtype(void);
 
    /// tool used to make submission
    /// Check if a value has been assigned to Tool data member.
    ///
    /// Data member Tool is optional;
    /// its type is defined as 'typedef string TTool'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTool(void) const;
 
    /// Check if it is safe to call GetTool method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTool(void) const;
 
    /// Reset Tool data member.
    void ResetTool(void);
 
    /// Get the Tool member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTool& GetTool(void) const;
 
    /// Assign a value to Tool data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTool(const TTool& value);
    void SetTool(TTool&& value);
 
    /// Assign a value to Tool data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTool& SetTool(void);
 
    /// user supplied id for this submission
    /// Check if a value has been assigned to User_tag data member.
    ///
    /// Data member User_tag is optional;
    /// its type is defined as 'typedef string TUser_tag'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUser_tag(void) const;
 
    /// Check if it is safe to call GetUser_tag method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUser_tag(void) const;
 
    /// Reset User_tag data member.
    void ResetUser_tag(void);
 
    /// Get the User_tag member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUser_tag& GetUser_tag(void) const;
 
    /// Assign a value to User_tag data member.
    ///
    /// @param value
    ///   Value to assign
    void SetUser_tag(const TUser_tag& value);
    void SetUser_tag(TUser_tag&& value);
 
    /// Assign a value to User_tag data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUser_tag& SetUser_tag(void);
 
    /// user comments/advice to database
    /// Check if a value has been assigned to Comment data member.
    ///
    /// Data member Comment is optional;
    /// its type is defined as 'typedef string TComment'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetComment(void) const;
 
    /// Check if it is safe to call GetComment method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetComment(void) const;
 
    /// Reset Comment data member.
    void ResetComment(void);
 
    /// Get the Comment member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TComment& GetComment(void) const;
 
    /// Assign a value to Comment data member.
    ///
    /// @param value
    ///   Value to assign
    void SetComment(const TComment& value);
    void SetComment(TComment&& value);
 
    /// Assign a value to Comment data member.
    ///
    /// @return
    ///   Reference to the data value.
    TComment& SetComment(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CSubmit_block_Base(const CSubmit_block_Base&);
    CSubmit_block_Base& operator=(const CSubmit_block_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TContact > m_Contact;
    CRef< TCit > m_Cit;
    bool m_Hup;
    CRef< TReldate > m_Reldate;
    int m_Subtype;
    string m_Tool;
    string m_User_tag;
    string m_Comment;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CSubmit_block_Base::IsSetContact(void) const
{
    return m_Contact.NotEmpty();
}
 
inline
bool CSubmit_block_Base::CanGetContact(void) const
{
    return true;
}
 
inline
const CSubmit_block_Base::TContact& CSubmit_block_Base::GetContact(void) const
{
    if ( !m_Contact ) {
        const_cast<CSubmit_block_Base*>(this)->ResetContact();
    }
    return (*m_Contact);
}
 
inline
CSubmit_block_Base::TContact& CSubmit_block_Base::SetContact(void)
{
    if ( !m_Contact ) {
        ResetContact();
    }
    return (*m_Contact);
}
 
inline
bool CSubmit_block_Base::IsSetCit(void) const
{
    return m_Cit.NotEmpty();
}
 
inline
bool CSubmit_block_Base::CanGetCit(void) const
{
    return true;
}
 
inline
const CSubmit_block_Base::TCit& CSubmit_block_Base::GetCit(void) const
{
    if ( !m_Cit ) {
        const_cast<CSubmit_block_Base*>(this)->ResetCit();
    }
    return (*m_Cit);
}
 
inline
CSubmit_block_Base::TCit& CSubmit_block_Base::SetCit(void)
{
    if ( !m_Cit ) {
        ResetCit();
    }
    return (*m_Cit);
}
 
inline
bool CSubmit_block_Base::IsSetHup(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CSubmit_block_Base::CanGetHup(void) const
{
    return true;
}
 
inline
void CSubmit_block_Base::ResetHup(void)
{
    m_Hup = false;
    m_set_State[0] &= ~0x30;
}
 
inline
void CSubmit_block_Base::SetDefaultHup(void)
{
    ResetHup();
}
 
inline
CSubmit_block_Base::THup CSubmit_block_Base::GetHup(void) const
{
    return m_Hup;
}
 
inline
void CSubmit_block_Base::SetHup(CSubmit_block_Base::THup value)
{
    m_Hup = value;
    m_set_State[0] |= 0x30;
}
 
inline
CSubmit_block_Base::THup& CSubmit_block_Base::SetHup(void)
{
#ifdef _DEBUG
    if (!IsSetHup()) {
        memset(&m_Hup,UnassignedByte(),sizeof(m_Hup));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Hup;
}
 
inline
bool CSubmit_block_Base::IsSetReldate(void) const
{
    return m_Reldate.NotEmpty();
}
 
inline
bool CSubmit_block_Base::CanGetReldate(void) const
{
    return IsSetReldate();
}
 
inline
const CSubmit_block_Base::TReldate& CSubmit_block_Base::GetReldate(void) const
{
    if (!CanGetReldate()) {
        ThrowUnassigned(3);
    }
    return (*m_Reldate);
}
 
inline
bool CSubmit_block_Base::IsSetSubtype(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CSubmit_block_Base::CanGetSubtype(void) const
{
    return IsSetSubtype();
}
 
inline
void CSubmit_block_Base::ResetSubtype(void)
{
    m_Subtype = (ESubtype)(0);
    m_set_State[0] &= ~0x300;
}
 
inline
CSubmit_block_Base::TSubtype CSubmit_block_Base::GetSubtype(void) const
{
    if (!CanGetSubtype()) {
        ThrowUnassigned(4);
    }
    return m_Subtype;
}
 
inline
void CSubmit_block_Base::SetSubtype(CSubmit_block_Base::TSubtype value)
{
    m_Subtype = value;
    m_set_State[0] |= 0x300;
}
 
inline
CSubmit_block_Base::TSubtype& CSubmit_block_Base::SetSubtype(void)
{
#ifdef _DEBUG
    if (!IsSetSubtype()) {
        memset(&m_Subtype,UnassignedByte(),sizeof(m_Subtype));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Subtype;
}
 
inline
bool CSubmit_block_Base::IsSetTool(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CSubmit_block_Base::CanGetTool(void) const
{
    return IsSetTool();
}
 
inline
const CSubmit_block_Base::TTool& CSubmit_block_Base::GetTool(void) const
{
    if (!CanGetTool()) {
        ThrowUnassigned(5);
    }
    return m_Tool;
}
 
inline
void CSubmit_block_Base::SetTool(const CSubmit_block_Base::TTool& value)
{
    m_Tool = value;
    m_set_State[0] |= 0xc00;
}
 
inline
void CSubmit_block_Base::SetTool(CSubmit_block_Base::TTool&& value)
{
    m_Tool = std::forward<CSubmit_block_Base::TTool>(value);
    m_set_State[0] |= 0xc00;
}
 
inline
CSubmit_block_Base::TTool& CSubmit_block_Base::SetTool(void)
{
#ifdef _DEBUG
    if (!IsSetTool()) {
        m_Tool = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Tool;
}
 
inline
bool CSubmit_block_Base::IsSetUser_tag(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CSubmit_block_Base::CanGetUser_tag(void) const
{
    return IsSetUser_tag();
}
 
inline
const CSubmit_block_Base::TUser_tag& CSubmit_block_Base::GetUser_tag(void) const
{
    if (!CanGetUser_tag()) {
        ThrowUnassigned(6);
    }
    return m_User_tag;
}
 
inline
void CSubmit_block_Base::SetUser_tag(const CSubmit_block_Base::TUser_tag& value)
{
    m_User_tag = value;
    m_set_State[0] |= 0x3000;
}
 
inline
void CSubmit_block_Base::SetUser_tag(CSubmit_block_Base::TUser_tag&& value)
{
    m_User_tag = std::forward<CSubmit_block_Base::TUser_tag>(value);
    m_set_State[0] |= 0x3000;
}
 
inline
CSubmit_block_Base::TUser_tag& CSubmit_block_Base::SetUser_tag(void)
{
#ifdef _DEBUG
    if (!IsSetUser_tag()) {
        m_User_tag = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1000;
    return m_User_tag;
}
 
inline
bool CSubmit_block_Base::IsSetComment(void) const
{
    return ((m_set_State[0] & 0xc000) != 0);
}
 
inline
bool CSubmit_block_Base::CanGetComment(void) const
{
    return IsSetComment();
}
 
inline
const CSubmit_block_Base::TComment& CSubmit_block_Base::GetComment(void) const
{
    if (!CanGetComment()) {
        ThrowUnassigned(7);
    }
    return m_Comment;
}
 
inline
void CSubmit_block_Base::SetComment(const CSubmit_block_Base::TComment& value)
{
    m_Comment = value;
    m_set_State[0] |= 0xc000;
}
 
inline
void CSubmit_block_Base::SetComment(CSubmit_block_Base::TComment&& value)
{
    m_Comment = std::forward<CSubmit_block_Base::TComment>(value);
    m_set_State[0] |= 0xc000;
}
 
inline
CSubmit_block_Base::TComment& CSubmit_block_Base::SetComment(void)
{
#ifdef _DEBUG
    if (!IsSetComment()) {
        m_Comment = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4000;
    return m_Comment;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SUBMIT_SUBMIT_BLOCK_BASE_HPP