ID2S_Split_Info_.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_Split_Info_.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_SPLIT_INFO_BASE_HPP
#define OBJECTS_SEQSPLIT_ID2S_SPLIT_INFO_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 CID2S_Bioseqs_Info;
class CID2S_Chunk_Info;
class CSeq_entry;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Seq_split
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
/// Blob split info types
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
/// Chunks split description
///
/// CID2S_Split_Info_Base --
///
 
class NCBI_ID2_EXPORT CID2S_Split_Info_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CID2S_Split_Info_Base(void);
    // destructor
    virtual ~CID2S_Split_Info_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef list< CRef< CID2S_Bioseqs_Info > > TBioseqs_info;
    typedef list< CRef< CID2S_Chunk_Info > > TChunks;
    typedef CSeq_entry TSkeleton;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_bioseqs_info,
        e_chunks,
        e_skeleton
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Bioseqs_info data member.
    ///
    /// Data member Bioseqs_info is optional;
    /// its type is defined as 'typedef list< CRef< CID2S_Bioseqs_Info > > TBioseqs_info'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBioseqs_info(void) const;
 
    /// Check if it is safe to call GetBioseqs_info method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBioseqs_info(void) const;
 
    /// Reset Bioseqs_info data member.
    void ResetBioseqs_info(void);
 
    /// Get the Bioseqs_info member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBioseqs_info& GetBioseqs_info(void) const;
 
    /// Assign a value to Bioseqs_info data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBioseqs_info& SetBioseqs_info(void);
 
    /// Check if a value has been assigned to Chunks data member.
    ///
    /// Data member Chunks is mandatory;
    /// its type is defined as 'typedef list< CRef< CID2S_Chunk_Info > > TChunks'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetChunks(void) const;
 
    /// Check if it is safe to call GetChunks method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetChunks(void) const;
 
    /// Reset Chunks data member.
    void ResetChunks(void);
 
    /// Get the Chunks member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TChunks& GetChunks(void) const;
 
    /// Assign a value to Chunks data member.
    ///
    /// @return
    ///   Reference to the data value.
    TChunks& SetChunks(void);
 
    /// Check if a value has been assigned to Skeleton data member.
    ///
    /// Data member Skeleton is optional;
    /// its type is defined as 'typedef CSeq_entry TSkeleton'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSkeleton(void) const;
 
    /// Check if it is safe to call GetSkeleton method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSkeleton(void) const;
 
    /// Reset Skeleton data member.
    void ResetSkeleton(void);
 
    /// Get the Skeleton member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSkeleton& GetSkeleton(void) const;
 
    /// Assign a value to Skeleton data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSkeleton(TSkeleton& value);
 
    /// Assign a value to Skeleton data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSkeleton& SetSkeleton(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CID2S_Split_Info_Base(const CID2S_Split_Info_Base&);
    CID2S_Split_Info_Base& operator=(const CID2S_Split_Info_Base&);
 
    // data
    Uint4 m_set_State[1];
    list< CRef< CID2S_Bioseqs_Info > > m_Bioseqs_info;
    list< CRef< CID2S_Chunk_Info > > m_Chunks;
    CRef< TSkeleton > m_Skeleton;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CID2S_Split_Info_Base::IsSetBioseqs_info(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CID2S_Split_Info_Base::CanGetBioseqs_info(void) const
{
    return true;
}
 
inline
const CID2S_Split_Info_Base::TBioseqs_info& CID2S_Split_Info_Base::GetBioseqs_info(void) const
{
    return m_Bioseqs_info;
}
 
inline
CID2S_Split_Info_Base::TBioseqs_info& CID2S_Split_Info_Base::SetBioseqs_info(void)
{
    m_set_State[0] |= 0x1;
    return m_Bioseqs_info;
}
 
inline
bool CID2S_Split_Info_Base::IsSetChunks(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CID2S_Split_Info_Base::CanGetChunks(void) const
{
    return true;
}
 
inline
const CID2S_Split_Info_Base::TChunks& CID2S_Split_Info_Base::GetChunks(void) const
{
    return m_Chunks;
}
 
inline
CID2S_Split_Info_Base::TChunks& CID2S_Split_Info_Base::SetChunks(void)
{
    m_set_State[0] |= 0x4;
    return m_Chunks;
}
 
inline
bool CID2S_Split_Info_Base::IsSetSkeleton(void) const
{
    return m_Skeleton.NotEmpty();
}
 
inline
bool CID2S_Split_Info_Base::CanGetSkeleton(void) const
{
    return IsSetSkeleton();
}
 
inline
const CID2S_Split_Info_Base::TSkeleton& CID2S_Split_Info_Base::GetSkeleton(void) const
{
    if (!CanGetSkeleton()) {
        ThrowUnassigned(2);
    }
    return (*m_Skeleton);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQSPLIT_ID2S_SPLIT_INFO_BASE_HPP