Seq_interval_.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 Seq_interval_.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_SEQ_INTERVAL_BASE_HPP
#define OBJECTS_SEQLOC_SEQ_INTERVAL_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <objects/seqloc/Na_strand.hpp>
 
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 CInt_fuzz;
class CSeq_id;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Seqloc
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CSeq_interval_Base --
///
 
class NCBI_SEQLOC_EXPORT CSeq_interval_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CSeq_interval_Base(void);
    // destructor
    virtual ~CSeq_interval_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef TSeqPos TFrom;
    typedef TSeqPos TTo;
    typedef ENa_strand TStrand;
    typedef CSeq_id TId;
    typedef CInt_fuzz TFuzz_from;
    typedef CInt_fuzz TFuzz_to;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_from,
        e_to,
        e_strand,
        e_id,
        e_fuzz_from,
        e_fuzz_to
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to From data member.
    ///
    /// Data member From is mandatory;
    /// its type is defined as 'typedef TSeqPos TFrom'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFrom(void) const;
 
    /// Check if it is safe to call GetFrom method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFrom(void) const;
 
    /// Reset From data member.
    void ResetFrom(void);
 
    /// Get the From member data.
    ///
    /// @return
    ///   Copy of the member data.
    TFrom GetFrom(void) const;
 
    /// Assign a value to From data member.
    ///
    /// @param value
    ///   Value to assign
    void SetFrom(TFrom value);
 
    /// Assign a value to From data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFrom& SetFrom(void);
 
    /// Check if a value has been assigned to To data member.
    ///
    /// Data member To is mandatory;
    /// its type is defined as 'typedef TSeqPos TTo'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTo(void) const;
 
    /// Check if it is safe to call GetTo method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTo(void) const;
 
    /// Reset To data member.
    void ResetTo(void);
 
    /// Get the To member data.
    ///
    /// @return
    ///   Copy of the member data.
    TTo GetTo(void) const;
 
    /// Assign a value to To data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTo(TTo value);
 
    /// Assign a value to To data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTo& SetTo(void);
 
    /// Check if a value has been assigned to Strand data member.
    ///
    /// Data member Strand is optional;
    /// its type is defined as 'typedef ENa_strand TStrand'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetStrand(void) const;
 
    /// Check if it is safe to call GetStrand method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetStrand(void) const;
 
    /// Reset Strand data member.
    void ResetStrand(void);
 
    /// Get the Strand member data.
    ///
    /// @return
    ///   Copy of the member data.
    TStrand GetStrand(void) const;
 
    /// Assign a value to Strand data member.
    ///
    /// @param value
    ///   Value to assign
    void SetStrand(TStrand value);
 
    /// Assign a value to Strand data member.
    ///
    /// @return
    ///   Reference to the data value.
    TStrand& SetStrand(void);
 
    /// WARNING: this used to be optional
    /// Check if a value has been assigned to Id data member.
    ///
    /// Data member Id is mandatory;
    /// its type is defined as 'typedef CSeq_id TId'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetId(void) const;
 
    /// Check if it is safe to call GetId method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetId(void) const;
 
    /// Reset Id data member.
    void ResetId(void);
 
    /// Get the Id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TId& GetId(void) const;
 
    /// Assign a value to Id data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetId(TId& value);
 
    /// Assign a value to Id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TId& SetId(void);
 
    /// Check if a value has been assigned to Fuzz_from data member.
    ///
    /// Data member Fuzz_from is optional;
    /// its type is defined as 'typedef CInt_fuzz TFuzz_from'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFuzz_from(void) const;
 
    /// Check if it is safe to call GetFuzz_from method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFuzz_from(void) const;
 
    /// Reset Fuzz_from data member.
    void ResetFuzz_from(void);
 
    /// Get the Fuzz_from member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TFuzz_from& GetFuzz_from(void) const;
 
    /// Assign a value to Fuzz_from data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetFuzz_from(TFuzz_from& value);
 
    /// Assign a value to Fuzz_from data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFuzz_from& SetFuzz_from(void);
 
    /// Check if a value has been assigned to Fuzz_to data member.
    ///
    /// Data member Fuzz_to is optional;
    /// its type is defined as 'typedef CInt_fuzz TFuzz_to'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetFuzz_to(void) const;
 
    /// Check if it is safe to call GetFuzz_to method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetFuzz_to(void) const;
 
    /// Reset Fuzz_to data member.
    void ResetFuzz_to(void);
 
    /// Get the Fuzz_to member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TFuzz_to& GetFuzz_to(void) const;
 
    /// Assign a value to Fuzz_to data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetFuzz_to(TFuzz_to& value);
 
    /// Assign a value to Fuzz_to data member.
    ///
    /// @return
    ///   Reference to the data value.
    TFuzz_to& SetFuzz_to(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CSeq_interval_Base(const CSeq_interval_Base&);
    CSeq_interval_Base& operator=(const CSeq_interval_Base&);
 
    // data
    Uint4 m_set_State[1];
    TSeqPos m_From;
    TSeqPos m_To;
    ENa_strand m_Strand;
    CRef< TId > m_Id;
    CRef< TFuzz_from > m_Fuzz_from;
    CRef< TFuzz_to > m_Fuzz_to;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CSeq_interval_Base::IsSetFrom(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CSeq_interval_Base::CanGetFrom(void) const
{
    return IsSetFrom();
}
 
inline
void CSeq_interval_Base::ResetFrom(void)
{
    m_From = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CSeq_interval_Base::TFrom CSeq_interval_Base::GetFrom(void) const
{
    if (!CanGetFrom()) {
        ThrowUnassigned(0);
    }
    return m_From;
}
 
inline
void CSeq_interval_Base::SetFrom(CSeq_interval_Base::TFrom value)
{
    m_From = value;
    m_set_State[0] |= 0x3;
}
 
inline
CSeq_interval_Base::TFrom& CSeq_interval_Base::SetFrom(void)
{
#ifdef _DEBUG
    if (!IsSetFrom()) {
        memset(&m_From,UnassignedByte(),sizeof(m_From));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_From;
}
 
inline
bool CSeq_interval_Base::IsSetTo(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CSeq_interval_Base::CanGetTo(void) const
{
    return IsSetTo();
}
 
inline
void CSeq_interval_Base::ResetTo(void)
{
    m_To = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CSeq_interval_Base::TTo CSeq_interval_Base::GetTo(void) const
{
    if (!CanGetTo()) {
        ThrowUnassigned(1);
    }
    return m_To;
}
 
inline
void CSeq_interval_Base::SetTo(CSeq_interval_Base::TTo value)
{
    m_To = value;
    m_set_State[0] |= 0xc;
}
 
inline
CSeq_interval_Base::TTo& CSeq_interval_Base::SetTo(void)
{
#ifdef _DEBUG
    if (!IsSetTo()) {
        memset(&m_To,UnassignedByte(),sizeof(m_To));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_To;
}
 
inline
bool CSeq_interval_Base::IsSetStrand(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CSeq_interval_Base::CanGetStrand(void) const
{
    return IsSetStrand();
}
 
inline
void CSeq_interval_Base::ResetStrand(void)
{
    m_Strand = (ncbi::objects::ENa_strand)(0);
    m_set_State[0] &= ~0x30;
}
 
inline
CSeq_interval_Base::TStrand CSeq_interval_Base::GetStrand(void) const
{
    if (!CanGetStrand()) {
        ThrowUnassigned(2);
    }
    return m_Strand;
}
 
inline
void CSeq_interval_Base::SetStrand(CSeq_interval_Base::TStrand value)
{
    m_Strand = value;
    m_set_State[0] |= 0x30;
}
 
inline
CSeq_interval_Base::TStrand& CSeq_interval_Base::SetStrand(void)
{
#ifdef _DEBUG
    if (!IsSetStrand()) {
        memset(&m_Strand,UnassignedByte(),sizeof(m_Strand));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Strand;
}
 
inline
bool CSeq_interval_Base::IsSetId(void) const
{
    return m_Id.NotEmpty();
}
 
inline
bool CSeq_interval_Base::CanGetId(void) const
{
    return true;
}
 
inline
const CSeq_interval_Base::TId& CSeq_interval_Base::GetId(void) const
{
    if ( !m_Id ) {
        const_cast<CSeq_interval_Base*>(this)->ResetId();
    }
    return (*m_Id);
}
 
inline
CSeq_interval_Base::TId& CSeq_interval_Base::SetId(void)
{
    if ( !m_Id ) {
        ResetId();
    }
    return (*m_Id);
}
 
inline
bool CSeq_interval_Base::IsSetFuzz_from(void) const
{
    return m_Fuzz_from.NotEmpty();
}
 
inline
bool CSeq_interval_Base::CanGetFuzz_from(void) const
{
    return IsSetFuzz_from();
}
 
inline
const CSeq_interval_Base::TFuzz_from& CSeq_interval_Base::GetFuzz_from(void) const
{
    if (!CanGetFuzz_from()) {
        ThrowUnassigned(4);
    }
    return (*m_Fuzz_from);
}
 
inline
bool CSeq_interval_Base::IsSetFuzz_to(void) const
{
    return m_Fuzz_to.NotEmpty();
}
 
inline
bool CSeq_interval_Base::CanGetFuzz_to(void) const
{
    return IsSetFuzz_to();
}
 
inline
const CSeq_interval_Base::TFuzz_to& CSeq_interval_Base::GetFuzz_to(void) const
{
    if (!CanGetFuzz_to()) {
        ThrowUnassigned(5);
    }
    return (*m_Fuzz_to);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQLOC_SEQ_INTERVAL_BASE_HPP