Cn3d_user_annotations_.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 Cn3d_user_annotations_.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/cn3d/cn3d.asn">cn3d.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cn3d/cn3d.def">cn3d.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef OBJECTS_CN3D_CN3D_USER_ANNOTATIONS_BASE_HPP
#define OBJECTS_CN3D_CN3D_USER_ANNOTATIONS_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 CCn3d_user_annotation;
class CCn3d_view_settings;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Cn3d
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
/// The list of annotations for a given CDD/mime. If residue regions overlap
/// between annotations that are turned on, the last annotation in this list
/// that contains these residues will be used as the display style for these
/// residues.
///   Also contains the current viewpoint, so that user's camera angle
/// can be stored and reproduced, for illustrations, on-line figures, etc.
///
/// CCn3d_user_annotations_Base --
///
 
class NCBI_CN3D_EXPORT CCn3d_user_annotations_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CCn3d_user_annotations_Base(void);
    // destructor
    virtual ~CCn3d_user_annotations_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef list< CRef< CCn3d_user_annotation > > TAnnotations;
    typedef CCn3d_view_settings TView;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_annotations,
        e_view
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Annotations data member.
    ///
    /// Data member Annotations is optional;
    /// its type is defined as 'typedef list< CRef< CCn3d_user_annotation > > TAnnotations'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetAnnotations(void) const;
 
    /// Check if it is safe to call GetAnnotations method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetAnnotations(void) const;
 
    /// Reset Annotations data member.
    void ResetAnnotations(void);
 
    /// Get the Annotations member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TAnnotations& GetAnnotations(void) const;
 
    /// Assign a value to Annotations data member.
    ///
    /// @return
    ///   Reference to the data value.
    TAnnotations& SetAnnotations(void);
 
    /// Check if a value has been assigned to View data member.
    ///
    /// Data member View is optional;
    /// its type is defined as 'typedef CCn3d_view_settings TView'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetView(void) const;
 
    /// Check if it is safe to call GetView method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetView(void) const;
 
    /// Reset View data member.
    void ResetView(void);
 
    /// Get the View member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TView& GetView(void) const;
 
    /// Assign a value to View data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetView(TView& value);
 
    /// Assign a value to View data member.
    ///
    /// @return
    ///   Reference to the data value.
    TView& SetView(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CCn3d_user_annotations_Base(const CCn3d_user_annotations_Base&);
    CCn3d_user_annotations_Base& operator=(const CCn3d_user_annotations_Base&);
 
    // data
    Uint4 m_set_State[1];
    list< CRef< CCn3d_user_annotation > > m_Annotations;
    CRef< TView > m_View;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CCn3d_user_annotations_Base::IsSetAnnotations(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CCn3d_user_annotations_Base::CanGetAnnotations(void) const
{
    return true;
}
 
inline
const CCn3d_user_annotations_Base::TAnnotations& CCn3d_user_annotations_Base::GetAnnotations(void) const
{
    return m_Annotations;
}
 
inline
CCn3d_user_annotations_Base::TAnnotations& CCn3d_user_annotations_Base::SetAnnotations(void)
{
    m_set_State[0] |= 0x1;
    return m_Annotations;
}
 
inline
bool CCn3d_user_annotations_Base::IsSetView(void) const
{
    return m_View.NotEmpty();
}
 
inline
bool CCn3d_user_annotations_Base::CanGetView(void) const
{
    return IsSetView();
}
 
inline
const CCn3d_user_annotations_Base::TView& CCn3d_user_annotations_Base::GetView(void) const
{
    if (!CanGetView()) {
        ThrowUnassigned(1);
    }
    return (*m_View);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // OBJECTS_CN3D_CN3D_USER_ANNOTATIONS_BASE_HPP