Length_distribution_params_.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 Length_distribution_params_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/gnomon/gnomon.asn">gnomon.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/algo/gnomon/gnomon.def">gnomon.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef ALGO_GNOMON_LENGTH_DISTRIBUTION_PARAMS_BASE_HPP
#define ALGO_GNOMON_LENGTH_DISTRIBUTION_PARAMS_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_GNOMON
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CLength_distribution_params_Base --
///
 
class NCBI_XALGOGNOMON_EXPORT CLength_distribution_params_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CLength_distribution_params_Base(void);
    // destructor
    virtual ~CLength_distribution_params_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    /////////////////////////////////////////////////////////////////////////////
    ///
    /// C_Range --
    ///
    
    class NCBI_XALGOGNOMON_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 int TMin;
        typedef int TMax;
    
        // member index
        enum class E_memberIndex {
            e__allMandatory = 0,
            e_min,
            e_max
        };
        typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
    
        // getters
        // setters
    
        /// Check if a value has been assigned to Min data member.
        ///
        /// Data member Min is mandatory;
        /// its type is defined as 'typedef int 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);
    
        /// Check if a value has been assigned to Max data member.
        ///
        /// Data member Max is mandatory;
        /// its type is defined as 'typedef int 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);
    
        /// 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];
        int m_Min;
        int m_Max;
    };
    // types
    typedef int TStep;
    typedef list< double > TP;
    typedef double TA;
    typedef double TL;
    typedef C_Range TRange;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_step,
        e_p,
        e_a,
        e_l,
        e_range
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Step data member.
    ///
    /// Data member Step is mandatory;
    /// its type is defined as 'typedef int TStep'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetStep(void) const;
 
    /// Check if it is safe to call GetStep method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetStep(void) const;
 
    /// Reset Step data member.
    void ResetStep(void);
 
    /// Get the Step member data.
    ///
    /// @return
    ///   Copy of the member data.
    TStep GetStep(void) const;
 
    /// Assign a value to Step data member.
    ///
    /// @param value
    ///   Value to assign
    void SetStep(TStep value);
 
    /// Assign a value to Step data member.
    ///
    /// @return
    ///   Reference to the data value.
    TStep& SetStep(void);
 
    /// P(step*(i+.5))|i=0,1,...,N-1
    /// Check if a value has been assigned to P data member.
    ///
    /// Data member P is mandatory;
    /// its type is defined as 'typedef list< double > TP'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetP(void) const;
 
    /// Check if it is safe to call GetP method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetP(void) const;
 
    /// Reset P data member.
    void ResetP(void);
 
    /// Get the P member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TP& GetP(void) const;
 
    /// Assign a value to P data member.
    ///
    /// @return
    ///   Reference to the data value.
    TP& SetP(void);
 
    /// Loretz function coefficient for the tail
    /// Check if a value has been assigned to A data member.
    ///
    /// Data member A is mandatory;
    /// its type is defined as 'typedef double TA'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetA(void) const;
 
    /// Check if it is safe to call GetA method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetA(void) const;
 
    /// Reset A data member.
    void ResetA(void);
 
    /// Get the A member data.
    ///
    /// @return
    ///   Copy of the member data.
    TA GetA(void) const;
 
    /// Assign a value to A data member.
    ///
    /// @param value
    ///   Value to assign
    void SetA(TA value);
 
    /// Assign a value to A data member.
    ///
    /// @return
    ///   Reference to the data value.
    TA& SetA(void);
 
    /// Loretz function coefficient for the tail
    /// Check if a value has been assigned to L data member.
    ///
    /// Data member L is mandatory;
    /// its type is defined as 'typedef double TL'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetL(void) const;
 
    /// Check if it is safe to call GetL method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetL(void) const;
 
    /// Reset L data member.
    void ResetL(void);
 
    /// Get the L member data.
    ///
    /// @return
    ///   Copy of the member data.
    TL GetL(void) const;
 
    /// Assign a value to L data member.
    ///
    /// @param value
    ///   Value to assign
    void SetL(TL value);
 
    /// Assign a value to L data member.
    ///
    /// @return
    ///   Reference to the data value.
    TL& SetL(void);
 
    /// Check if a value has been assigned to Range data member.
    ///
    /// Data member Range is mandatory;
    /// its type is defined as 'typedef C_Range TRange'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetRange(void) const;
 
    /// Check if it is safe to call GetRange method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetRange(void) const;
 
    /// Reset Range data member.
    void ResetRange(void);
 
    /// Get the Range member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TRange& GetRange(void) const;
 
    /// Assign a value to Range data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetRange(TRange& value);
 
    /// Assign a value to Range data member.
    ///
    /// @return
    ///   Reference to the data value.
    TRange& SetRange(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CLength_distribution_params_Base(const CLength_distribution_params_Base&);
    CLength_distribution_params_Base& operator=(const CLength_distribution_params_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Step;
    list< double > m_P;
    double m_A;
    double m_L;
    CRef< TRange > m_Range;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CLength_distribution_params_Base::C_Range::IsSetMin(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CLength_distribution_params_Base::C_Range::CanGetMin(void) const
{
    return IsSetMin();
}
 
inline
void CLength_distribution_params_Base::C_Range::ResetMin(void)
{
    m_Min = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CLength_distribution_params_Base::C_Range::TMin CLength_distribution_params_Base::C_Range::GetMin(void) const
{
    if (!CanGetMin()) {
        ThrowUnassigned(0);
    }
    return m_Min;
}
 
inline
void CLength_distribution_params_Base::C_Range::SetMin(CLength_distribution_params_Base::C_Range::TMin value)
{
    m_Min = value;
    m_set_State[0] |= 0x3;
}
 
inline
CLength_distribution_params_Base::C_Range::TMin& CLength_distribution_params_Base::C_Range::SetMin(void)
{
#ifdef _DEBUG
    if (!IsSetMin()) {
        memset(&m_Min,UnassignedByte(),sizeof(m_Min));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Min;
}
 
inline
bool CLength_distribution_params_Base::C_Range::IsSetMax(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CLength_distribution_params_Base::C_Range::CanGetMax(void) const
{
    return IsSetMax();
}
 
inline
void CLength_distribution_params_Base::C_Range::ResetMax(void)
{
    m_Max = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CLength_distribution_params_Base::C_Range::TMax CLength_distribution_params_Base::C_Range::GetMax(void) const
{
    if (!CanGetMax()) {
        ThrowUnassigned(1);
    }
    return m_Max;
}
 
inline
void CLength_distribution_params_Base::C_Range::SetMax(CLength_distribution_params_Base::C_Range::TMax value)
{
    m_Max = value;
    m_set_State[0] |= 0xc;
}
 
inline
CLength_distribution_params_Base::C_Range::TMax& CLength_distribution_params_Base::C_Range::SetMax(void)
{
#ifdef _DEBUG
    if (!IsSetMax()) {
        memset(&m_Max,UnassignedByte(),sizeof(m_Max));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Max;
}
 
inline
bool CLength_distribution_params_Base::IsSetStep(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CLength_distribution_params_Base::CanGetStep(void) const
{
    return IsSetStep();
}
 
inline
void CLength_distribution_params_Base::ResetStep(void)
{
    m_Step = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CLength_distribution_params_Base::TStep CLength_distribution_params_Base::GetStep(void) const
{
    if (!CanGetStep()) {
        ThrowUnassigned(0);
    }
    return m_Step;
}
 
inline
void CLength_distribution_params_Base::SetStep(CLength_distribution_params_Base::TStep value)
{
    m_Step = value;
    m_set_State[0] |= 0x3;
}
 
inline
CLength_distribution_params_Base::TStep& CLength_distribution_params_Base::SetStep(void)
{
#ifdef _DEBUG
    if (!IsSetStep()) {
        memset(&m_Step,UnassignedByte(),sizeof(m_Step));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Step;
}
 
inline
bool CLength_distribution_params_Base::IsSetP(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CLength_distribution_params_Base::CanGetP(void) const
{
    return true;
}
 
inline
const CLength_distribution_params_Base::TP& CLength_distribution_params_Base::GetP(void) const
{
    return m_P;
}
 
inline
CLength_distribution_params_Base::TP& CLength_distribution_params_Base::SetP(void)
{
    m_set_State[0] |= 0x4;
    return m_P;
}
 
inline
bool CLength_distribution_params_Base::IsSetA(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CLength_distribution_params_Base::CanGetA(void) const
{
    return IsSetA();
}
 
inline
void CLength_distribution_params_Base::ResetA(void)
{
    m_A = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CLength_distribution_params_Base::TA CLength_distribution_params_Base::GetA(void) const
{
    if (!CanGetA()) {
        ThrowUnassigned(2);
    }
    return m_A;
}
 
inline
void CLength_distribution_params_Base::SetA(CLength_distribution_params_Base::TA value)
{
    m_A = value;
    m_set_State[0] |= 0x30;
}
 
inline
CLength_distribution_params_Base::TA& CLength_distribution_params_Base::SetA(void)
{
#ifdef _DEBUG
    if (!IsSetA()) {
        memset(&m_A,UnassignedByte(),sizeof(m_A));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_A;
}
 
inline
bool CLength_distribution_params_Base::IsSetL(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CLength_distribution_params_Base::CanGetL(void) const
{
    return IsSetL();
}
 
inline
void CLength_distribution_params_Base::ResetL(void)
{
    m_L = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CLength_distribution_params_Base::TL CLength_distribution_params_Base::GetL(void) const
{
    if (!CanGetL()) {
        ThrowUnassigned(3);
    }
    return m_L;
}
 
inline
void CLength_distribution_params_Base::SetL(CLength_distribution_params_Base::TL value)
{
    m_L = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CLength_distribution_params_Base::TL& CLength_distribution_params_Base::SetL(void)
{
#ifdef _DEBUG
    if (!IsSetL()) {
        memset(&m_L,UnassignedByte(),sizeof(m_L));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_L;
}
 
inline
bool CLength_distribution_params_Base::IsSetRange(void) const
{
    return m_Range.NotEmpty();
}
 
inline
bool CLength_distribution_params_Base::CanGetRange(void) const
{
    return true;
}
 
inline
const CLength_distribution_params_Base::TRange& CLength_distribution_params_Base::GetRange(void) const
{
    if ( !m_Range ) {
        const_cast<CLength_distribution_params_Base*>(this)->ResetRange();
    }
    return (*m_Range);
}
 
inline
CLength_distribution_params_Base::TRange& CLength_distribution_params_Base::SetRange(void)
{
    if ( !m_Range ) {
        ResetRange();
    }
    return (*m_Range);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_GNOMON_LENGTH_DISTRIBUTION_PARAMS_BASE_HPP