PluginObject_.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 PluginObject_.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_PLUGINOBJECT_BASE_HPP
#define GUI_OBJECTS_PLUGINOBJECT_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
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- Wrappers for non-serializable objects
///- For these we encode a pointer and a name of the object type
///-
///
/// CPluginObject_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginObject_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginObject_Base(void);
    // destructor
    virtual ~CPluginObject_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TObjaddr;
    typedef string TSubtype;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_objaddr,
        e_subtype
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Objaddr data member.
    ///
    /// Data member Objaddr is mandatory;
    /// its type is defined as 'typedef string TObjaddr'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetObjaddr(void) const;
 
    /// Check if it is safe to call GetObjaddr method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetObjaddr(void) const;
 
    /// Reset Objaddr data member.
    void ResetObjaddr(void);
 
    /// Get the Objaddr member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TObjaddr& GetObjaddr(void) const;
 
    /// Assign a value to Objaddr data member.
    ///
    /// @param value
    ///   Value to assign
    void SetObjaddr(const TObjaddr& value);
    void SetObjaddr(TObjaddr&& value);
 
    /// Assign a value to Objaddr data member.
    ///
    /// @return
    ///   Reference to the data value.
    TObjaddr& SetObjaddr(void);
 
    /// Check if a value has been assigned to Subtype data member.
    ///
    /// Data member Subtype is mandatory;
    /// 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
    CPluginObject_Base(const CPluginObject_Base&);
    CPluginObject_Base& operator=(const CPluginObject_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Objaddr;
    string m_Subtype;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginObject_Base::IsSetObjaddr(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginObject_Base::CanGetObjaddr(void) const
{
    return IsSetObjaddr();
}
 
inline
const CPluginObject_Base::TObjaddr& CPluginObject_Base::GetObjaddr(void) const
{
    if (!CanGetObjaddr()) {
        ThrowUnassigned(0);
    }
    return m_Objaddr;
}
 
inline
void CPluginObject_Base::SetObjaddr(const CPluginObject_Base::TObjaddr& value)
{
    m_Objaddr = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CPluginObject_Base::SetObjaddr(CPluginObject_Base::TObjaddr&& value)
{
    m_Objaddr = std::forward<CPluginObject_Base::TObjaddr>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CPluginObject_Base::TObjaddr& CPluginObject_Base::SetObjaddr(void)
{
#ifdef _DEBUG
    if (!IsSetObjaddr()) {
        m_Objaddr = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Objaddr;
}
 
inline
bool CPluginObject_Base::IsSetSubtype(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginObject_Base::CanGetSubtype(void) const
{
    return IsSetSubtype();
}
 
inline
const CPluginObject_Base::TSubtype& CPluginObject_Base::GetSubtype(void) const
{
    if (!CanGetSubtype()) {
        ThrowUnassigned(1);
    }
    return m_Subtype;
}
 
inline
void CPluginObject_Base::SetSubtype(const CPluginObject_Base::TSubtype& value)
{
    m_Subtype = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CPluginObject_Base::SetSubtype(CPluginObject_Base::TSubtype&& value)
{
    m_Subtype = std::forward<CPluginObject_Base::TSubtype>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CPluginObject_Base::TSubtype& CPluginObject_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_PLUGINOBJECT_BASE_HPP