MedlineJournalInfo_.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 MedlineJournalInfo_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/efetch.xsd">efetch.xsd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objtools/eutils/efetch/efetch.def">efetch.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef eutils__OBJTOOLS_EUTILS_EFETCH_MEDLINEJOURNALINFO_BASE_HPP
#define eutils__OBJTOOLS_EUTILS_EFETCH_MEDLINEJOURNALINFO_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
#ifndef BEGIN_eutils_SCOPE
#  define BEGIN_eutils_SCOPE BEGIN_SCOPE(eutils)
#  define END_eutils_SCOPE END_SCOPE(eutils)
#endif
BEGIN_eutils_SCOPE // namespace eutils::
 
 
// forward declarations
class CCountry;
class CISSNLinking;
class CMedlineTA;
class CNlmUniqueID;
 
 
// generated classes
 
 
/** @addtogroup dataspec_efetch
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CMedlineJournalInfo_Base --
///
 
class CMedlineJournalInfo_Base : public NCBI_NS_NCBI::CSerialObject
{
    typedef NCBI_NS_NCBI::CSerialObject Tparent;
public:
    // constructor
    CMedlineJournalInfo_Base(void);
    // destructor
    virtual ~CMedlineJournalInfo_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CCountry TCountry;
    typedef CMedlineTA TMedlineTA;
    typedef CNlmUniqueID TNlmUniqueID;
    typedef CISSNLinking TISSNLinking;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Country,
        e_MedlineTA,
        e_NlmUniqueID,
        e_ISSNLinking
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Country data member.
    ///
    /// Data member Country is optional;
    /// its type is defined as 'typedef CCountry TCountry'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCountry(void) const;
 
    /// Check if it is safe to call GetCountry method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCountry(void) const;
 
    /// Reset Country data member.
    void ResetCountry(void);
 
    /// Get the Country member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCountry& GetCountry(void) const;
 
    /// Assign a value to Country data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetCountry(TCountry& value);
 
    /// Assign a value to Country data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCountry& SetCountry(void);
 
    /// Check if a value has been assigned to MedlineTA data member.
    ///
    /// Data member MedlineTA is mandatory;
    /// its type is defined as 'typedef CMedlineTA TMedlineTA'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMedlineTA(void) const;
 
    /// Check if it is safe to call GetMedlineTA method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMedlineTA(void) const;
 
    /// Reset MedlineTA data member.
    void ResetMedlineTA(void);
 
    /// Get the MedlineTA member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMedlineTA& GetMedlineTA(void) const;
 
    /// Assign a value to MedlineTA data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetMedlineTA(TMedlineTA& value);
 
    /// Assign a value to MedlineTA data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMedlineTA& SetMedlineTA(void);
 
    /// Check if a value has been assigned to NlmUniqueID data member.
    ///
    /// Data member NlmUniqueID is optional;
    /// its type is defined as 'typedef CNlmUniqueID TNlmUniqueID'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNlmUniqueID(void) const;
 
    /// Check if it is safe to call GetNlmUniqueID method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNlmUniqueID(void) const;
 
    /// Reset NlmUniqueID data member.
    void ResetNlmUniqueID(void);
 
    /// Get the NlmUniqueID member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TNlmUniqueID& GetNlmUniqueID(void) const;
 
    /// Assign a value to NlmUniqueID data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetNlmUniqueID(TNlmUniqueID& value);
 
    /// Assign a value to NlmUniqueID data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNlmUniqueID& SetNlmUniqueID(void);
 
    /// Check if a value has been assigned to ISSNLinking data member.
    ///
    /// Data member ISSNLinking is optional;
    /// its type is defined as 'typedef CISSNLinking TISSNLinking'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetISSNLinking(void) const;
 
    /// Check if it is safe to call GetISSNLinking method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetISSNLinking(void) const;
 
    /// Reset ISSNLinking data member.
    void ResetISSNLinking(void);
 
    /// Get the ISSNLinking member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TISSNLinking& GetISSNLinking(void) const;
 
    /// Assign a value to ISSNLinking data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetISSNLinking(TISSNLinking& value);
 
    /// Assign a value to ISSNLinking data member.
    ///
    /// @return
    ///   Reference to the data value.
    TISSNLinking& SetISSNLinking(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CMedlineJournalInfo_Base(const CMedlineJournalInfo_Base&);
    CMedlineJournalInfo_Base& operator=(const CMedlineJournalInfo_Base&);
 
    // data
    Uint4 m_set_State[1];
    NCBI_NS_NCBI::CRef< TCountry > m_Country;
    NCBI_NS_NCBI::CRef< TMedlineTA > m_MedlineTA;
    NCBI_NS_NCBI::CRef< TNlmUniqueID > m_NlmUniqueID;
    NCBI_NS_NCBI::CRef< TISSNLinking > m_ISSNLinking;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CMedlineJournalInfo_Base::IsSetCountry(void) const
{
    return m_Country.NotEmpty();
}
 
inline
bool CMedlineJournalInfo_Base::CanGetCountry(void) const
{
    return IsSetCountry();
}
 
inline
const CMedlineJournalInfo_Base::TCountry& CMedlineJournalInfo_Base::GetCountry(void) const
{
    if (!CanGetCountry()) {
        ThrowUnassigned(0);
    }
    return (*m_Country);
}
 
inline
bool CMedlineJournalInfo_Base::IsSetMedlineTA(void) const
{
    return m_MedlineTA.NotEmpty();
}
 
inline
bool CMedlineJournalInfo_Base::CanGetMedlineTA(void) const
{
    return true;
}
 
inline
const CMedlineJournalInfo_Base::TMedlineTA& CMedlineJournalInfo_Base::GetMedlineTA(void) const
{
    if ( !m_MedlineTA ) {
        const_cast<CMedlineJournalInfo_Base*>(this)->ResetMedlineTA();
    }
    return (*m_MedlineTA);
}
 
inline
CMedlineJournalInfo_Base::TMedlineTA& CMedlineJournalInfo_Base::SetMedlineTA(void)
{
    if ( !m_MedlineTA ) {
        ResetMedlineTA();
    }
    return (*m_MedlineTA);
}
 
inline
bool CMedlineJournalInfo_Base::IsSetNlmUniqueID(void) const
{
    return m_NlmUniqueID.NotEmpty();
}
 
inline
bool CMedlineJournalInfo_Base::CanGetNlmUniqueID(void) const
{
    return IsSetNlmUniqueID();
}
 
inline
const CMedlineJournalInfo_Base::TNlmUniqueID& CMedlineJournalInfo_Base::GetNlmUniqueID(void) const
{
    if (!CanGetNlmUniqueID()) {
        ThrowUnassigned(2);
    }
    return (*m_NlmUniqueID);
}
 
inline
bool CMedlineJournalInfo_Base::IsSetISSNLinking(void) const
{
    return m_ISSNLinking.NotEmpty();
}
 
inline
bool CMedlineJournalInfo_Base::CanGetISSNLinking(void) const
{
    return IsSetISSNLinking();
}
 
inline
const CMedlineJournalInfo_Base::TISSNLinking& CMedlineJournalInfo_Base::GetISSNLinking(void) const
{
    if (!CanGetISSNLinking()) {
        ThrowUnassigned(3);
    }
    return (*m_ISSNLinking);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_eutils_SCOPE // namespace eutils::
 
 
#endif // eutils__OBJTOOLS_EUTILS_EFETCH_MEDLINEJOURNALINFO_BASE_HPP