Textseq_id_.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 Textseq_id_.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/seqloc/seqloc.asn">seqloc.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqloc/seqloc.def">seqloc.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQLOC_TEXTSEQ_ID_BASE_HPP
#define OBJECTS_SEQLOC_TEXTSEQ_ID_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_Seqloc
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CTextseq_id_Base --
///
 
class NCBI_SEQLOC_EXPORT CTextseq_id_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CTextseq_id_Base(void);
    // destructor
    virtual ~CTextseq_id_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TName;
    typedef string TAccession;
    typedef string TRelease;
    typedef int TVersion;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_name,
        e_accession,
        e_release,
        e_version
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Name data member.
    ///
    /// Data member Name is optional;
    /// its type is defined as 'typedef string TName'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetName(void) const;
 
    /// Check if it is safe to call GetName method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetName(void) const;
 
    /// Reset Name data member.
    void ResetName(void);
 
    /// Get the Name member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TName& GetName(void) const;
 
    /// Assign a value to Name data member.
    ///
    /// @param value
    ///   Value to assign
    void SetName(const TName& value);
    void SetName(TName&& value);
 
    /// Assign a value to Name data member.
    ///
    /// @return
    ///   Reference to the data value.
    TName& SetName(void);
 
    /// Check if a value has been assigned to Accession data member.
    ///
    /// Data member Accession is optional;
    /// its type is defined as 'typedef string TAccession'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAccession(void) const;
 
    /// Check if it is safe to call GetAccession method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAccession(void) const;
 
    /// Reset Accession data member.
    void ResetAccession(void);
 
    /// Get the Accession member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAccession& GetAccession(void) const;
 
    /// Assign a value to Accession data member.
    ///
    /// @param value
    ///   Value to assign
    void SetAccession(const TAccession& value);
    void SetAccession(TAccession&& value);
 
    /// Assign a value to Accession data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAccession& SetAccession(void);
 
    /// Check if a value has been assigned to Release data member.
    ///
    /// Data member Release is optional;
    /// its type is defined as 'typedef string TRelease'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRelease(void) const;
 
    /// Check if it is safe to call GetRelease method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRelease(void) const;
 
    /// Reset Release data member.
    void ResetRelease(void);
 
    /// Get the Release member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRelease& GetRelease(void) const;
 
    /// Assign a value to Release data member.
    ///
    /// @param value
    ///   Value to assign
    void SetRelease(const TRelease& value);
    void SetRelease(TRelease&& value);
 
    /// Assign a value to Release data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRelease& SetRelease(void);
 
    /// Check if a value has been assigned to Version data member.
    ///
    /// Data member Version is optional;
    /// its type is defined as 'typedef int TVersion'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVersion(void) const;
 
    /// Check if it is safe to call GetVersion method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVersion(void) const;
 
    /// Reset Version data member.
    void ResetVersion(void);
 
    /// Get the Version member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVersion GetVersion(void) const;
 
    /// Assign a value to Version data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVersion(TVersion value);
 
    /// Assign a value to Version data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVersion& SetVersion(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CTextseq_id_Base(const CTextseq_id_Base&);
    CTextseq_id_Base& operator=(const CTextseq_id_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Name;
    string m_Accession;
    string m_Release;
    int m_Version;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CTextseq_id_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CTextseq_id_Base::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CTextseq_id_Base::TName& CTextseq_id_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(0);
    }
    return m_Name;
}
 
inline
void CTextseq_id_Base::SetName(const CTextseq_id_Base::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CTextseq_id_Base::SetName(CTextseq_id_Base::TName&& value)
{
    m_Name = std::forward<CTextseq_id_Base::TName>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CTextseq_id_Base::TName& CTextseq_id_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Name;
}
 
inline
bool CTextseq_id_Base::IsSetAccession(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CTextseq_id_Base::CanGetAccession(void) const
{
    return IsSetAccession();
}
 
inline
const CTextseq_id_Base::TAccession& CTextseq_id_Base::GetAccession(void) const
{
    if (!CanGetAccession()) {
        ThrowUnassigned(1);
    }
    return m_Accession;
}
 
inline
void CTextseq_id_Base::SetAccession(const CTextseq_id_Base::TAccession& value)
{
    m_Accession = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CTextseq_id_Base::SetAccession(CTextseq_id_Base::TAccession&& value)
{
    m_Accession = std::forward<CTextseq_id_Base::TAccession>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CTextseq_id_Base::TAccession& CTextseq_id_Base::SetAccession(void)
{
#ifdef _DEBUG
    if (!IsSetAccession()) {
        m_Accession = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Accession;
}
 
inline
bool CTextseq_id_Base::IsSetRelease(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CTextseq_id_Base::CanGetRelease(void) const
{
    return IsSetRelease();
}
 
inline
const CTextseq_id_Base::TRelease& CTextseq_id_Base::GetRelease(void) const
{
    if (!CanGetRelease()) {
        ThrowUnassigned(2);
    }
    return m_Release;
}
 
inline
void CTextseq_id_Base::SetRelease(const CTextseq_id_Base::TRelease& value)
{
    m_Release = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CTextseq_id_Base::SetRelease(CTextseq_id_Base::TRelease&& value)
{
    m_Release = std::forward<CTextseq_id_Base::TRelease>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CTextseq_id_Base::TRelease& CTextseq_id_Base::SetRelease(void)
{
#ifdef _DEBUG
    if (!IsSetRelease()) {
        m_Release = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Release;
}
 
inline
bool CTextseq_id_Base::IsSetVersion(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CTextseq_id_Base::CanGetVersion(void) const
{
    return IsSetVersion();
}
 
inline
void CTextseq_id_Base::ResetVersion(void)
{
    m_Version = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CTextseq_id_Base::TVersion CTextseq_id_Base::GetVersion(void) const
{
    if (!CanGetVersion()) {
        ThrowUnassigned(3);
    }
    return m_Version;
}
 
inline
void CTextseq_id_Base::SetVersion(CTextseq_id_Base::TVersion value)
{
    m_Version = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CTextseq_id_Base::TVersion& CTextseq_id_Base::SetVersion(void)
{
#ifdef _DEBUG
    if (!IsSetVersion()) {
        memset(&m_Version,UnassignedByte(),sizeof(m_Version));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Version;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQLOC_TEXTSEQ_ID_BASE_HPP