Cdd_tree_.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 Cdd_tree_.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/cdd/cdd.asn">cdd.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cdd/cdd.def">cdd.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_CDD_CDD_TREE_BASE_HPP
#define OBJECTS_CDD_CDD_TREE_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
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 CCdd_descr_set;
class CCdd_id;
class CCdd_id_set;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Cdd
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// the Cdd-tree stores the hierarchy of CDDs. These objects are stored separate
/// from the CDs to allow for fast retrieval and use as an 'index' into CDs
/// all the components in a CD-tree match components in the full-sized CD
/// and should be synchronized
///
/// CCdd_tree_Base --
///
 
class NCBI_CDD_EXPORT CCdd_tree_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CCdd_tree_Base(void);
    // destructor
    virtual ~CCdd_tree_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TName;
    typedef CCdd_id_set TId;
    typedef CCdd_descr_set TDescription;
    typedef CCdd_id TParent;
    typedef CCdd_id_set TChildren;
    typedef CCdd_id_set TSiblings;
    typedef CCdd_id_set TNeighbors;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_name,
        e_id,
        e_description,
        e_parent,
        e_children,
        e_siblings,
        e_neighbors
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 8> TmemberIndex;
 
    // getters
    // setters
 
    /// short name  copied from CD
    /// Check if a value has been assigned to Name data member.
    ///
    /// Data member Name is mandatory;
    /// its type is defined as 'typedef string TName'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetName(void) const;
 
    /// Check if it is safe to call GetName method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetName(void) const;
 
    /// Reset Name data member.
    void ResetName(void);
 
    /// Get the Name member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TName& GetName(void) const;
 
    /// Assign a value to Name data member.
    ///
    /// @param value
    ///   Value to assign
    void SetName(const TName& value);
    void SetName(TName&& value);
 
    /// Assign a value to Name data member.
    ///
    /// @return
    ///   Reference to the data value.
    TName& SetName(void);
 
    /// IDs         copied from CD
    /// Check if a value has been assigned to Id data member.
    ///
    /// Data member Id is mandatory;
    /// its type is defined as 'typedef CCdd_id_set TId'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetId(void) const;
 
    /// Check if it is safe to call GetId method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetId(void) const;
 
    /// Reset Id data member.
    void ResetId(void);
 
    /// Get the Id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TId& GetId(void) const;
 
    /// Assign a value to Id data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetId(TId& value);
 
    /// Assign a value to Id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TId& SetId(void);
 
    /// description copied from CD
    /// Check if a value has been assigned to Description data member.
    ///
    /// Data member Description is optional;
    /// its type is defined as 'typedef CCdd_descr_set TDescription'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDescription(void) const;
 
    /// Check if it is safe to call GetDescription method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDescription(void) const;
 
    /// Reset Description data member.
    void ResetDescription(void);
 
    /// Get the Description member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDescription& GetDescription(void) const;
 
    /// Assign a value to Description data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetDescription(TDescription& value);
 
    /// Assign a value to Description data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDescription& SetDescription(void);
 
    /// CD is the result of a split/merge
    /// Check if a value has been assigned to Parent data member.
    ///
    /// Data member Parent is optional;
    /// its type is defined as 'typedef CCdd_id TParent'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetParent(void) const;
 
    /// Check if it is safe to call GetParent method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetParent(void) const;
 
    /// Reset Parent data member.
    void ResetParent(void);
 
    /// Get the Parent member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TParent& GetParent(void) const;
 
    /// Assign a value to Parent data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetParent(TParent& value);
 
    /// Assign a value to Parent data member.
    ///
    /// @return
    ///   Reference to the data value.
    TParent& SetParent(void);
 
    /// this CD has been split
    /// Check if a value has been assigned to Children data member.
    ///
    /// Data member Children is optional;
    /// its type is defined as 'typedef CCdd_id_set TChildren'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetChildren(void) const;
 
    /// Check if it is safe to call GetChildren method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetChildren(void) const;
 
    /// Reset Children data member.
    void ResetChildren(void);
 
    /// Get the Children member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TChildren& GetChildren(void) const;
 
    /// Assign a value to Children data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetChildren(TChildren& value);
 
    /// Assign a value to Children data member.
    ///
    /// @return
    ///   Reference to the data value.
    TChildren& SetChildren(void);
 
    /// related CDs (have common hits)
    /// Check if a value has been assigned to Siblings data member.
    ///
    /// Data member Siblings is optional;
    /// its type is defined as 'typedef CCdd_id_set TSiblings'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSiblings(void) const;
 
    /// Check if it is safe to call GetSiblings method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSiblings(void) const;
 
    /// Reset Siblings data member.
    void ResetSiblings(void);
 
    /// Get the Siblings member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSiblings& GetSiblings(void) const;
 
    /// Assign a value to Siblings data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSiblings(TSiblings& value);
 
    /// Assign a value to Siblings data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSiblings& SetSiblings(void);
 
    /// co-occurring CDs (non-overlapping 
    /// hits to same sequences)
    /// Check if a value has been assigned to Neighbors data member.
    ///
    /// Data member Neighbors is optional;
    /// its type is defined as 'typedef CCdd_id_set TNeighbors'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetNeighbors(void) const;
 
    /// Check if it is safe to call GetNeighbors method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetNeighbors(void) const;
 
    /// Reset Neighbors data member.
    void ResetNeighbors(void);
 
    /// Get the Neighbors member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TNeighbors& GetNeighbors(void) const;
 
    /// Assign a value to Neighbors data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetNeighbors(TNeighbors& value);
 
    /// Assign a value to Neighbors data member.
    ///
    /// @return
    ///   Reference to the data value.
    TNeighbors& SetNeighbors(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CCdd_tree_Base(const CCdd_tree_Base&);
    CCdd_tree_Base& operator=(const CCdd_tree_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Name;
    CRef< TId > m_Id;
    CRef< TDescription > m_Description;
    CRef< TParent > m_Parent;
    CRef< TChildren > m_Children;
    CRef< TSiblings > m_Siblings;
    CRef< TNeighbors > m_Neighbors;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CCdd_tree_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CCdd_tree_Base::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CCdd_tree_Base::TName& CCdd_tree_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(0);
    }
    return m_Name;
}
 
