SeqEdit_Cmd_AttachSeqEntry_.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 SeqEdit_Cmd_AttachSeqEntry_.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/seqedit/seqedit.asn">seqedit.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/seqedit/seqedit.def">seqedit.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_SEQEDIT_SEQEDIT_CMD_ATTACHSEQENTRY_BASE_HPP
#define OBJECTS_SEQEDIT_SEQEDIT_CMD_ATTACHSEQENTRY_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
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 CSeqEdit_Id;
class CSeq_entry;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_SeqEdit
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///***************************************************************
/// Attach a seq entry to bioseq-set
///
/// CSeqEdit_Cmd_AttachSeqEntry_Base --
///
 
class NCBI_SEQEDIT_EXPORT CSeqEdit_Cmd_AttachSeqEntry_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CSeqEdit_Cmd_AttachSeqEntry_Base(void);
    // destructor
    virtual ~CSeqEdit_Cmd_AttachSeqEntry_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CSeqEdit_Id TId;
    typedef CSeq_entry TSeq_entry;
    typedef int TIndex;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_id,
        e_seq_entry,
        e_index
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Bioseq_set id
    /// Check if a value has been assigned to Id data member.
    ///
    /// Data member Id is mandatory;
    /// its type is defined as 'typedef CSeqEdit_Id 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);
 
    /// set entry
    /// Check if a value has been assigned to Seq_entry data member.
    ///
    /// Data member Seq_entry is optional;
    /// its type is defined as 'typedef CSeq_entry TSeq_entry'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSeq_entry(void) const;
 
    /// Check if it is safe to call GetSeq_entry method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSeq_entry(void) const;
 
    /// Reset Seq_entry data member.
    void ResetSeq_entry(void);
 
    /// Get the Seq_entry member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSeq_entry& GetSeq_entry(void) const;
 
    /// Assign a value to Seq_entry data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetSeq_entry(TSeq_entry& value);
 
    /// Assign a value to Seq_entry data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSeq_entry& SetSeq_entry(void);
 
    /// index
    /// Check if a value has been assigned to Index data member.
    ///
    /// Data member Index is mandatory;
    /// its type is defined as 'typedef int TIndex'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetIndex(void) const;
 
    /// Check if it is safe to call GetIndex method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetIndex(void) const;
 
    /// Reset Index data member.
    void ResetIndex(void);
 
    /// Get the Index member data.
    ///
    /// @return
    ///   Copy of the member data.
    TIndex GetIndex(void) const;
 
    /// Assign a value to Index data member.
    ///
    /// @param value
    ///   Value to assign
    void SetIndex(TIndex value);
 
    /// Assign a value to Index data member.
    ///
    /// @return
    ///   Reference to the data value.
    TIndex& SetIndex(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CSeqEdit_Cmd_AttachSeqEntry_Base(const CSeqEdit_Cmd_AttachSeqEntry_Base&);
    CSeqEdit_Cmd_AttachSeqEntry_Base& operator=(const CSeqEdit_Cmd_AttachSeqEntry_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TId > m_Id;
    CRef< TSeq_entry > m_Seq_entry;
    int m_Index;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CSeqEdit_Cmd_AttachSeqEntry_Base::IsSetId(void) const
{
    return m_Id.NotEmpty();
}
 
inline
bool CSeqEdit_Cmd_AttachSeqEntry_Base::CanGetId(void) const
{
    return true;
}
 
inline
const CSeqEdit_Cmd_AttachSeqEntry_Base::TId& CSeqEdit_Cmd_AttachSeqEntry_Base::GetId(void) const
{
    if ( !m_Id ) {
        const_cast<CSeqEdit_Cmd_AttachSeqEntry_Base*>(this)->ResetId();
    }
    return (*m_Id);
}
 
inline
CSeqEdit_Cmd_AttachSeqEntry_Base::TId& CSeqEdit_Cmd_AttachSeqEntry_Base::SetId(void)
{
    if ( !m_Id ) {
        ResetId();
    }
    return (*m_Id);
}
 
inline
bool CSeqEdit_Cmd_AttachSeqEntry_Base::IsSetSeq_entry(void) const
{
    return m_Seq_entry.NotEmpty();
}
 
inline
bool CSeqEdit_Cmd_AttachSeqEntry_Base::CanGetSeq_entry(void) const
{
    return IsSetSeq_entry();
}
 
inline
const CSeqEdit_Cmd_AttachSeqEntry_Base::TSeq_entry& CSeqEdit_Cmd_AttachSeqEntry_Base::GetSeq_entry(void) const
{
    if (!CanGetSeq_entry()) {
        ThrowUnassigned(1);
    }
    return (*m_Seq_entry);
}
 
inline
bool CSeqEdit_Cmd_AttachSeqEntry_Base::IsSetIndex(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CSeqEdit_Cmd_AttachSeqEntry_Base::CanGetIndex(void) const
{
    return IsSetIndex();
}
 
inline
void CSeqEdit_Cmd_AttachSeqEntry_Base::ResetIndex(void)
{
    m_Index = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CSeqEdit_Cmd_AttachSeqEntry_Base::TIndex CSeqEdit_Cmd_AttachSeqEntry_Base::GetIndex(void) const
{
    if (!CanGetIndex()) {
        ThrowUnassigned(2);
    }
    return m_Index;
}
 
inline
void CSeqEdit_Cmd_AttachSeqEntry_Base::SetIndex(CSeqEdit_Cmd_AttachSeqEntry_Base::TIndex value)
{
    m_Index = value;
    m_set_State[0] |= 0x30;
}
 
inline
CSeqEdit_Cmd_AttachSeqEntry_Base::TIndex& CSeqEdit_Cmd_AttachSeqEntry_Base::SetIndex(void)
{
#ifdef _DEBUG
    if (!IsSetIndex()) {
        memset(&m_Index,UnassignedByte(),sizeof(m_Index));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Index;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_SEQEDIT_SEQEDIT_CMD_ATTACHSEQENTRY_BASE_HPP