PluginLibInfo_.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 PluginLibInfo_.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_PLUGINLIBINFO_BASE_HPP
#define GUI_OBJECTS_PLUGINLIBINFO_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::
 
 
// forward declarations
class CPluginInfoSet;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- kludge around missing CTypeRef code (doesn't support
///- SET OF SEQUENCE {...} if the sequence includes a derived class)
///-
///
/// CPluginLibInfo_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginLibInfo_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginLibInfo_Base(void);
    // destructor
    virtual ~CPluginLibInfo_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TLibrary;
    typedef bool TEnabled;
    typedef CPluginInfoSet TInfo;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_library,
        e_enabled,
        e_info
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Library data member.
    ///
    /// Data member Library is mandatory;
    /// its type is defined as 'typedef string TLibrary'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetLibrary(void) const;
 
    /// Check if it is safe to call GetLibrary method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetLibrary(void) const;
 
    /// Reset Library data member.
    void ResetLibrary(void);
 
    /// Get the Library member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TLibrary& GetLibrary(void) const;
 
    /// Assign a value to Library data member.
    ///
    /// @param value
    ///   Value to assign
    void SetLibrary(const TLibrary& value);
    void SetLibrary(TLibrary&& value);
 
    /// Assign a value to Library data member.
    ///
    /// @return
    ///   Reference to the data value.
    TLibrary& SetLibrary(void);
 
    /// flag: is this plugin enabled?
    /// Check if a value has been assigned to Enabled data member.
    ///
    /// Data member Enabled is optional with default true;
    /// its type is defined as 'typedef bool TEnabled'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetEnabled(void) const;
 
    /// Check if it is safe to call GetEnabled method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetEnabled(void) const;
 
    /// Reset Enabled data member.
    void ResetEnabled(void);
 
    /// Assign default value to Enabled data member.
    void SetDefaultEnabled(void);
 
    /// Get the Enabled member data.
    ///
    /// @return
    ///   Copy of the member data.
    TEnabled GetEnabled(void) const;
 
    /// Assign a value to Enabled data member.
    ///
    /// @param value
    ///   Value to assign
    void SetEnabled(TEnabled value);
 
    /// Assign a value to Enabled data member.
    ///
    /// @return
    ///   Reference to the data value.
    TEnabled& SetEnabled(void);
 
    /// Check if a value has been assigned to Info data member.
    ///
    /// Data member Info is mandatory;
    /// its type is defined as 'typedef CPluginInfoSet TInfo'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetInfo(void) const;
 
    /// Check if it is safe to call GetInfo method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetInfo(void) const;
 
    /// Reset Info data member.
    void ResetInfo(void);
 
    /// Get the Info member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TInfo& GetInfo(void) const;
 
    /// Assign a value to Info data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetInfo(TInfo& value);
 
    /// Assign a value to Info data member.
    ///
    /// @return
    ///   Reference to the data value.
    TInfo& SetInfo(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginLibInfo_Base(const CPluginLibInfo_Base&);
    CPluginLibInfo_Base& operator=(const CPluginLibInfo_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Library;
    bool m_Enabled;
    CRef< TInfo > m_Info;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginLibInfo_Base::IsSetLibrary(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginLibInfo_Base::CanGetLibrary(void) const
{
    return IsSetLibrary();
}
 
inline
const CPluginLibInfo_Base::TLibrary& CPluginLibInfo_Base::GetLibrary(void) const
{
    if (!CanGetLibrary()) {
        ThrowUnassigned(0);
    }
    return m_Library;
}
 
inline
void CPluginLibInfo_Base::SetLibrary(const CPluginLibInfo_Base::TLibrary& value)
{
    m_Library = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CPluginLibInfo_Base::SetLibrary(CPluginLibInfo_Base::TLibrary&& value)
{
    m_Library = std::forward<CPluginLibInfo_Base::TLibrary>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CPluginLibInfo_Base::TLibrary& CPluginLibInfo_Base::SetLibrary(void)
{
#ifdef _DEBUG
    if (!IsSetLibrary()) {
        m_Library = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Library;
}
 
inline
bool CPluginLibInfo_Base::IsSetEnabled(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginLibInfo_Base::CanGetEnabled(void) const
{
    return true;
}
 
inline
void CPluginLibInfo_Base::ResetEnabled(void)
{
    m_Enabled = true;
    m_set_State[0] &= ~0xc;
}
 
inline
void CPluginLibInfo_Base::SetDefaultEnabled(void)
{
    ResetEnabled();
}
 
inline
CPluginLibInfo_Base::TEnabled CPluginLibInfo_Base::GetEnabled(void) const
{
    return m_Enabled;
}
 
inline
void CPluginLibInfo_Base::SetEnabled(CPluginLibInfo_Base::TEnabled value)
{
    m_Enabled = value;
    m_set_State[0] |= 0xc;
}
 
inline
CPluginLibInfo_Base::TEnabled& CPluginLibInfo_Base::SetEnabled(void)
{
#ifdef _DEBUG
    if (!IsSetEnabled()) {
        memset(&m_Enabled,UnassignedByte(),sizeof(m_Enabled));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Enabled;
}
 
inline
bool CPluginLibInfo_Base::IsSetInfo(void) const
{
    return m_Info.NotEmpty();
}
 
inline
bool CPluginLibInfo_Base::CanGetInfo(void) const
{
    return true;
}
 
inline
const CPluginLibInfo_Base::TInfo& CPluginLibInfo_Base::GetInfo(void) const
{
    if ( !m_Info ) {
        const_cast<CPluginLibInfo_Base*>(this)->ResetInfo();
    }
    return (*m_Info);
}
 
inline
CPluginLibInfo_Base::TInfo& CPluginLibInfo_Base::SetInfo(void)
{
    if ( !m_Info ) {
        ResetInfo();
    }
    return (*m_Info);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINLIBINFO_BASE_HPP