Biostruc_align_.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 Biostruc_align_.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/ncbimime/ncbimime.asn">ncbimime.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/ncbimime/ncbimime.def">ncbimime.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_NCBIMIME_BIOSTRUC_ALIGN_BASE_HPP
#define OBJECTS_NCBIMIME_BIOSTRUC_ALIGN_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 CBiostruc;
class CBiostruc_annot_set;
class CCn3d_style_dictionary;
class CCn3d_user_annotations;
class CSeq_annot;
class CSeq_entry;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Mime
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CBiostruc_align_Base --
///
 
class NCBI_NCBIMIME_EXPORT CBiostruc_align_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBiostruc_align_Base(void);
    // destructor
    virtual ~CBiostruc_align_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CBiostruc TMaster;
    typedef list< CRef< CBiostruc > > TSlaves;
    typedef CBiostruc_annot_set TAlignments;
    typedef list< CRef< CSeq_entry > > TSequences;
    typedef list< CRef< CSeq_annot > > TSeqalign;
    typedef CCn3d_style_dictionary TStyle_dictionary;
    typedef CCn3d_user_annotations TUser_annotations;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_master,
        e_slaves,
        e_alignments,
        e_sequences,
        e_seqalign,
        e_style_dictionary,
        e_user_annotations
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 8> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Master data member.
    ///
    /// Data member Master is mandatory;
    /// its type is defined as 'typedef CBiostruc TMaster'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMaster(void) const;
 
    /// Check if it is safe to call GetMaster method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMaster(void) const;
 
    /// Reset Master data member.
    void ResetMaster(void);
 
    /// Get the Master member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMaster& GetMaster(void) const;
 
    /// Assign a value to Master data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetMaster(TMaster& value);
 
    /// Assign a value to Master data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMaster& SetMaster(void);
 
    /// Check if a value has been assigned to Slaves data member.
    ///
    /// Data member Slaves is mandatory;
    /// its type is defined as 'typedef list< CRef< CBiostruc > > TSlaves'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSlaves(void) const;
 
    /// Check if it is safe to call GetSlaves method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSlaves(void) const;
 
    /// Reset Slaves data member.
    void ResetSlaves(void);
 
    /// Get the Slaves member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSlaves& GetSlaves(void) const;
 
    /// Assign a value to Slaves data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSlaves& SetSlaves(void);
 
    /// structure alignments
    /// Check if a value has been assigned to Alignments data member.
    ///
    /// Data member Alignments is mandatory;
    /// its type is defined as 'typedef CBiostruc_annot_set TAlignments'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAlignments(void) const;
 
    /// Check if it is safe to call GetAlignments method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAlignments(void) const;
 
    /// Reset Alignments data member.
    void ResetAlignments(void);
 
    /// Get the Alignments member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAlignments& GetAlignments(void) const;
 
    /// Assign a value to Alignments data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetAlignments(TAlignments& value);
 
    /// Assign a value to Alignments data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAlignments& SetAlignments(void);
 
    /// sequences
    /// Check if a value has been assigned to Sequences data member.
    ///
    /// Data member Sequences is mandatory;
    /// its type is defined as 'typedef list< CRef< CSeq_entry > > TSequences'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSequences(void) const;
 
    /// Check if it is safe to call GetSequences method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSequences(void) const;
 
    /// Reset Sequences data member.
    void ResetSequences(void);
 
    /// Get the Sequences member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSequences& GetSequences(void) const;
 
    /// Assign a value to Sequences data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSequences& SetSequences(void);
 
    /// Check if a value has been assigned to Seqalign data member.
    ///
    /// Data member Seqalign is mandatory;
    /// its type is defined as 'typedef list< CRef< CSeq_annot > > TSeqalign'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSeqalign(void) const;
 
    /// Check if it is safe to call GetSeqalign method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSeqalign(void) const;
 
    /// Reset Seqalign data member.
    void ResetSeqalign(void);
 
    /// Get the Seqalign member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSeqalign& GetSeqalign(void) const;
 
    /// Assign a value to Seqalign data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSeqalign& SetSeqalign(void);
 
    /// Check if a value has been assigned to Style_dictionary data member.
    ///
    /// Data member Style_dictionary is optional;
    /// its type is defined as 'typedef CCn3d_style_dictionary TStyle_dictionary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetStyle_dictionary(void) const;
 
    /// Check if it is safe to call GetStyle_dictionary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetStyle_dictionary(void) const;
 
    /// Reset Style_dictionary data member.
    void ResetStyle_dictionary(void);
 
    /// Get the Style_dictionary member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TStyle_dictionary& GetStyle_dictionary(void) const;
 
    /// Assign a value to Style_dictionary data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetStyle_dictionary(TStyle_dictionary& value);
 
    /// Assign a value to Style_dictionary data member.
    ///
    /// @return
    ///   Reference to the data value.
    TStyle_dictionary& SetStyle_dictionary(void);
 
    /// Check if a value has been assigned to User_annotations data member.
    ///
    /// Data member User_annotations is optional;
    /// its type is defined as 'typedef CCn3d_user_annotations TUser_annotations'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetUser_annotations(void) const;
 
    /// Check if it is safe to call GetUser_annotations method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetUser_annotations(void) const;
 
    /// Reset User_annotations data member.
    void ResetUser_annotations(void);
 
    /// Get the User_annotations member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TUser_annotations& GetUser_annotations(void) const;
 
    /// Assign a value to User_annotations data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetUser_annotations(TUser_annotations& value);
 
    /// Assign a value to User_annotations data member.
    ///
    /// @return
    ///   Reference to the data value.
    TUser_annotations& SetUser_annotations(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CBiostruc_align_Base(const CBiostruc_align_Base&);
    CBiostruc_align_Base& operator=(const CBiostruc_align_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TMaster > m_Master;
    list< CRef< CBiostruc > > m_Slaves;
    CRef< TAlignments > m_Alignments;
    list< CRef< CSeq_entry > > m_Sequences;
    list< CRef< CSeq_annot > > m_Seqalign;
    CRef< TStyle_dictionary > m_Style_dictionary;
    CRef< TUser_annotations > m_User_annotations;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CBiostruc_align_Base::IsSetMaster(void) const
{
    return m_Master.NotEmpty();
}
 
inline
bool CBiostruc_align_Base::CanGetMaster(void) const
{
    return true;
}
 
inline
const CBiostruc_align_Base::TMaster& CBiostruc_align_Base::GetMaster(void) const
{
    if ( !m_Master ) {
        const_cast<CBiostruc_align_Base*>(this)->ResetMaster();
    }
    return (*m_Master);
}
 
inline
CBiostruc_align_Base::TMaster& CBiostruc_align_Base::SetMaster(void)
{
    if ( !m_Master ) {
        ResetMaster();
    }
    return (*m_Master);
}
 
inline
bool CBiostruc_align_Base::IsSetSlaves(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CBiostruc_align_Base::CanGetSlaves(void) const
{
    return true;
}
 
inline
const CBiostruc_align_Base::TSlaves& CBiostruc_align_Base::GetSlaves(void) const
{
    return m_Slaves;
}
 
inline
CBiostruc_align_Base::TSlaves& CBiostruc_align_Base::SetSlaves(void)
{
    m_set_State[0] |= 0x4;
    return m_Slaves;
}
 
inline
bool CBiostruc_align_Base::IsSetAlignments(void) const
{
    return m_Alignments.NotEmpty();
}
 
inline
bool CBiostruc_align_Base::CanGetAlignments(void) const
{
    return true;
}
 
inline
const CBiostruc_align_Base::TAlignments& CBiostruc_align_Base::GetAlignments(void) const
{
    if ( !m_Alignments ) {
        const_cast<CBiostruc_align_Base*>(this)->ResetAlignments();
    }
    return (*m_Alignments);
}
 
inline
CBiostruc_align_Base::TAlignments& CBiostruc_align_Base::SetAlignments(void)
{
    if ( !m_Alignments ) {
        ResetAlignments();
    }
    return (*m_Alignments);
}
 
inline
bool CBiostruc_align_Base::IsSetSequences(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CBiostruc_align_Base::CanGetSequences(void) const
{
    return true;
}
 
inline
const CBiostruc_align_Base::TSequences& CBiostruc_align_Base::GetSequences(void) const
{
    return m_Sequences;
}
 
inline
CBiostruc_align_Base::TSequences& CBiostruc_align_Base::SetSequences(void)
{
    m_set_State[0] |= 0x40;
    return m_Sequences;
}
 
inline
bool CBiostruc_align_Base::IsSetSeqalign(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CBiostruc_align_Base::CanGetSeqalign(void) const
{
    return true;
}
 
inline
const CBiostruc_align_Base::TSeqalign& CBiostruc_align_Base::GetSeqalign(void) const
{
    return m_Seqalign;
}
 
inline
CBiostruc_align_Base::TSeqalign& CBiostruc_align_Base::SetSeqalign(void)
{
    m_set_State[0] |= 0x100;
    return m_Seqalign;
}
 
inline
bool CBiostruc_align_Base::IsSetStyle_dictionary(void) const
{
    return m_Style_dictionary.NotEmpty();
}
 
inline
bool CBiostruc_align_Base::CanGetStyle_dictionary(void) const
{
    return IsSetStyle_dictionary();
}
 
inline
const CBiostruc_align_Base::TStyle_dictionary& CBiostruc_align_Base::GetStyle_dictionary(void) const
{
    if (!CanGetStyle_dictionary()) {
        ThrowUnassigned(5);
    }
    return (*m_Style_dictionary);
}
 
inline
bool CBiostruc_align_Base::IsSetUser_annotations(void) const
{
    return m_User_annotations.NotEmpty();
}
 
inline
bool CBiostruc_align_Base::CanGetUser_annotations(void) const
{
    return IsSetUser_annotations();
}
 
inline
const CBiostruc_align_Base::TUser_annotations& CBiostruc_align_Base::GetUser_annotations(void) const
{
    if (!CanGetUser_annotations()) {
        ThrowUnassigned(6);
    }
    return (*m_User_annotations);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_NCBIMIME_BIOSTRUC_ALIGN_BASE_HPP