Int_fuzz_.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 Int_fuzz_.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/general/general.asn">general.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/general/general.def">general.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GENERAL_INT_FUZZ_BASE_HPP
#define OBJECTS_GENERAL_INT_FUZZ_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
 
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_General
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///**** Int-fuzz **********************************************
///*
///*   uncertainties in integer values
///
/// CInt_fuzz_Base --
///
 
class NCBI_GENERAL_EXPORT CInt_fuzz_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CInt_fuzz_Base(void);
    // destructor
    virtual ~CInt_fuzz_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    /// max to min
    ///
    /// C_Range --
    ///
    
    class NCBI_GENERAL_EXPORT C_Range : public CSerialObject
    {
        typedef CSerialObject Tparent;
    public:
        // constructor
        C_Range(void);
        // destructor
        ~C_Range(void);
    
        // type info
        DECLARE_INTERNAL_TYPE_INFO();
    
        // types
        typedef TSeqPos TMax;
        typedef TSeqPos TMin;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_max,
            e_min
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Max data member.
        ///
        /// Data member Max is mandatory;
        /// its type is defined as 'typedef TSeqPos TMax'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetMax(void) const;
    
        /// Check if it is safe to call GetMax method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetMax(void) const;
    
        /// Reset Max data member.
        void ResetMax(void);
    
        /// Get the Max member data.
        ///
        /// @return
        ///   Copy of the member data.
        TMax GetMax(void) const;
    
        /// Assign a value to Max data member.
        ///
        /// @param value
        ///   Value to assign
        void SetMax(TMax value);
    
        /// Assign a value to Max data member.
        ///
        /// @return
        ///   Reference to the data value.
        TMax& SetMax(void);
    
        /// Check if a value has been assigned to Min data member.
        ///
        /// Data member Min is mandatory;
        /// its type is defined as 'typedef TSeqPos TMin'
        /// @return
        ///   - true, if a value has been assigned.
        ///   - false, otherwise.
        bool IsSetMin(void) const;
    
        /// Check if it is safe to call GetMin method.
        ///
        /// @return
        ///   - true, if the data member is getatable.
        ///   - false, otherwise.
        bool CanGetMin(void) const;
    
        /// Reset Min data member.
        void ResetMin(void);
    
        /// Get the Min member data.
        ///
        /// @return
        ///   Copy of the member data.
        TMin GetMin(void) const;
    
        /// Assign a value to Min data member.
        ///
        /// @param value
        ///   Value to assign
        void SetMin(TMin value);
    
        /// Assign a value to Min data member.
        ///
        /// @return
        ///   Reference to the data value.
        TMin& SetMin(void);
    
        /// Reset the whole object
        void Reset(void);
    
    
    private:
        // Prohibit copy constructor and assignment operator
        C_Range(const C_Range&);
        C_Range& operator=(const C_Range&);
    
        // data
        Uint4 m_set_State[1];
        TSeqPos m_Max;
        TSeqPos m_Min;
    };
    /// some limit value
    enum ELim {
        eLim_unk    =   0,  ///< unknown
        eLim_gt     =   1,  ///< greater than
        eLim_lt     =   2,  ///< less than
        eLim_tr     =   3,  ///< space to right of position
        eLim_tl     =   4,  ///< space to left of position
        eLim_circle =   5,  ///< artificial break at origin of circle
        eLim_other  = 255  ///< something else
    };
    
    /// Access to ELim's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ELim)(void);
    
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,  ///< No variant selected
        e_P_m,          ///< plus or minus fixed amount
        e_Range,
        e_Pct,          ///< % plus or minus (x10) 0-1000
        e_Lim,
        e_Alt           ///< set of alternatives for the integer
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 6 ///< == e_Alt+1
    };
 
    /// Reset the whole object
    virtual void Reset(void);
 
    /// Reset the selection (set it to e_not_set).
    virtual void ResetSelection(void);
 
    /// Which variant is currently selected.
    ///
    /// @return
    ///   Choice state enumerator.
    E_Choice Which(void) const;
 
    /// Verify selection, throw exception if it differs from the expected.
    ///
    /// @param index
    ///   Expected selection.
    void CheckSelected(E_Choice index) const;
 
    /// Throw 'InvalidSelection' exception.
    ///
    /// @param index
    ///   Expected selection.
    NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
 
    /// Retrieve selection name (for diagnostic purposes).
    ///
    /// @param index
    ///   One of possible selection states.
    /// @return
    ///   Name string.
    static string SelectionName(E_Choice index);
 
    /// Select the requested variant if needed.
    ///
    /// @param index
    ///   New selection state.
    /// @param reset
    ///   Flag that defines the resetting of the variant data. The data will
    ///   be reset if either the current selection differs from the new one,
    ///   or the flag is set to eDoResetVariant.
    void Select(E_Choice index, EResetVariant reset = eDoResetVariant);
    /// Select the requested variant if needed,
    /// allocating CObject variants from memory pool.
    void Select(E_Choice index,
                EResetVariant reset,
                CObjectMemoryPool* pool);
 
    // types
    typedef TSeqPos TP_m;
    typedef C_Range TRange;
    typedef int TPct;
    typedef ELim TLim;
    typedef list< TSeqPos > TAlt;
 
    // getters
    // setters
 
 
    /// Check if variant P_m is selected.
    ///
    /// P_m type is defined as 'typedef TSeqPos TP_m'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsP_m(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TP_m GetP_m(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TP_m& SetP_m(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetP_m(TP_m value);
 
 
    /// Check if variant Range is selected.
    ///
    /// Range type is defined as 'typedef C_Range TRange'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsRange(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TRange& GetRange(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TRange& SetRange(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetRange(TRange& value);
 
 
    /// Check if variant Pct is selected.
    ///
    /// Pct type is defined as 'typedef int TPct'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsPct(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TPct GetPct(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TPct& SetPct(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetPct(TPct value);
 
 
    /// Check if variant Lim is selected.
    ///
    /// Lim type is defined as 'typedef ELim TLim'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsLim(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Copy of the variant data.
    TLim GetLim(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TLim& SetLim(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetLim(TLim value);
 
 
    /// Check if variant Alt is selected.
    ///
    /// Alt type is defined as 'typedef list< TSeqPos > TAlt'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsAlt(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TAlt& GetAlt(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TAlt& SetAlt(void);
 
 
private:
    // copy constructor and assignment operator
    CInt_fuzz_Base(const CInt_fuzz_Base& );
    CInt_fuzz_Base& operator=(const CInt_fuzz_Base& );
    // choice state
    E_Choice m_choice;
    // helper methods
    void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
 
    static const char* const sm_SelectionNames[];
    // data
    union {
        TP_m m_P_m;
        TPct m_Pct;
        TLim m_Lim;
        NCBI_NS_NCBI::CUnionBuffer<TAlt> m_Alt;
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CInt_fuzz_Base::C_Range::IsSetMax(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CInt_fuzz_Base::C_Range::CanGetMax(void) const
{
    return IsSetMax();
}
 
inline
void CInt_fuzz_Base::C_Range::ResetMax(void)
{
    m_Max = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CInt_fuzz_Base::C_Range::TMax CInt_fuzz_Base::C_Range::GetMax(void) const
{
    if (!CanGetMax()) {
        ThrowUnassigned(0);
    }
    return m_Max;
}
 
inline
void CInt_fuzz_Base::C_Range::SetMax(CInt_fuzz_Base::C_Range::TMax value)
{
    m_Max = value;
    m_set_State[0] |= 0x3;
}
 
inline
CInt_fuzz_Base::C_Range::TMax& CInt_fuzz_Base::C_Range::SetMax(void)
{
#ifdef _DEBUG
    if (!IsSetMax()) {
        memset(&m_Max,UnassignedByte(),sizeof(m_Max));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Max;
}
 
inline
bool CInt_fuzz_Base::C_Range::IsSetMin(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CInt_fuzz_Base::C_Range::CanGetMin(void) const
{
    return IsSetMin();
}
 
inline
void CInt_fuzz_Base::C_Range::ResetMin(void)
{
    m_Min = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CInt_fuzz_Base::C_Range::TMin CInt_fuzz_Base::C_Range::GetMin(void) const
{
    if (!CanGetMin()) {
        ThrowUnassigned(1);
    }
    return m_Min;
}
 
inline
void CInt_fuzz_Base::C_Range::SetMin(CInt_fuzz_Base::C_Range::TMin value)
{
    m_Min = value;
    m_set_State[0] |= 0xc;
}
 
inline
CInt_fuzz_Base::C_Range::TMin& CInt_fuzz_Base::C_Range::SetMin(void)
{
#ifdef _DEBUG
    if (!IsSetMin()) {
        memset(&m_Min,UnassignedByte(),sizeof(m_Min));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Min;
}
 
inline
CInt_fuzz_Base::E_Choice CInt_fuzz_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CInt_fuzz_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CInt_fuzz_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CInt_fuzz_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CInt_fuzz_Base::IsP_m(void) const
{
    return m_choice == e_P_m;
}
 
inline
CInt_fuzz_Base::TP_m CInt_fuzz_Base::GetP_m(void) const
{
    CheckSelected(e_P_m);
    return m_P_m;
}
 
inline
CInt_fuzz_Base::TP_m& CInt_fuzz_Base::SetP_m(void)
{
    Select(e_P_m, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_P_m;
}
 
inline
void CInt_fuzz_Base::SetP_m(CInt_fuzz_Base::TP_m value)
{
    Select(e_P_m, NCBI_NS_NCBI::eDoNotResetVariant);
    m_P_m = value;
}
 
inline
bool CInt_fuzz_Base::IsRange(void) const
{
    return m_choice == e_Range;
}
 
inline
bool CInt_fuzz_Base::IsPct(void) const
{
    return m_choice == e_Pct;
}
 
inline
CInt_fuzz_Base::TPct CInt_fuzz_Base::GetPct(void) const
{
    CheckSelected(e_Pct);
    return m_Pct;
}
 
inline
CInt_fuzz_Base::TPct& CInt_fuzz_Base::SetPct(void)
{
    Select(e_Pct, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Pct;
}
 
inline
void CInt_fuzz_Base::SetPct(CInt_fuzz_Base::TPct value)
{
    Select(e_Pct, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Pct = value;
}
 
inline
bool CInt_fuzz_Base::IsLim(void) const
{
    return m_choice == e_Lim;
}
 
inline
CInt_fuzz_Base::TLim CInt_fuzz_Base::GetLim(void) const
{
    CheckSelected(e_Lim);
    return m_Lim;
}
 
inline
CInt_fuzz_Base::TLim& CInt_fuzz_Base::SetLim(void)
{
    Select(e_Lim, NCBI_NS_NCBI::eDoNotResetVariant);
    return m_Lim;
}
 
inline
void CInt_fuzz_Base::SetLim(CInt_fuzz_Base::TLim value)
{
    Select(e_Lim, NCBI_NS_NCBI::eDoNotResetVariant);
    m_Lim = value;
}
 
inline
bool CInt_fuzz_Base::IsAlt(void) const
{
    return m_choice == e_Alt;
}
 
inline
const CInt_fuzz_Base::TAlt& CInt_fuzz_Base::GetAlt(void) const
{
    CheckSelected(e_Alt);
    return *m_Alt;
}
 
inline
CInt_fuzz_Base::TAlt& CInt_fuzz_Base::SetAlt(void)
{
    Select(e_Alt, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_Alt;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GENERAL_INT_FUZZ_BASE_HPP