GBFeature_.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 GBFeature_.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/gbseq/gbseq.asn">gbseq.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/gbseq/gbseq.def">gbseq.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GBSEQ_GBFEATURE_BASE_HPP
#define OBJECTS_GBSEQ_GBFEATURE_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 CGBInterval;
class CGBQualifier;
class CGBXref;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GBSeq
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CGBFeature_Base --
///
 
class NCBI_GBSEQ_EXPORT CGBFeature_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGBFeature_Base(void);
    // destructor
    virtual ~CGBFeature_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TKey;
    typedef string TLocation;
    typedef list< CRef< CGBInterval > > TIntervals;
    typedef string TOperator;
    typedef bool TPartial5;
    typedef bool TPartial3;
    typedef list< CRef< CGBQualifier > > TQuals;
    typedef list< CRef< CGBXref > > TXrefs;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_key,
        e_location,
        e_intervals,
        e_operator,
        e_partial5,
        e_partial3,
        e_quals,
        e_xrefs
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 9> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Key data member.
    ///
    /// Data member Key is mandatory;
    /// its type is defined as 'typedef string TKey'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetKey(void) const;
 
    /// Check if it is safe to call GetKey method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetKey(void) const;
 
    /// Reset Key data member.
    void ResetKey(void);
 
    /// Get the Key member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TKey& GetKey(void) const;
 
    /// Assign a value to Key data member.
    ///
    /// @param value
    ///   Value to assign
    void SetKey(const TKey& value);
    void SetKey(TKey&& value);
 
    /// Assign a value to Key data member.
    ///
    /// @return
    ///   Reference to the data value.
    TKey& SetKey(void);
 
    /// Check if a value has been assigned to Location data member.
    ///
    /// Data member Location is mandatory;
    /// its type is defined as 'typedef string TLocation'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLocation(void) const;
 
    /// Check if it is safe to call GetLocation method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLocation(void) const;
 
    /// Reset Location data member.
    void ResetLocation(void);
 
    /// Get the Location member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLocation& GetLocation(void) const;
 
    /// Assign a value to Location data member.
    ///
    /// @param value
    ///   Value to assign
    void SetLocation(const TLocation& value);
    void SetLocation(TLocation&& value);
 
    /// Assign a value to Location data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLocation& SetLocation(void);
 
    /// Check if a value has been assigned to Intervals data member.
    ///
    /// Data member Intervals is optional;
    /// its type is defined as 'typedef list< CRef< CGBInterval > > TIntervals'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIntervals(void) const;
 
    /// Check if it is safe to call GetIntervals method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIntervals(void) const;
 
    /// Reset Intervals data member.
    void ResetIntervals(void);
 
    /// Get the Intervals member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TIntervals& GetIntervals(void) const;
 
    /// Assign a value to Intervals data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIntervals& SetIntervals(void);
 
    /// Check if a value has been assigned to Operator data member.
    ///
    /// Data member Operator is optional;
    /// its type is defined as 'typedef string TOperator'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOperator(void) const;
 
    /// Check if it is safe to call GetOperator method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOperator(void) const;
 
    /// Reset Operator data member.
    void ResetOperator(void);
 
    /// Get the Operator member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TOperator& GetOperator(void) const;
 
    /// Assign a value to Operator data member.
    ///
    /// @param value
    ///   Value to assign
    void SetOperator(const TOperator& value);
    void SetOperator(TOperator&& value);
 
    /// Assign a value to Operator data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOperator& SetOperator(void);
 
    /// Check if a value has been assigned to Partial5 data member.
    ///
    /// Data member Partial5 is optional;
    /// its type is defined as 'typedef bool TPartial5'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPartial5(void) const;
 
    /// Check if it is safe to call GetPartial5 method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPartial5(void) const;
 
    /// Reset Partial5 data member.
    void ResetPartial5(void);
 
    /// Get the Partial5 member data.
    ///
    /// @return
    ///   Copy of the member data.
    TPartial5 GetPartial5(void) const;
 
    /// Assign a value to Partial5 data member.
    ///
    /// @param value
    ///   Value to assign
    void SetPartial5(TPartial5 value);
 
    /// Assign a value to Partial5 data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPartial5& SetPartial5(void);
 
    /// Check if a value has been assigned to Partial3 data member.
    ///
    /// Data member Partial3 is optional;
    /// its type is defined as 'typedef bool TPartial3'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPartial3(void) const;
 
    /// Check if it is safe to call GetPartial3 method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPartial3(void) const;
 
    /// Reset Partial3 data member.
    void ResetPartial3(void);
 
    /// Get the Partial3 member data.
    ///
    /// @return
    ///   Copy of the member data.
    TPartial3 GetPartial3(void) const;
 
    /// Assign a value to Partial3 data member.
    ///
    /// @param value
    ///   Value to assign
    void SetPartial3(TPartial3 value);
 
    /// Assign a value to Partial3 data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPartial3& SetPartial3(void);
 
    /// Check if a value has been assigned to Quals data member.
    ///
    /// Data member Quals is optional;
    /// its type is defined as 'typedef list< CRef< CGBQualifier > > TQuals'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetQuals(void) const;
 
    /// Check if it is safe to call GetQuals method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetQuals(void) const;
 
    /// Reset Quals data member.
    void ResetQuals(void);
 
    /// Get the Quals member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TQuals& GetQuals(void) const;
 
    /// Assign a value to Quals data member.
    ///
    /// @return
    ///   Reference to the data value.
    TQuals& SetQuals(void);
 
    /// Check if a value has been assigned to Xrefs data member.
    ///
    /// Data member Xrefs is optional;
    /// its type is defined as 'typedef list< CRef< CGBXref > > TXrefs'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetXrefs(void) const;
 
    /// Check if it is safe to call GetXrefs method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetXrefs(void) const;
 
    /// Reset Xrefs data member.
    void ResetXrefs(void);
 
    /// Get the Xrefs member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TXrefs& GetXrefs(void) const;
 
    /// Assign a value to Xrefs data member.
    ///
    /// @return
    ///   Reference to the data value.
    TXrefs& SetXrefs(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGBFeature_Base(const CGBFeature_Base&);
    CGBFeature_Base& operator=(const CGBFeature_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Key;
    string m_Location;
    list< CRef< CGBInterval > > m_Intervals;
    string m_Operator;
    bool m_Partial5;
    bool m_Partial3;
    list< CRef< CGBQualifier > > m_Quals;
    list< CRef< CGBXref > > m_Xrefs;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGBFeature_Base::IsSetKey(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CGBFeature_Base::CanGetKey(void) const
{
    return IsSetKey();
}
 
inline
const CGBFeature_Base::TKey& CGBFeature_Base::GetKey(void) const
{
    if (!CanGetKey()) {
        ThrowUnassigned(0);
    }
    return m_Key;
}
 
inline
void CGBFeature_Base::SetKey(const CGBFeature_Base::TKey& value)
{
    m_Key = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CGBFeature_Base::SetKey(CGBFeature_Base::TKey&& value)
{
    m_Key = std::forward<CGBFeature_Base::TKey>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CGBFeature_Base::TKey& CGBFeature_Base::SetKey(void)
{
#ifdef _DEBUG
    if (!IsSetKey()) {
        m_Key = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Key;
}
 
inline
bool CGBFeature_Base::IsSetLocation(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGBFeature_Base::CanGetLocation(void) const
{
    return IsSetLocation();
}
 
inline
const CGBFeature_Base::TLocation& CGBFeature_Base::GetLocation(void) const
{
    if (!CanGetLocation()) {
        ThrowUnassigned(1);
    }
    return m_Location;
}
 
inline
void CGBFeature_Base::SetLocation(const CGBFeature_Base::TLocation& value)
{
    m_Location = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CGBFeature_Base::SetLocation(CGBFeature_Base::TLocation&& value)
{
    m_Location = std::forward<CGBFeature_Base::TLocation>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CGBFeature_Base::TLocation& CGBFeature_Base::SetLocation(void)
{
#ifdef _DEBUG
    if (!IsSetLocation()) {
        m_Location = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Location;
}
 
inline
bool CGBFeature_Base::IsSetIntervals(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGBFeature_Base::CanGetIntervals(void) const
{
    return true;
}
 
inline
const CGBFeature_Base::TIntervals& CGBFeature_Base::GetIntervals(void) const
{
    return m_Intervals;
}
 
inline
CGBFeature_Base::TIntervals& CGBFeature_Base::SetIntervals(void)
{
    m_set_State[0] |= 0x10;
    return m_Intervals;
}
 
inline
bool CGBFeature_Base::IsSetOperator(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CGBFeature_Base::CanGetOperator(void) const
{
    return IsSetOperator();
}
 
inline
const CGBFeature_Base::TOperator& CGBFeature_Base::GetOperator(void) const
{
    if (!CanGetOperator()) {
        ThrowUnassigned(3);
    }
    return m_Operator;
}
 
inline
void CGBFeature_Base::SetOperator(const CGBFeature_Base::TOperator& value)
{
    m_Operator = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CGBFeature_Base::SetOperator(CGBFeature_Base::TOperator&& value)
{
    m_Operator = std::forward<CGBFeature_Base::TOperator>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CGBFeature_Base::TOperator& CGBFeature_Base::SetOperator(void)
{
#ifdef _DEBUG
    if (!IsSetOperator()) {
        m_Operator = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Operator;
}
 
inline
bool CGBFeature_Base::IsSetPartial5(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CGBFeature_Base::CanGetPartial5(void) const
{
    return IsSetPartial5();
}
 
inline
void CGBFeature_Base::ResetPartial5(void)
{
    m_Partial5 = 0;
    m_set_State[0] &= ~0x300;
}
 
inline
CGBFeature_Base::TPartial5 CGBFeature_Base::GetPartial5(void) const
{
    if (!CanGetPartial5()) {
        ThrowUnassigned(4);
    }
    return m_Partial5;
}
 
inline
void CGBFeature_Base::SetPartial5(CGBFeature_Base::TPartial5 value)
{
    m_Partial5 = value;
    m_set_State[0] |= 0x300;
}
 
inline
CGBFeature_Base::TPartial5& CGBFeature_Base::SetPartial5(void)
{
#ifdef _DEBUG
    if (!IsSetPartial5()) {
        memset(&m_Partial5,UnassignedByte(),sizeof(m_Partial5));
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Partial5;
}
 
inline
bool CGBFeature_Base::IsSetPartial3(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CGBFeature_Base::CanGetPartial3(void) const
{
    return IsSetPartial3();
}
 
inline
void CGBFeature_Base::ResetPartial3(void)
{
    m_Partial3 = 0;
    m_set_State[0] &= ~0xc00;
}
 
inline
CGBFeature_Base::TPartial3 CGBFeature_Base::GetPartial3(void) const
{
    if (!CanGetPartial3()) {
        ThrowUnassigned(5);
    }
    return m_Partial3;
}
 
inline
void CGBFeature_Base::SetPartial3(CGBFeature_Base::TPartial3 value)
{
    m_Partial3 = value;
    m_set_State[0] |= 0xc00;
}
 
inline
CGBFeature_Base::TPartial3& CGBFeature_Base::SetPartial3(void)
{
#ifdef _DEBUG
    if (!IsSetPartial3()) {
        memset(&m_Partial3,UnassignedByte(),sizeof(m_Partial3));
    }
#endif
    m_set_State[0] |= 0x400;
    return m_Partial3;
}
 
inline
bool CGBFeature_Base::IsSetQuals(void) const
{
    return ((m_set_State[0] & 0x3000) != 0);
}
 
inline
bool CGBFeature_Base::CanGetQuals(void) const
{
    return true;
}
 
inline
const CGBFeature_Base::TQuals& CGBFeature_Base::GetQuals(void) const
{
    return m_Quals;
}
 
inline
CGBFeature_Base::TQuals& CGBFeature_Base::SetQuals(void)
{
    m_set_State[0] |= 0x1000;
    return m_Quals;
}
 
inline
bool CGBFeature_Base::IsSetXrefs(void) const
{
    return ((m_set_State[0] & 0xc000) != 0);
}
 
inline
bool CGBFeature_Base::CanGetXrefs(void) const
{
    return true;
}
 
inline
const CGBFeature_Base::TXrefs& CGBFeature_Base::GetXrefs(void) const
{
    return m_Xrefs;
}
 
inline
CGBFeature_Base::TXrefs& CGBFeature_Base::SetXrefs(void)
{
    m_set_State[0] |= 0x4000;
    return m_Xrefs;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GBSEQ_GBFEATURE_BASE_HPP