PluginUserType_.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 PluginUserType_.hpp
/// Data storage class.
///
/// This file was generated by application DATATOOL
/// using the following specifications:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.asn">gui_objects.asn</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/objects/gui_objects.def">gui_objects.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef GUI_OBJECTS_PLUGINUSERTYPE_BASE_HPP
#define GUI_OBJECTS_PLUGINUSERTYPE_BASE_HPP
 
// extra headers
#include <gui/gui_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <string>
 
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::
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// user types for determining which plugins apply to a given set of objects
///
///
/// CPluginUserType_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginUserType_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginUserType_Base(void);
    // destructor
    virtual ~CPluginUserType_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TType;
    typedef string TSubtype;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_type,
        e_subtype
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Type data member.
    ///
    /// Data member Type is mandatory;
    /// its type is defined as 'typedef string TType'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetType(void) const;
 
    /// Check if it is safe to call GetType method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetType(void) const;
 
    /// Reset Type data member.
    void ResetType(void);
 
    /// Get the Type member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TType& GetType(void) const;
 
    /// Assign a value to Type data member.
    ///
    /// @param value
    ///   Value to assign
    void SetType(const TType& value);
    void SetType(TType&& value);
 
    /// Assign a value to Type data member.
    ///
    /// @return
    ///   Reference to the data value.
    TType& SetType(void);
 
    /// Check if a value has been assigned to Subtype data member.
    ///
    /// Data member Subtype is optional;
    /// its type is defined as 'typedef string TSubtype'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetSubtype(void) const;
 
    /// Check if it is safe to call GetSubtype method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetSubtype(void) const;
 
    /// Reset Subtype data member.
    void ResetSubtype(void);
 
    /// Get the Subtype member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TSubtype& GetSubtype(void) const;
 
    /// Assign a value to Subtype data member.
    ///
    /// @param value
    ///   Value to assign
    void SetSubtype(const TSubtype& value);
    void SetSubtype(TSubtype&& value);
 
    /// Assign a value to Subtype data member.
    ///
    /// @return
    ///   Reference to the data value.
    TSubtype& SetSubtype(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginUserType_Base(const CPluginUserType_Base&);
    CPluginUserType_Base& operator=(const CPluginUserType_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Type;
    string m_Subtype;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginUserType_Base::IsSetType(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginUserType_Base::CanGetType(void) const
{
    return IsSetType();
}
 
inline
const CPluginUserType_Base::TType& CPluginUserType_Base::GetType(void) const
{
    if (!CanGetType()) {
        ThrowUnassigned(0);
    }
    return m_Type;
}
 
inline
void CPluginUserType_Base::SetType(const CPluginUserType_Base::TType& value)
{
    m_Type = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CPluginUserType_Base::SetType(CPluginUserType_Base::TType&& value)
{
    m_Type = std::forward<CPluginUserType_Base::TType>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CPluginUserType_Base::TType& CPluginUserType_Base::SetType(void)
{
#ifdef _DEBUG
    if (!IsSetType()) {
        m_Type = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Type;
}
 
inline
bool CPluginUserType_Base::IsSetSubtype(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginUserType_Base::CanGetSubtype(void) const
{
    return IsSetSubtype();
}
 
inline
const CPluginUserType_Base::TSubtype& CPluginUserType_Base::GetSubtype(void) const
{
    if (!CanGetSubtype()) {
        ThrowUnassigned(1);
    }
    return m_Subtype;
}
 
inline
void CPluginUserType_Base::SetSubtype(const CPluginUserType_Base::TSubtype& value)
{
    m_Subtype = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CPluginUserType_Base::SetSubtype(CPluginUserType_Base::TSubtype&& value)
{
    m_Subtype = std::forward<CPluginUserType_Base::TSubtype>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CPluginUserType_Base::TSubtype& CPluginUserType_Base::SetSubtype(void)
{
#ifdef _DEBUG
    if (!IsSetSubtype()) {
        m_Subtype = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Subtype;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINUSERTYPE_BASE_HPP