GC_SequenceStats_.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 GC_SequenceStats_.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/genomecoll/genome_collection.asn">genome_collection.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/genomecoll/genome_collection.def">genome_collection.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_GENOMECOLL_GC_SEQUENCESTATS_BASE_HPP
#define OBJECTS_GENOMECOLL_GC_SEQUENCESTATS_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 CGC_Scaf_stats;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GenomeCollection
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// Stats of complex objects
/// Used at assembly and chromosome levels
///
/// CGC_SequenceStats_Base --
///
 
class NCBI_GENOME_COLLECTION_EXPORT CGC_SequenceStats_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGC_SequenceStats_Base(void);
    // destructor
    virtual ~CGC_SequenceStats_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef list< CRef< CGC_Scaf_stats > > TAll_scaf;
    typedef list< CRef< CGC_Scaf_stats > > TOrdered_scaf;
    typedef list< CRef< CGC_Scaf_stats > > TUnordered_scaf;
    typedef list< CRef< CGC_Scaf_stats > > TUnplaced_scaf;
    typedef list< CRef< CGC_Scaf_stats > > TAligned_scaf;
    typedef list< CRef< CGC_Scaf_stats > > TUnaligned_scaf;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_all_scaf,
        e_ordered_scaf,
        e_unordered_scaf,
        e_unplaced_scaf,
        e_aligned_scaf,
        e_unaligned_scaf
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to All_scaf data member.
    ///
    /// Data member All_scaf is mandatory;
    /// its type is defined as 'typedef list< CRef< CGC_Scaf_stats > > TAll_scaf'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAll_scaf(void) const;
 
    /// Check if it is safe to call GetAll_scaf method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAll_scaf(void) const;
 
    /// Reset All_scaf data member.
    void ResetAll_scaf(void);
 
    /// Get the All_scaf member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAll_scaf& GetAll_scaf(void) const;
 
    /// Assign a value to All_scaf data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAll_scaf& SetAll_scaf(void);
 
    /// Check if a value has been assigned to Ordered_scaf data member.
    ///
    /// Data member Ordered_scaf is mandatory;
    /// its type is defined as 'typedef list< CRef< CGC_Scaf_stats > > TOrdered_scaf'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOrdered_scaf(void) const;
 
    /// Check if it is safe to call GetOrdered_scaf method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOrdered_scaf(void) const;
 
    /// Reset Ordered_scaf data member.
    void ResetOrdered_scaf(void);
 
    /// Get the Ordered_scaf member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TOrdered_scaf& GetOrdered_scaf(void) const;
 
    /// Assign a value to Ordered_scaf data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOrdered_scaf& SetOrdered_scaf(void);
 
    ///
    /// Check if a value has been assigned to Unordered_scaf data member.
    ///
    /// Data member Unordered_scaf is mandatory;
    /// its type is defined as 'typedef list< CRef< CGC_Scaf_stats > > TUnordered_scaf'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUnordered_scaf(void) const;
 
    /// Check if it is safe to call GetUnordered_scaf method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUnordered_scaf(void) const;
 
    /// Reset Unordered_scaf data member.
    void ResetUnordered_scaf(void);
 
    /// Get the Unordered_scaf member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUnordered_scaf& GetUnordered_scaf(void) const;
 
    /// Assign a value to Unordered_scaf data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUnordered_scaf& SetUnordered_scaf(void);
 
    /// unplaced at full assembly level
    /// Check if a value has been assigned to Unplaced_scaf data member.
    ///
    /// Data member Unplaced_scaf is optional;
    /// its type is defined as 'typedef list< CRef< CGC_Scaf_stats > > TUnplaced_scaf'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUnplaced_scaf(void) const;
 
    /// Check if it is safe to call GetUnplaced_scaf method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUnplaced_scaf(void) const;
 
    /// Reset Unplaced_scaf data member.
    void ResetUnplaced_scaf(void);
 
    /// Get the Unplaced_scaf member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUnplaced_scaf& GetUnplaced_scaf(void) const;
 
    /// Assign a value to Unplaced_scaf data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUnplaced_scaf& SetUnplaced_scaf(void);
 
    /// aligned at full assembly level
    /// Check if a value has been assigned to Aligned_scaf data member.
    ///
    /// Data member Aligned_scaf is optional;
    /// its type is defined as 'typedef list< CRef< CGC_Scaf_stats > > TAligned_scaf'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAligned_scaf(void) const;
 
    /// Check if it is safe to call GetAligned_scaf method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAligned_scaf(void) const;
 
    /// Reset Aligned_scaf data member.
    void ResetAligned_scaf(void);
 
    /// Get the Aligned_scaf member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAligned_scaf& GetAligned_scaf(void) const;
 
    /// Assign a value to Aligned_scaf data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAligned_scaf& SetAligned_scaf(void);
 
    /// unaligned at full assembly level
    /// Check if a value has been assigned to Unaligned_scaf data member.
    ///
    /// Data member Unaligned_scaf is optional;
    /// its type is defined as 'typedef list< CRef< CGC_Scaf_stats > > TUnaligned_scaf'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUnaligned_scaf(void) const;
 
    /// Check if it is safe to call GetUnaligned_scaf method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUnaligned_scaf(void) const;
 
    /// Reset Unaligned_scaf data member.
    void ResetUnaligned_scaf(void);
 
    /// Get the Unaligned_scaf member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUnaligned_scaf& GetUnaligned_scaf(void) const;
 
    /// Assign a value to Unaligned_scaf data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUnaligned_scaf& SetUnaligned_scaf(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGC_SequenceStats_Base(const CGC_SequenceStats_Base&);
    CGC_SequenceStats_Base& operator=(const CGC_SequenceStats_Base&);
 
    // data
    Uint4 m_set_State[1];
    list< CRef< CGC_Scaf_stats > > m_All_scaf;
    list< CRef< CGC_Scaf_stats > > m_Ordered_scaf;
    list< CRef< CGC_Scaf_stats > > m_Unordered_scaf;
    list< CRef< CGC_Scaf_stats > > m_Unplaced_scaf;
    list< CRef< CGC_Scaf_stats > > m_Aligned_scaf;
    list< CRef< CGC_Scaf_stats > > m_Unaligned_scaf;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGC_SequenceStats_Base::IsSetAll_scaf(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CGC_SequenceStats_Base::CanGetAll_scaf(void) const
{
    return true;
}
 
inline
const CGC_SequenceStats_Base::TAll_scaf& CGC_SequenceStats_Base::GetAll_scaf(void) const
{
    return m_All_scaf;
}
 
inline
CGC_SequenceStats_Base::TAll_scaf& CGC_SequenceStats_Base::SetAll_scaf(void)
{
    m_set_State[0] |= 0x1;
    return m_All_scaf;
}
 
inline
bool CGC_SequenceStats_Base::IsSetOrdered_scaf(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGC_SequenceStats_Base::CanGetOrdered_scaf(void) const
{
    return true;
}
 
inline
const CGC_SequenceStats_Base::TOrdered_scaf& CGC_SequenceStats_Base::GetOrdered_scaf(void) const
{
    return m_Ordered_scaf;
}
 
inline
CGC_SequenceStats_Base::TOrdered_scaf& CGC_SequenceStats_Base::SetOrdered_scaf(void)
{
    m_set_State[0] |= 0x4;
    return m_Ordered_scaf;
}
 
inline
bool CGC_SequenceStats_Base::IsSetUnordered_scaf(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGC_SequenceStats_Base::CanGetUnordered_scaf(void) const
{
    return true;
}
 
inline
const CGC_SequenceStats_Base::TUnordered_scaf& CGC_SequenceStats_Base::GetUnordered_scaf(void) const
{
    return m_Unordered_scaf;
}
 
inline
CGC_SequenceStats_Base::TUnordered_scaf& CGC_SequenceStats_Base::SetUnordered_scaf(void)
{
    m_set_State[0] |= 0x10;
    return m_Unordered_scaf;
}
 
inline
bool CGC_SequenceStats_Base::IsSetUnplaced_scaf(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CGC_SequenceStats_Base::CanGetUnplaced_scaf(void) const
{
    return true;
}
 
inline
const CGC_SequenceStats_Base::TUnplaced_scaf& CGC_SequenceStats_Base::GetUnplaced_scaf(void) const
{
    return m_Unplaced_scaf;
}
 
inline
CGC_SequenceStats_Base::TUnplaced_scaf& CGC_SequenceStats_Base::SetUnplaced_scaf(void)
{
    m_set_State[0] |= 0x40;
    return m_Unplaced_scaf;
}
 
inline
bool CGC_SequenceStats_Base::IsSetAligned_scaf(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CGC_SequenceStats_Base::CanGetAligned_scaf(void) const
{
    return true;
}
 
inline
const CGC_SequenceStats_Base::TAligned_scaf& CGC_SequenceStats_Base::GetAligned_scaf(void) const
{
    return m_Aligned_scaf;
}
 
inline
CGC_SequenceStats_Base::TAligned_scaf& CGC_SequenceStats_Base::SetAligned_scaf(void)
{
    m_set_State[0] |= 0x100;
    return m_Aligned_scaf;
}
 
inline
bool CGC_SequenceStats_Base::IsSetUnaligned_scaf(void) const
{
    return ((m_set_State[0] & 0xc00) != 0);
}
 
inline
bool CGC_SequenceStats_Base::CanGetUnaligned_scaf(void) const
{
    return true;
}
 
inline
const CGC_SequenceStats_Base::TUnaligned_scaf& CGC_SequenceStats_Base::GetUnaligned_scaf(void) const
{
    return m_Unaligned_scaf;
}
 
inline
CGC_SequenceStats_Base::TUnaligned_scaf& CGC_SequenceStats_Base::SetUnaligned_scaf(void)
{
    m_set_State[0] |= 0x400;
    return m_Unaligned_scaf;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_GENOMECOLL_GC_SEQUENCESTATS_BASE_HPP