Intron_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 Intron_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_INTRON_PARAMS_BASE_HPP
#define ALGO_GNOMON_INTRON_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::
 
 
// forward declarations
class CLength_distribution_params;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GNOMON
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CIntron_params_Base --
///
 
class NCBI_XALGOGNOMON_EXPORT CIntron_params_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CIntron_params_Base(void);
    // destructor
    virtual ~CIntron_params_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef double TInitp;
    typedef list< double > TPhase_probabilities;
    typedef double TTo_term;
    typedef CLength_distribution_params TLength;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_initp,
        e_phase_probabilities,
        e_to_term,
        e_length
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 5> TmemberIndex;
 
    // getters
    // setters
 
    /// probability of a genomic point be in an intron
    /// Check if a value has been assigned to Initp data member.
    ///
    /// Data member Initp is mandatory;
    /// its type is defined as 'typedef double TInitp'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetInitp(void) const;
 
    /// Check if it is safe to call GetInitp method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetInitp(void) const;
 
    /// Reset Initp data member.
    void ResetInitp(void);
 
    /// Get the Initp member data.
    ///
    /// @return
    ///   Copy of the member data.
    TInitp GetInitp(void) const;
 
    /// Assign a value to Initp data member.
    ///
    /// @param value
    ///   Value to assign
    void SetInitp(TInitp value);
 
    /// Assign a value to Initp data member.
    ///
    /// @return
    ///   Reference to the data value.
    TInitp& SetInitp(void);
 
    /// 3 elements (per phase)
    /// Check if a value has been assigned to Phase_probabilities data member.
    ///
    /// Data member Phase_probabilities is mandatory;
    /// its type is defined as 'typedef list< double > TPhase_probabilities'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPhase_probabilities(void) const;
 
    /// Check if it is safe to call GetPhase_probabilities method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPhase_probabilities(void) const;
 
    /// Reset Phase_probabilities data member.
    void ResetPhase_probabilities(void);
 
    /// Get the Phase_probabilities member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPhase_probabilities& GetPhase_probabilities(void) const;
 
    /// Assign a value to Phase_probabilities data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPhase_probabilities& SetPhase_probabilities(void);
 
    /// probability to be the last 
    /// Check if a value has been assigned to To_term data member.
    ///
    /// Data member To_term is mandatory;
    /// its type is defined as 'typedef double TTo_term'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetTo_term(void) const;
 
    /// Check if it is safe to call GetTo_term method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetTo_term(void) const;
 
    /// Reset To_term data member.
    void ResetTo_term(void);
 
    /// Get the To_term member data.
    ///
    /// @return
    ///   Copy of the member data.
    TTo_term GetTo_term(void) const;
 
    /// Assign a value to To_term data member.
    ///
    /// @param value
    ///   Value to assign
    void SetTo_term(TTo_term value);
 
    /// Assign a value to To_term data member.
    ///
    /// @return
    ///   Reference to the data value.
    TTo_term& SetTo_term(void);
 
    /// Check if a value has been assigned to Length data member.
    ///
    /// Data member Length is mandatory;
    /// its type is defined as 'typedef CLength_distribution_params TLength'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLength(void) const;
 
    /// Check if it is safe to call GetLength method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLength(void) const;
 
    /// Reset Length data member.
    void ResetLength(void);
 
    /// Get the Length member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLength& GetLength(void) const;
 
    /// Assign a value to Length data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetLength(TLength& value);
 
    /// Assign a value to Length data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLength& SetLength(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CIntron_params_Base(const CIntron_params_Base&);
    CIntron_params_Base& operator=(const CIntron_params_Base&);
 
    // data
    Uint4 m_set_State[1];
    double m_Initp;
    list< double > m_Phase_probabilities;
    double m_To_term;
    CRef< TLength > m_Length;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CIntron_params_Base::IsSetInitp(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CIntron_params_Base::CanGetInitp(void) const
{
    return IsSetInitp();
}
 
inline
void CIntron_params_Base::ResetInitp(void)
{
    m_Initp = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CIntron_params_Base::TInitp CIntron_params_Base::GetInitp(void) const
{
    if (!CanGetInitp()) {
        ThrowUnassigned(0);
    }
    return m_Initp;
}
 
inline
void CIntron_params_Base::SetInitp(CIntron_params_Base::TInitp value)
{
    m_Initp = value;
    m_set_State[0] |= 0x3;
}
 
inline
CIntron_params_Base::TInitp& CIntron_params_Base::SetInitp(void)
{
#ifdef _DEBUG
    if (!IsSetInitp()) {
        memset(&m_Initp,UnassignedByte(),sizeof(m_Initp));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Initp;
}
 
inline
bool CIntron_params_Base::IsSetPhase_probabilities(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CIntron_params_Base::CanGetPhase_probabilities(void) const
{
    return true;
}
 
inline
const CIntron_params_Base::TPhase_probabilities& CIntron_params_Base::GetPhase_probabilities(void) const
{
    return m_Phase_probabilities;
}
 
inline
CIntron_params_Base::TPhase_probabilities& CIntron_params_Base::SetPhase_probabilities(void)
{
    m_set_State[0] |= 0x4;
    return m_Phase_probabilities;
}
 
inline
bool CIntron_params_Base::IsSetTo_term(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CIntron_params_Base::CanGetTo_term(void) const
{
    return IsSetTo_term();
}
 
inline
void CIntron_params_Base::ResetTo_term(void)
{
    m_To_term = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CIntron_params_Base::TTo_term CIntron_params_Base::GetTo_term(void) const
{
    if (!CanGetTo_term()) {
        ThrowUnassigned(2);
    }
    return m_To_term;
}
 
inline
void CIntron_params_Base::SetTo_term(CIntron_params_Base::TTo_term value)
{
    m_To_term = value;
    m_set_State[0] |= 0x30;
}
 
inline
CIntron_params_Base::TTo_term& CIntron_params_Base::SetTo_term(void)
{
#ifdef _DEBUG
    if (!IsSetTo_term()) {
        memset(&m_To_term,UnassignedByte(),sizeof(m_To_term));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_To_term;
}
 
inline
bool CIntron_params_Base::IsSetLength(void) const
{
    return m_Length.NotEmpty();
}
 
inline
bool CIntron_params_Base::CanGetLength(void) const
{
    return true;
}
 
inline
const CIntron_params_Base::TLength& CIntron_params_Base::GetLength(void) const
{
    if ( !m_Length ) {
        const_cast<CIntron_params_Base*>(this)->ResetLength();
    }
    return (*m_Length);
}
 
inline
CIntron_params_Base::TLength& CIntron_params_Base::SetLength(void)
{
    if ( !m_Length ) {
        ResetLength();
    }
    return (*m_Length);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // ALGO_GNOMON_INTRON_PARAMS_BASE_HPP