CoreBlock_.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 CoreBlock_.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/scoremat/scoremat.asn">scoremat.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/scoremat/scoremat.def">scoremat.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SCOREMAT_COREBLOCK_BASE_HPP
#define OBJECTS_SCOREMAT_COREBLOCK_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 CBlockProperty;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_ScoreMat
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CCoreBlock_Base --
///
 
class NCBI_SCOREMAT_EXPORT CCoreBlock_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CCoreBlock_Base(void);
    // destructor
    virtual ~CCoreBlock_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TStart;
    typedef int TStop;
    typedef int TMinstart;
    typedef int TMaxstop;
    typedef list< CRef< CBlockProperty > > TProperty;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_start,
        e_stop,
        e_minstart,
        e_maxstop,
        e_property
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// begin of block on query
    /// Check if a value has been assigned to Start data member.
    ///
    /// Data member Start is mandatory;
    /// its type is defined as 'typedef int TStart'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetStart(void) const;
 
    /// Check if it is safe to call GetStart method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetStart(void) const;
 
    /// Reset Start data member.
    void ResetStart(void);
 
    /// Get the Start member data.
    ///
    /// @return
    ///   Copy of the member data.
    TStart GetStart(void) const;
 
    /// Assign a value to Start data member.
    ///
    /// @param value
    ///   Value to assign
    void SetStart(TStart value);
 
    /// Assign a value to Start data member.
    ///
    /// @return
    ///   Reference to the data value.
    TStart& SetStart(void);
 
    /// end of block on query
    /// Check if a value has been assigned to Stop data member.
    ///
    /// Data member Stop is mandatory;
    /// its type is defined as 'typedef int TStop'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetStop(void) const;
 
    /// Check if it is safe to call GetStop method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetStop(void) const;
 
    /// Reset Stop data member.
    void ResetStop(void);
 
    /// Get the Stop member data.
    ///
    /// @return
    ///   Copy of the member data.
    TStop GetStop(void) const;
 
    /// Assign a value to Stop data member.
    ///
    /// @param value
    ///   Value to assign
    void SetStop(TStop value);
 
    /// Assign a value to Stop data member.
    ///
    /// @return
    ///   Reference to the data value.
    TStop& SetStop(void);
 
    /// optional N-terminal extension
    /// Check if a value has been assigned to Minstart data member.
    ///
    /// Data member Minstart is optional;
    /// its type is defined as 'typedef int TMinstart'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMinstart(void) const;
 
    /// Check if it is safe to call GetMinstart method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMinstart(void) const;
 
    /// Reset Minstart data member.
    void ResetMinstart(void);
 
    /// Get the Minstart member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMinstart GetMinstart(void) const;
 
    /// Assign a value to Minstart data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMinstart(TMinstart value);
 
    /// Assign a value to Minstart data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMinstart& SetMinstart(void);
 
    /// optional C-terminal extension
    /// Check if a value has been assigned to Maxstop data member.
    ///
    /// Data member Maxstop is optional;
    /// its type is defined as 'typedef int TMaxstop'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMaxstop(void) const;
 
    /// Check if it is safe to call GetMaxstop method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMaxstop(void) const;
 
    /// Reset Maxstop data member.
    void ResetMaxstop(void);
 
    /// Get the Maxstop member data.
    ///
    /// @return
    ///   Copy of the member data.
    TMaxstop GetMaxstop(void) const;
 
    /// Assign a value to Maxstop data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMaxstop(TMaxstop value);
 
    /// Assign a value to Maxstop data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMaxstop& SetMaxstop(void);
 
    /// Check if a value has been assigned to Property data member.
    ///
    /// Data member Property is optional;
    /// its type is defined as 'typedef list< CRef< CBlockProperty > > TProperty'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetProperty(void) const;
 
    /// Check if it is safe to call GetProperty method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetProperty(void) const;
 
    /// Reset Property data member.
    void ResetProperty(void);
 
    /// Get the Property member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TProperty& GetProperty(void) const;
 
    /// Assign a value to Property data member.
    ///
    /// @return
    ///   Reference to the data value.
    TProperty& SetProperty(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CCoreBlock_Base(const CCoreBlock_Base&);
    CCoreBlock_Base& operator=(const CCoreBlock_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Start;
    int m_Stop;
    int m_Minstart;
    int m_Maxstop;
    list< CRef< CBlockProperty > > m_Property;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CCoreBlock_Base::IsSetStart(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CCoreBlock_Base::CanGetStart(void) const
{
    return IsSetStart();
}
 
inline
void CCoreBlock_Base::ResetStart(void)
{
    m_Start = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CCoreBlock_Base::TStart CCoreBlock_Base::GetStart(void) const
{
    if (!CanGetStart()) {
        ThrowUnassigned(0);
    }
    return m_Start;
}
 
inline
void CCoreBlock_Base::SetStart(CCoreBlock_Base::TStart value)
{
    m_Start = value;
    m_set_State[0] |= 0x3;
}
 
inline
CCoreBlock_Base::TStart& CCoreBlock_Base::SetStart(void)
{
#ifdef _DEBUG
    if (!IsSetStart()) {
        memset(&m_Start,UnassignedByte(),sizeof(m_Start));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Start;
}
 
inline
bool CCoreBlock_Base::IsSetStop(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CCoreBlock_Base::CanGetStop(void) const
{
    return IsSetStop();
}
 
inline
void CCoreBlock_Base::ResetStop(void)
{
    m_Stop = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CCoreBlock_Base::TStop CCoreBlock_Base::GetStop(void) const
{
    if (!CanGetStop()) {
        ThrowUnassigned(1);
    }
    return m_Stop;
}
 
inline
void CCoreBlock_Base::SetStop(CCoreBlock_Base::TStop value)
{
    m_Stop = value;
    m_set_State[0] |= 0xc;
}
 
inline
CCoreBlock_Base::TStop& CCoreBlock_Base::SetStop(void)
{
#ifdef _DEBUG
    if (!IsSetStop()) {
        memset(&m_Stop,UnassignedByte(),sizeof(m_Stop));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Stop;
}
 
inline
bool CCoreBlock_Base::IsSetMinstart(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CCoreBlock_Base::CanGetMinstart(void) const
{
    return IsSetMinstart();
}
 
inline
void CCoreBlock_Base::ResetMinstart(void)
{
    m_Minstart = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CCoreBlock_Base::TMinstart CCoreBlock_Base::GetMinstart(void) const
{
    if (!CanGetMinstart()) {
        ThrowUnassigned(2);
    }
    return m_Minstart;
}
 
inline
void CCoreBlock_Base::SetMinstart(CCoreBlock_Base::TMinstart value)
{
    m_Minstart = value;
    m_set_State[0] |= 0x30;
}
 
inline
CCoreBlock_Base::TMinstart& CCoreBlock_Base::SetMinstart(void)
{
#ifdef _DEBUG
    if (!IsSetMinstart()) {
        memset(&m_Minstart,UnassignedByte(),sizeof(m_Minstart));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Minstart;
}
 
inline
bool CCoreBlock_Base::IsSetMaxstop(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CCoreBlock_Base::CanGetMaxstop(void) const
{
    return IsSetMaxstop();
}
 
inline
void CCoreBlock_Base::ResetMaxstop(void)
{
    m_Maxstop = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CCoreBlock_Base::TMaxstop CCoreBlock_Base::GetMaxstop(void) const
{
    if (!CanGetMaxstop()) {
        ThrowUnassigned(3);
    }
    return m_Maxstop;
}
 
inline
void CCoreBlock_Base::SetMaxstop(CCoreBlock_Base::TMaxstop value)
{
    m_Maxstop = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CCoreBlock_Base::TMaxstop& CCoreBlock_Base::SetMaxstop(void)
{
#ifdef _DEBUG
    if (!IsSetMaxstop()) {
        memset(&m_Maxstop,UnassignedByte(),sizeof(m_Maxstop));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Maxstop;
}
 
inline
bool CCoreBlock_Base::IsSetProperty(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CCoreBlock_Base::CanGetProperty(void) const
{
    return true;
}
 
inline
const CCoreBlock_Base::TProperty& CCoreBlock_Base::GetProperty(void) const
{
    return m_Property;
}
 
inline
CCoreBlock_Base::TProperty& CCoreBlock_Base::SetProperty(void)
{
    m_set_State[0] |= 0x100;
    return m_Property;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SCOREMAT_COREBLOCK_BASE_HPP