Remap_query_.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 Remap_query_.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/remap/remap.asn">remap.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/remap/remap.def">remap.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_REMAP_REMAP_QUERY_BASE_HPP
#define OBJECTS_REMAP_REMAP_QUERY_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#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 CSeq_loc;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Remap
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CRemap_query_Base --
///
 
class NCBI_REMAP_EXPORT CRemap_query_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CRemap_query_Base(void);
    // destructor
    virtual ~CRemap_query_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TFrom_build;
    typedef string TTo_build;
    typedef list< CRef< CSeq_loc > > TLocs;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_from_build,
        e_to_build,
        e_locs
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// build to map from
    /// Check if a value has been assigned to From_build data member.
    ///
    /// Data member From_build is mandatory;
    /// its type is defined as 'typedef string TFrom_build'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFrom_build(void) const;
 
    /// Check if it is safe to call GetFrom_build method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFrom_build(void) const;
 
    /// Reset From_build data member.
    void ResetFrom_build(void);
 
    /// Get the From_build member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TFrom_build& GetFrom_build(void) const;
 
    /// Assign a value to From_build data member.
    ///
    /// @param value
    ///   Value to assign
    void SetFrom_build(const TFrom_build& value);
    void SetFrom_build(TFrom_build&& value);
 
    /// Assign a value to From_build data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFrom_build& SetFrom_build(void);
 
    /// build to map to
    /// Check if a value has been assigned to To_build data member.
    ///
    /// Data member To_build is mandatory;
    /// its type is defined as 'typedef string TTo_build'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTo_build(void) const;
 
    /// Check if it is safe to call GetTo_build method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTo_build(void) const;
 
    /// Reset To_build data member.
    void ResetTo_build(void);
 
    /// Get the To_build member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TTo_build& GetTo_build(void) const;
 
    /// Assign a value to To_build data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTo_build(const TTo_build& value);
    void SetTo_build(TTo_build&& value);
 
    /// Assign a value to To_build data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTo_build& SetTo_build(void);
 
    /// the locations to remap
    /// Check if a value has been assigned to Locs data member.
    ///
    /// Data member Locs is mandatory;
    /// its type is defined as 'typedef list< CRef< CSeq_loc > > TLocs'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLocs(void) const;
 
    /// Check if it is safe to call GetLocs method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLocs(void) const;
 
    /// Reset Locs data member.
    void ResetLocs(void);
 
    /// Get the Locs member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLocs& GetLocs(void) const;
 
    /// Assign a value to Locs data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLocs& SetLocs(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CRemap_query_Base(const CRemap_query_Base&);
    CRemap_query_Base& operator=(const CRemap_query_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_From_build;
    string m_To_build;
    list< CRef< CSeq_loc > > m_Locs;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CRemap_query_Base::IsSetFrom_build(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CRemap_query_Base::CanGetFrom_build(void) const
{
    return IsSetFrom_build();
}
 
inline
const CRemap_query_Base::TFrom_build& CRemap_query_Base::GetFrom_build(void) const
{
    if (!CanGetFrom_build()) {
        ThrowUnassigned(0);
    }
    return m_From_build;
}
 
inline
void CRemap_query_Base::SetFrom_build(const CRemap_query_Base::TFrom_build& value)
{
    m_From_build = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CRemap_query_Base::SetFrom_build(CRemap_query_Base::TFrom_build&& value)
{
    m_From_build = std::forward<CRemap_query_Base::TFrom_build>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CRemap_query_Base::TFrom_build& CRemap_query_Base::SetFrom_build(void)
{
#ifdef _DEBUG
    if (!IsSetFrom_build()) {
        m_From_build = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_From_build;
}
 
inline
bool CRemap_query_Base::IsSetTo_build(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CRemap_query_Base::CanGetTo_build(void) const
{
    return IsSetTo_build();
}
 
inline
const CRemap_query_Base::TTo_build& CRemap_query_Base::GetTo_build(void) const
{
    if (!CanGetTo_build()) {
        ThrowUnassigned(1);
    }
    return m_To_build;
}
 
inline
void CRemap_query_Base::SetTo_build(const CRemap_query_Base::TTo_build& value)
{
    m_To_build = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CRemap_query_Base::SetTo_build(CRemap_query_Base::TTo_build&& value)
{
    m_To_build = std::forward<CRemap_query_Base::TTo_build>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CRemap_query_Base::TTo_build& CRemap_query_Base::SetTo_build(void)
{
#ifdef _DEBUG
    if (!IsSetTo_build()) {
        m_To_build = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_To_build;
}
 
inline
bool CRemap_query_Base::IsSetLocs(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CRemap_query_Base::CanGetLocs(void) const
{
    return true;
}
 
inline
const CRemap_query_Base::TLocs& CRemap_query_Base::GetLocs(void) const
{
    return m_Locs;
}
 
inline
CRemap_query_Base::TLocs& CRemap_query_Base::SetLocs(void)
{
    m_set_State[0] |= 0x10;
    return m_Locs;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_REMAP_REMAP_QUERY_BASE_HPP