Taxon1_name_.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 Taxon1_name_.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/taxon1/taxon1.asn">taxon1.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/taxon1/taxon1.def">taxon1.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_TAXON1_TAXON1_NAME_BASE_HPP
#define OBJECTS_TAXON1_TAXON1_NAME_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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Taxon1
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CTaxon1_name_Base --
///
 
class NCBI_TAXON1_EXPORT CTaxon1_name_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CTaxon1_name_Base(void);
    // destructor
    virtual ~CTaxon1_name_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef NCBI_NS_NCBI::TTaxId TTaxid;
    typedef int TCde;
    typedef string TOname;
    typedef string TUname;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_taxid,
        e_cde,
        e_oname,
        e_uname
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Taxid data member.
    ///
    /// Data member Taxid is mandatory;
    /// its type is defined as 'typedef NCBI_NS_NCBI::TTaxId TTaxid'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTaxid(void) const;
 
    /// Check if it is safe to call GetTaxid method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTaxid(void) const;
 
    /// Reset Taxid data member.
    void ResetTaxid(void);
 
    /// Get the Taxid member data.
    ///
    /// @return
    ///   Copy of the member data.
    TTaxid GetTaxid(void) const;
 
    /// Assign a value to Taxid data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTaxid(TTaxid value);
 
    /// Assign a value to Taxid data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTaxid& SetTaxid(void);
 
    /// Check if a value has been assigned to Cde data member.
    ///
    /// Data member Cde is mandatory;
    /// its type is defined as 'typedef int TCde'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCde(void) const;
 
    /// Check if it is safe to call GetCde method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCde(void) const;
 
    /// Reset Cde data member.
    void ResetCde(void);
 
    /// Get the Cde member data.
    ///
    /// @return
    ///   Copy of the member data.
    TCde GetCde(void) const;
 
    /// Assign a value to Cde data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCde(TCde value);
 
    /// Assign a value to Cde data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCde& SetCde(void);
 
    /// Check if a value has been assigned to Oname data member.
    ///
    /// Data member Oname is optional;
    /// its type is defined as 'typedef string TOname'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOname(void) const;
 
    /// Check if it is safe to call GetOname method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOname(void) const;
 
    /// Reset Oname data member.
    void ResetOname(void);
 
    /// Get the Oname member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TOname& GetOname(void) const;
 
    /// Assign a value to Oname data member.
    ///
    /// @param value
    ///   Value to assign
    void SetOname(const TOname& value);
    void SetOname(TOname&& value);
 
    /// Assign a value to Oname data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOname& SetOname(void);
 
    /// Check if a value has been assigned to Uname data member.
    ///
    /// Data member Uname is optional;
    /// its type is defined as 'typedef string TUname'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUname(void) const;
 
    /// Check if it is safe to call GetUname method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUname(void) const;
 
    /// Reset Uname data member.
    void ResetUname(void);
 
    /// Get the Uname member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUname& GetUname(void) const;
 
    /// Assign a value to Uname data member.
    ///
    /// @param value
    ///   Value to assign
    void SetUname(const TUname& value);
    void SetUname(TUname&& value);
 
    /// Assign a value to Uname data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUname& SetUname(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CTaxon1_name_Base(const CTaxon1_name_Base&);
    CTaxon1_name_Base& operator=(const CTaxon1_name_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Taxid;
    int m_Cde;
    string m_Oname;
    string m_Uname;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CTaxon1_name_Base::IsSetTaxid(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CTaxon1_name_Base::CanGetTaxid(void) const
{
    return IsSetTaxid();
}
 
inline
void CTaxon1_name_Base::ResetTaxid(void)
{
    m_Taxid = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CTaxon1_name_Base::TTaxid CTaxon1_name_Base::GetTaxid(void) const
{
    if (!CanGetTaxid()) {
        ThrowUnassigned(0);
    }
    return reinterpret_cast<const TTaxid&>(m_Taxid);
}
 
inline
void CTaxon1_name_Base::SetTaxid(CTaxon1_name_Base::TTaxid value)
{
    reinterpret_cast<TTaxid&>(m_Taxid) = value;
    m_set_State[0] |= 0x3;
}
 
inline
CTaxon1_name_Base::TTaxid& CTaxon1_name_Base::SetTaxid(void)
{
#ifdef _DEBUG
    if (!IsSetTaxid()) {
        memset(&m_Taxid,UnassignedByte(),sizeof(m_Taxid));
    }
#endif
    m_set_State[0] |= 0x1;
    return reinterpret_cast<TTaxid&>(m_Taxid);
}
 
inline
bool CTaxon1_name_Base::IsSetCde(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CTaxon1_name_Base::CanGetCde(void) const
{
    return IsSetCde();
}
 
inline
void CTaxon1_name_Base::ResetCde(void)
{
    m_Cde = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CTaxon1_name_Base::TCde CTaxon1_name_Base::GetCde(void) const
{
    if (!CanGetCde()) {
        ThrowUnassigned(1);
    }
    return m_Cde;
}
 
inline
void CTaxon1_name_Base::SetCde(CTaxon1_name_Base::TCde value)
{
    m_Cde = value;
    m_set_State[0] |= 0xc;
}
 
inline
CTaxon1_name_Base::TCde& CTaxon1_name_Base::SetCde(void)
{
#ifdef _DEBUG
    if (!IsSetCde()) {
        memset(&m_Cde,UnassignedByte(),sizeof(m_Cde));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Cde;
}
 
inline
bool CTaxon1_name_Base::IsSetOname(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CTaxon1_name_Base::CanGetOname(void) const
{
    return IsSetOname();
}
 
inline
const CTaxon1_name_Base::TOname& CTaxon1_name_Base::GetOname(void) const
{
    if (!CanGetOname()) {
        ThrowUnassigned(2);
    }
    return m_Oname;
}
 
inline
void CTaxon1_name_Base::SetOname(const CTaxon1_name_Base::TOname& value)
{
    m_Oname = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CTaxon1_name_Base::SetOname(CTaxon1_name_Base::TOname&& value)
{
    m_Oname = std::forward<CTaxon1_name_Base::TOname>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CTaxon1_name_Base::TOname& CTaxon1_name_Base::SetOname(void)
{
#ifdef _DEBUG
    if (!IsSetOname()) {
        m_Oname = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Oname;
}
 
inline
bool CTaxon1_name_Base::IsSetUname(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CTaxon1_name_Base::CanGetUname(void) const
{
    return IsSetUname();
}
 
inline
const CTaxon1_name_Base::TUname& CTaxon1_name_Base::GetUname(void) const
{
    if (!CanGetUname()) {
        ThrowUnassigned(3);
    }
    return m_Uname;
}
 
inline
void CTaxon1_name_Base::SetUname(const CTaxon1_name_Base::TUname& value)
{
    m_Uname = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CTaxon1_name_Base::SetUname(CTaxon1_name_Base::TUname&& value)
{
    m_Uname = std::forward<CTaxon1_name_Base::TUname>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CTaxon1_name_Base::TUname& CTaxon1_name_Base::SetUname(void)
{
#ifdef _DEBUG
    if (!IsSetUname()) {
        m_Uname = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Uname;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_TAXON1_TAXON1_NAME_BASE_HPP