Biost_resid_graph_set_pntr_.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 Biost_resid_graph_set_pntr_.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/mmdb1/mmdb1.asn">mmdb1.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/mmdb1/mmdb1.def">mmdb1.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_MMDB1_BIOST_RESID_GRAPH_SET_PNTR_BASE_HPP
#define OBJECTS_MMDB1_BIOST_RESID_GRAPH_SET_PNTR_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <objects/mmdb1/Residue_graph_id.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 CBiostruc_id;
 
 
// generated classes
 
 
/** @addtogroup dataspec_MMDB_Chemical_graph
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CBiostruc_residue_graph_set_pntr_Base --
///
 
class NCBI_MMDB1_EXPORT CBiostruc_residue_graph_set_pntr_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CBiostruc_residue_graph_set_pntr_Base(void);
    // destructor
    virtual ~CBiostruc_residue_graph_set_pntr_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CBiostruc_id TBiostruc_residue_graph_set_id;
    typedef CResidue_graph_id TResidue_graph_id;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_biostruc_residue_graph_set_id,
        e_residue_graph_id
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Biostruc_residue_graph_set_id data member.
    ///
    /// Data member Biostruc_residue_graph_set_id is mandatory;
    /// its type is defined as 'typedef CBiostruc_id TBiostruc_residue_graph_set_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBiostruc_residue_graph_set_id(void) const;
 
    /// Check if it is safe to call GetBiostruc_residue_graph_set_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBiostruc_residue_graph_set_id(void) const;
 
    /// Reset Biostruc_residue_graph_set_id data member.
    void ResetBiostruc_residue_graph_set_id(void);
 
    /// Get the Biostruc_residue_graph_set_id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBiostruc_residue_graph_set_id& GetBiostruc_residue_graph_set_id(void) const;
 
    /// Assign a value to Biostruc_residue_graph_set_id data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetBiostruc_residue_graph_set_id(TBiostruc_residue_graph_set_id& value);
 
    /// Assign a value to Biostruc_residue_graph_set_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBiostruc_residue_graph_set_id& SetBiostruc_residue_graph_set_id(void);
 
    /// Check if a value has been assigned to Residue_graph_id data member.
    ///
    /// Data member Residue_graph_id is mandatory;
    /// its type is defined as 'typedef CResidue_graph_id TResidue_graph_id'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetResidue_graph_id(void) const;
 
    /// Check if it is safe to call GetResidue_graph_id method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetResidue_graph_id(void) const;
 
    /// Reset Residue_graph_id data member.
    void ResetResidue_graph_id(void);
 
    /// Get the Residue_graph_id member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TResidue_graph_id& GetResidue_graph_id(void) const;
 
    /// Assign a value to Residue_graph_id data member.
    ///
    /// @param value
    ///   Value to assign
    void SetResidue_graph_id(const TResidue_graph_id& value);
 
    /// Assign a value to Residue_graph_id data member.
    ///
    /// @return
    ///   Reference to the data value.
    TResidue_graph_id& SetResidue_graph_id(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CBiostruc_residue_graph_set_pntr_Base(const CBiostruc_residue_graph_set_pntr_Base&);
    CBiostruc_residue_graph_set_pntr_Base& operator=(const CBiostruc_residue_graph_set_pntr_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TBiostruc_residue_graph_set_id > m_Biostruc_residue_graph_set_id;
    CResidue_graph_id m_Residue_graph_id;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CBiostruc_residue_graph_set_pntr_Base::IsSetBiostruc_residue_graph_set_id(void) const
{
    return m_Biostruc_residue_graph_set_id.NotEmpty();
}
 
inline
bool CBiostruc_residue_graph_set_pntr_Base::CanGetBiostruc_residue_graph_set_id(void) const
{
    return true;
}
 
inline
const CBiostruc_residue_graph_set_pntr_Base::TBiostruc_residue_graph_set_id& CBiostruc_residue_graph_set_pntr_Base::GetBiostruc_residue_graph_set_id(void) const
{
    if ( !m_Biostruc_residue_graph_set_id ) {
        const_cast<CBiostruc_residue_graph_set_pntr_Base*>(this)->ResetBiostruc_residue_graph_set_id();
    }
    return (*m_Biostruc_residue_graph_set_id);
}
 
inline
CBiostruc_residue_graph_set_pntr_Base::TBiostruc_residue_graph_set_id& CBiostruc_residue_graph_set_pntr_Base::SetBiostruc_residue_graph_set_id(void)
{
    if ( !m_Biostruc_residue_graph_set_id ) {
        ResetBiostruc_residue_graph_set_id();
    }
    return (*m_Biostruc_residue_graph_set_id);
}
 
inline
bool CBiostruc_residue_graph_set_pntr_Base::IsSetResidue_graph_id(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CBiostruc_residue_graph_set_pntr_Base::CanGetResidue_graph_id(void) const
{
    return IsSetResidue_graph_id();
}
 
inline
void CBiostruc_residue_graph_set_pntr_Base::ResetResidue_graph_id(void)
{
    m_Residue_graph_id = CResidue_graph_id(0);
    m_set_State[0] &= ~0xc;
}
 
inline
const CBiostruc_residue_graph_set_pntr_Base::TResidue_graph_id& CBiostruc_residue_graph_set_pntr_Base::GetResidue_graph_id(void) const
{
    if (!CanGetResidue_graph_id()) {
        ThrowUnassigned(1);
    }
    return m_Residue_graph_id;
}
 
inline
void CBiostruc_residue_graph_set_pntr_Base::SetResidue_graph_id(const CBiostruc_residue_graph_set_pntr_Base::TResidue_graph_id& value)
{
    m_Residue_graph_id = value;
    m_set_State[0] |= 0xc;
}
 
inline
CBiostruc_residue_graph_set_pntr_Base::TResidue_graph_id& CBiostruc_residue_graph_set_pntr_Base::SetResidue_graph_id(void)
{
    m_set_State[0] |= 0x4;
    return m_Residue_graph_id;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_MMDB1_BIOST_RESID_GRAPH_SET_PNTR_BASE_HPP