ID2S_Sequence_Piece_.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 ID2S_Sequence_Piece_.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/seqsplit/seqsplit.asn">seqsplit.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqsplit/seqsplit.def">seqsplit.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQSPLIT_ID2S_SEQUENCE_PIECE_BASE_HPP
#define OBJECTS_SEQSPLIT_ID2S_SEQUENCE_PIECE_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 CSeq_literal;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Seq_split
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CID2S_Sequence_Piece_Base --
///
 
class NCBI_ID2_EXPORT CID2S_Sequence_Piece_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CID2S_Sequence_Piece_Base(void);
    // destructor
    virtual ~CID2S_Sequence_Piece_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef TSeqPos TStart;
    typedef list< CRef< CSeq_literal > > TData;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_start,
        e_data
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// start position on sequence
    /// Check if a value has been assigned to Start data member.
    ///
    /// Data member Start is mandatory;
    /// its type is defined as 'typedef TSeqPos 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);
 
    /// Check if a value has been assigned to Data data member.
    ///
    /// Data member Data is mandatory;
    /// its type is defined as 'typedef list< CRef< CSeq_literal > > TData'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetData(void) const;
 
    /// Check if it is safe to call GetData method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetData(void) const;
 
    /// Reset Data data member.
    void ResetData(void);
 
    /// Get the Data member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TData& GetData(void) const;
 
    /// Assign a value to Data data member.
    ///
    /// @return
    ///   Reference to the data value.
    TData& SetData(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CID2S_Sequence_Piece_Base(const CID2S_Sequence_Piece_Base&);
    CID2S_Sequence_Piece_Base& operator=(const CID2S_Sequence_Piece_Base&);
 
    // data
    Uint4 m_set_State[1];
    TSeqPos m_Start;
    list< CRef< CSeq_literal > > m_Data;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CID2S_Sequence_Piece_Base::IsSetStart(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CID2S_Sequence_Piece_Base::CanGetStart(void) const
{
    return IsSetStart();
}
 
inline
void CID2S_Sequence_Piece_Base::ResetStart(void)
{
    m_Start = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CID2S_Sequence_Piece_Base::TStart CID2S_Sequence_Piece_Base::GetStart(void) const
{
    if (!CanGetStart()) {
        ThrowUnassigned(0);
    }
    return m_Start;
}
 
inline
void CID2S_Sequence_Piece_Base::SetStart(CID2S_Sequence_Piece_Base::TStart value)
{
    m_Start = value;
    m_set_State[0] |= 0x3;
}
 
inline
CID2S_Sequence_Piece_Base::TStart& CID2S_Sequence_Piece_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 CID2S_Sequence_Piece_Base::IsSetData(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CID2S_Sequence_Piece_Base::CanGetData(void) const
{
    return true;
}
 
inline
const CID2S_Sequence_Piece_Base::TData& CID2S_Sequence_Piece_Base::GetData(void) const
{
    return m_Data;
}
 
inline
CID2S_Sequence_Piece_Base::TData& CID2S_Sequence_Piece_Base::SetData(void)
{
    m_set_State[0] |= 0x4;
    return m_Data;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQSPLIT_ID2S_SEQUENCE_PIECE_BASE_HPP