Cit_sub_.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 Cit_sub_.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/biblio/biblio.asn">biblio.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/biblio/biblio.def">biblio.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_BIBLIO_CIT_SUB_BASE_HPP
#define OBJECTS_BIBLIO_CIT_SUB_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 CAuth_list;
class CDate;
class CImprint;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Biblio
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// NOTE: this is just to cite a
/// direct data submission, see NCBI-Submit
/// for the form of a sequence submission
/// citation for a direct submission
///
/// CCit_sub_Base --
///
 
class NCBI_BIBLIO_EXPORT CCit_sub_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CCit_sub_Base(void);
    // destructor
    virtual ~CCit_sub_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /// medium of submission
    enum EMedium {
        eMedium_paper  =   1,
        eMedium_tape   =   2,
        eMedium_floppy =   3,
        eMedium_email  =   4,
        eMedium_other  = 255
    };
    
    /// Access to EMedium's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EMedium)(void);
    
    // types
    typedef CAuth_list TAuthors;
    typedef CImprint TImp;
    typedef EMedium TMedium;
    typedef CDate TDate;
    typedef string TDescr;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_authors,
        e_imp,
        e_medium,
        e_date,
        e_descr
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// not necessarily authors of the paper
    /// Check if a value has been assigned to Authors data member.
    ///
    /// Data member Authors is mandatory;
    /// its type is defined as 'typedef CAuth_list 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.
    ///
    /// @param value
    ///   Reference to value.
    void SetAuthors(TAuthors& value);
 
    /// Assign a value to Authors data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAuthors& SetAuthors(void);
 
    /// this only used to get date.. will go
    /// Check if a value has been assigned to Imp data member.
    ///
    /// Data member Imp is optional;
    /// its type is defined as 'typedef CImprint TImp'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetImp(void) const;
 
    /// Check if it is safe to call GetImp method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetImp(void) const;
 
    /// Reset Imp data member.
    void ResetImp(void);
 
    /// Get the Imp member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TImp& GetImp(void) const;
 
    /// Assign a value to Imp data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetImp(TImp& value);
 
    /// Assign a value to Imp data member.
    ///
    /// @return
    ///   Reference to the data value.
    TImp& SetImp(void);
 
    /// Check if a value has been assigned to Medium data member.
    ///
    /// Data member Medium is optional;
    /// its type is defined as 'typedef EMedium TMedium'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMedium(void) const;
 
    /// Check if it is safe to call GetMedium method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMedium(void) const;
 
    /// Reset Medium data member.
    void ResetMedium(void);
 
    /// Get the Medium member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMedium GetMedium(void) const;
 
    /// Assign a value to Medium data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMedium(TMedium value);
 
    /// Assign a value to Medium data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMedium& SetMedium(void);
 
    /// replaces imp, will become required
    /// Check if a value has been assigned to Date data member.
    ///
    /// Data member Date is optional;
    /// its type is defined as 'typedef CDate TDate'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDate(void) const;
 
    /// Check if it is safe to call GetDate method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDate(void) const;
 
    /// Reset Date data member.
    void ResetDate(void);
 
    /// Get the Date member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDate& GetDate(void) const;
 
    /// Assign a value to Date data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetDate(TDate& value);
 
    /// Assign a value to Date data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDate& SetDate(void);
 
    /// description of changes for public view
    /// Check if a value has been assigned to Descr data member.
    ///
    /// Data member Descr is optional;
    /// its type is defined as 'typedef string TDescr'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDescr(void) const;
 
    /// Check if it is safe to call GetDescr method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDescr(void) const;
 
    /// Reset Descr data member.
    void ResetDescr(void);
 
    /// Get the Descr member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDescr& GetDescr(void) const;
 
    /// Assign a value to Descr data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDescr(const TDescr& value);
    void SetDescr(TDescr&& value);
 
    /// Assign a value to Descr data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDescr& SetDescr(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CCit_sub_Base(const CCit_sub_Base&);
    CCit_sub_Base& operator=(const CCit_sub_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TAuthors > m_Authors;
    CRef< TImp > m_Imp;
    EMedium m_Medium;
    CRef< TDate > m_Date;
    string m_Descr;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CCit_sub_Base::IsSetAuthors(void) const
{
    return m_Authors.NotEmpty();
}
 
inline
bool CCit_sub_Base::CanGetAuthors(void) const
{
    return true;
}
 
inline
const CCit_sub_Base::TAuthors& CCit_sub_Base::GetAuthors(void) const
{
    if ( !m_Authors ) {
        const_cast<CCit_sub_Base*>(this)->ResetAuthors();
    }
    return (*m_Authors);
}
 
inline
CCit_sub_Base::TAuthors& CCit_sub_Base::SetAuthors(void)
{
    if ( !m_Authors ) {
        ResetAuthors();
    }
    return (*m_Authors);
}
 
inline
bool CCit_sub_Base::IsSetImp(void) const
{
    return m_Imp.NotEmpty();
}
 
inline
bool CCit_sub_Base::CanGetImp(void) const
{
    return IsSetImp();
}
 
inline
const CCit_sub_Base::TImp& CCit_sub_Base::GetImp(void) const
{
    if (!CanGetImp()) {
        ThrowUnassigned(1);
    }
    return (*m_Imp);
}
 
inline
bool CCit_sub_Base::IsSetMedium(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CCit_sub_Base::CanGetMedium(void) const
{
    return IsSetMedium();
}
 
inline
void CCit_sub_Base::ResetMedium(void)
{
    m_Medium = (EMedium)(0);
    m_set_State[0] &= ~0x30;
}
 
inline
CCit_sub_Base::TMedium CCit_sub_Base::GetMedium(void) const
{
    if (!CanGetMedium()) {
        ThrowUnassigned(2);
    }
    return m_Medium;
}
 
inline
void CCit_sub_Base::SetMedium(CCit_sub_Base::TMedium value)
{
    m_Medium = value;
    m_set_State[0] |= 0x30;
}
 
inline
CCit_sub_Base::TMedium& CCit_sub_Base::SetMedium(void)
{
#ifdef _DEBUG
    if (!IsSetMedium()) {
        memset(&m_Medium,UnassignedByte(),sizeof(m_Medium));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Medium;
}
 
inline
bool CCit_sub_Base::IsSetDate(void) const
{
    return m_Date.NotEmpty();
}
 
inline
bool CCit_sub_Base::CanGetDate(void) const
{
    return IsSetDate();
}
 
inline
const CCit_sub_Base::TDate& CCit_sub_Base::GetDate(void) const
{
    if (!CanGetDate()) {
        ThrowUnassigned(3);
    }
    return (*m_Date);
}
 
inline
bool CCit_sub_Base::IsSetDescr(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CCit_sub_Base::CanGetDescr(void) const
{
    return IsSetDescr();
}
 
inline
const CCit_sub_Base::TDescr& CCit_sub_Base::GetDescr(void) const
{
    if (!CanGetDescr()) {
        ThrowUnassigned(4);
    }
    return m_Descr;
}
 
inline
void CCit_sub_Base::SetDescr(const CCit_sub_Base::TDescr& value)
{
    m_Descr = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CCit_sub_Base::SetDescr(CCit_sub_Base::TDescr&& value)
{
    m_Descr = std::forward<CCit_sub_Base::TDescr>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CCit_sub_Base::TDescr& CCit_sub_Base::SetDescr(void)
{
#ifdef _DEBUG
    if (!IsSetDescr()) {
        m_Descr = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Descr;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_BIBLIO_CIT_SUB_BASE_HPP