inline
void CCdd_tree_Base::SetName(const CCdd_tree_Base::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CCdd_tree_Base::SetName(CCdd_tree_Base::TName&& value)
{
    m_Name = std::forward<CCdd_tree_Base::TName>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CCdd_tree_Base::TName& CCdd_tree_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Name;
}
 
inline
bool CCdd_tree_Base::IsSetId(void) const
{
    return m_Id.NotEmpty();
}
 
inline
bool CCdd_tree_Base::CanGetId(void) const
{
    return true;
}
 
inline
const CCdd_tree_Base::TId& CCdd_tree_Base::GetId(void) const
{
    if ( !m_Id ) {
        const_cast<CCdd_tree_Base*>(this)->ResetId();
    }
    return (*m_Id);
}
 
inline
CCdd_tree_Base::TId& CCdd_tree_Base::SetId(void)
{
    if ( !m_Id ) {
        ResetId();
    }
    return (*m_Id);
}
 
inline
bool CCdd_tree_Base::IsSetDescription(void) const
{
    return m_Description.NotEmpty();
}
 
inline
bool CCdd_tree_Base::CanGetDescription(void) const
{
    return IsSetDescription();
}
 
inline
const CCdd_tree_Base::TDescription& CCdd_tree_Base::GetDescription(void) const
{
    if (!CanGetDescription()) {
        ThrowUnassigned(2);
    }
    return (*m_Description);
}
 
inline
bool CCdd_tree_Base::IsSetParent(void) const
{
    return m_Parent.NotEmpty();
}
 
inline
bool CCdd_tree_Base::CanGetParent(void) const
{
    return IsSetParent();
}
 
inline
const CCdd_tree_Base::TParent& CCdd_tree_Base::GetParent(void) const
{
    if (!CanGetParent()) {
        ThrowUnassigned(3);
    }
    return (*m_Parent);
}
 
inline
bool CCdd_tree_Base::IsSetChildren(void) const
{
    return m_Children.NotEmpty();
}
 
inline
bool CCdd_tree_Base::CanGetChildren(void) const
{
    return IsSetChildren();
}
 
inline
const CCdd_tree_Base::TChildren& CCdd_tree_Base::GetChildren(void) const
{
    if (!CanGetChildren()) {
        ThrowUnassigned(4);
    }
    return (*m_Children);
}
 
inline
bool CCdd_tree_Base::IsSetSiblings(void) const
{
    return m_Siblings.NotEmpty();
}
 
inline
bool CCdd_tree_Base::CanGetSiblings(void) const
{
    return IsSetSiblings();
}
 
inline
const CCdd_tree_Base::TSiblings& CCdd_tree_Base::GetSiblings(void) const
{
    if (!CanGetSiblings()) {
        ThrowUnassigned(5);
    }
    return (*m_Siblings);
}
 
inline
bool CCdd_tree_Base::IsSetNeighbors(void) const
{
    return m_Neighbors.NotEmpty();
}
 
inline
bool CCdd_tree_Base::CanGetNeighbors(void) const
{
    return IsSetNeighbors();
}
 
inline
const CCdd_tree_Base::TNeighbors& CCdd_tree_Base::GetNeighbors(void) const
{
    if (!CanGetNeighbors()) {
        ThrowUnassigned(6);
    }
    return (*m_Neighbors);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_CDD_CDD_TREE_BASE_HPP