GuiPkgManifest_.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 GuiPkgManifest_.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/framework/gui_framework.dtd">gui_framework.dtd</a>
/// and additional tune-up parameters:
/// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/gui/framework/gui_framework.def">gui_framework.def</a>
///
/// ATTENTION:
///   Don't edit or commit this file into CVS as this file will
///   be overridden (by DATATOOL) without warning!
 
#ifndef GUI_FRAMEWORK_GUIPKGMANIFEST_BASE_HPP
#define GUI_FRAMEWORK_GUIPKGMANIFEST_BASE_HPP
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
#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 CGuiPkgDependency;
 
 
// generated classes
 
 
/** @addtogroup dataspec_gui_framework
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CGuiPkgManifest_Base --
///
 
class CGuiPkgManifest_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGuiPkgManifest_Base(void);
    // destructor
    virtual ~CGuiPkgManifest_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef string TName;
    typedef string TDescription;
    typedef string TVersion;
    typedef string TMainDll;
    typedef list< CRef< CGuiPkgDependency > > TGuiPkgDependency;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_Name,
        e_Description,
        e_Version,
        e_MainDll,
        e_GuiPkgDependency
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 6> TmemberIndex;
 
    // getters
    // setters
 
    /// .+ 
    /// Check if a value has been assigned to Name data member.
    ///
    /// Data member Name is mandatory;
    /// its type is defined as 'typedef string TName'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetName(void) const;
 
    /// Check if it is safe to call GetName method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetName(void) const;
 
    /// Reset Name data member.
    void ResetName(void);
 
    /// Get the Name member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TName& GetName(void) const;
 
    /// Assign a value to Name data member.
    ///
    /// @param value
    ///   Value to assign
    void SetName(const TName& value);
    void SetName(TName&& value);
 
    /// Assign a value to Name data member.
    ///
    /// @return
    ///   Reference to the data value.
    TName& SetName(void);
 
    /// .+ 
    /// Check if a value has been assigned to Description data member.
    ///
    /// Data member Description is mandatory;
    /// its type is defined as 'typedef string TDescription'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetDescription(void) const;
 
    /// Check if it is safe to call GetDescription method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetDescription(void) const;
 
    /// Reset Description data member.
    void ResetDescription(void);
 
    /// Get the Description member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TDescription& GetDescription(void) const;
 
    /// Assign a value to Description data member.
    ///
    /// @param value
    ///   Value to assign
    void SetDescription(const TDescription& value);
    void SetDescription(TDescription&& value);
 
    /// Assign a value to Description data member.
    ///
    /// @return
    ///   Reference to the data value.
    TDescription& SetDescription(void);
 
    /// \d\d\.\d\d\.\d\d\d\d 
    /// Check if a value has been assigned to Version data member.
    ///
    /// Data member Version is mandatory;
    /// its type is defined as 'typedef string TVersion'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVersion(void) const;
 
    /// Check if it is safe to call GetVersion method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVersion(void) const;
 
    /// Reset Version data member.
    void ResetVersion(void);
 
    /// Get the Version member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TVersion& GetVersion(void) const;
 
    /// Assign a value to Version data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVersion(const TVersion& value);
    void SetVersion(TVersion&& value);
 
    /// Assign a value to Version data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVersion& SetVersion(void);
 
    /// .+ 
    /// Check if a value has been assigned to MainDll data member.
    ///
    /// Data member MainDll is mandatory;
    /// its type is defined as 'typedef string TMainDll'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetMainDll(void) const;
 
    /// Check if it is safe to call GetMainDll method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetMainDll(void) const;
 
    /// Reset MainDll data member.
    void ResetMainDll(void);
 
    /// Get the MainDll member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TMainDll& GetMainDll(void) const;
 
    /// Assign a value to MainDll data member.
    ///
    /// @param value
    ///   Value to assign
    void SetMainDll(const TMainDll& value);
    void SetMainDll(TMainDll&& value);
 
    /// Assign a value to MainDll data member.
    ///
    /// @return
    ///   Reference to the data value.
    TMainDll& SetMainDll(void);
 
    /// Check if a value has been assigned to GuiPkgDependency data member.
    ///
    /// Data member GuiPkgDependency is optional;
    /// its type is defined as 'typedef list< CRef< CGuiPkgDependency > > TGuiPkgDependency'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetGuiPkgDependency(void) const;
 
    /// Check if it is safe to call GetGuiPkgDependency method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetGuiPkgDependency(void) const;
 
    /// Reset GuiPkgDependency data member.
    void ResetGuiPkgDependency(void);
 
    /// Get the GuiPkgDependency member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TGuiPkgDependency& GetGuiPkgDependency(void) const;
 
    /// Assign a value to GuiPkgDependency data member.
    ///
    /// @return
    ///   Reference to the data value.
    TGuiPkgDependency& SetGuiPkgDependency(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGuiPkgManifest_Base(const CGuiPkgManifest_Base&);
    CGuiPkgManifest_Base& operator=(const CGuiPkgManifest_Base&);
 
    // data
    Uint4 m_set_State[1];
    string m_Name;
    string m_Description;
    string m_Version;
    string m_MainDll;
    list< CRef< CGuiPkgDependency > > m_GuiPkgDependency;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGuiPkgManifest_Base::IsSetName(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CGuiPkgManifest_Base::CanGetName(void) const
{
    return IsSetName();
}
 
inline
const CGuiPkgManifest_Base::TName& CGuiPkgManifest_Base::GetName(void) const
{
    if (!CanGetName()) {
        ThrowUnassigned(0);
    }
    return m_Name;
}
 
inline
void CGuiPkgManifest_Base::SetName(const CGuiPkgManifest_Base::TName& value)
{
    m_Name = value;
    m_set_State[0] |= 0x3;
}
 
inline
void CGuiPkgManifest_Base::SetName(CGuiPkgManifest_Base::TName&& value)
{
    m_Name = std::forward<CGuiPkgManifest_Base::TName>(value);
    m_set_State[0] |= 0x3;
}
 
inline
CGuiPkgManifest_Base::TName& CGuiPkgManifest_Base::SetName(void)
{
#ifdef _DEBUG
    if (!IsSetName()) {
        m_Name = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Name;
}
 
inline
bool CGuiPkgManifest_Base::IsSetDescription(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGuiPkgManifest_Base::CanGetDescription(void) const
{
    return IsSetDescription();
}
 
inline
const CGuiPkgManifest_Base::TDescription& CGuiPkgManifest_Base::GetDescription(void) const
{
    if (!CanGetDescription()) {
        ThrowUnassigned(1);
    }
    return m_Description;
}
 
inline
void CGuiPkgManifest_Base::SetDescription(const CGuiPkgManifest_Base::TDescription& value)
{
    m_Description = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CGuiPkgManifest_Base::SetDescription(CGuiPkgManifest_Base::TDescription&& value)
{
    m_Description = std::forward<CGuiPkgManifest_Base::TDescription>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CGuiPkgManifest_Base::TDescription& CGuiPkgManifest_Base::SetDescription(void)
{
#ifdef _DEBUG
    if (!IsSetDescription()) {
        m_Description = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Description;
}
 
inline
bool CGuiPkgManifest_Base::IsSetVersion(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGuiPkgManifest_Base::CanGetVersion(void) const
{
    return IsSetVersion();
}
 
inline
const CGuiPkgManifest_Base::TVersion& CGuiPkgManifest_Base::GetVersion(void) const
{
    if (!CanGetVersion()) {
        ThrowUnassigned(2);
    }
    return m_Version;
}
 
inline
void CGuiPkgManifest_Base::SetVersion(const CGuiPkgManifest_Base::TVersion& value)
{
    m_Version = value;
    m_set_State[0] |= 0x30;
}
 
inline
void CGuiPkgManifest_Base::SetVersion(CGuiPkgManifest_Base::TVersion&& value)
{
    m_Version = std::forward<CGuiPkgManifest_Base::TVersion>(value);
    m_set_State[0] |= 0x30;
}
 
inline
CGuiPkgManifest_Base::TVersion& CGuiPkgManifest_Base::SetVersion(void)
{
#ifdef _DEBUG
    if (!IsSetVersion()) {
        m_Version = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Version;
}
 
inline
bool CGuiPkgManifest_Base::IsSetMainDll(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CGuiPkgManifest_Base::CanGetMainDll(void) const
{
    return IsSetMainDll();
}
 
inline
const CGuiPkgManifest_Base::TMainDll& CGuiPkgManifest_Base::GetMainDll(void) const
{
    if (!CanGetMainDll()) {
        ThrowUnassigned(3);
    }
    return m_MainDll;
}
 
inline
void CGuiPkgManifest_Base::SetMainDll(const CGuiPkgManifest_Base::TMainDll& value)
{
    m_MainDll = value;
    m_set_State[0] |= 0xc0;
}
 
inline
void CGuiPkgManifest_Base::SetMainDll(CGuiPkgManifest_Base::TMainDll&& value)
{
    m_MainDll = std::forward<CGuiPkgManifest_Base::TMainDll>(value);
    m_set_State[0] |= 0xc0;
}
 
inline
CGuiPkgManifest_Base::TMainDll& CGuiPkgManifest_Base::SetMainDll(void)
{
#ifdef _DEBUG
    if (!IsSetMainDll()) {
        m_MainDll = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x40;
    return m_MainDll;
}
 
inline
bool CGuiPkgManifest_Base::IsSetGuiPkgDependency(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CGuiPkgManifest_Base::CanGetGuiPkgDependency(void) const
{
    return true;
}
 
inline
const CGuiPkgManifest_Base::TGuiPkgDependency& CGuiPkgManifest_Base::GetGuiPkgDependency(void) const
{
    return m_GuiPkgDependency;
}
 
inline
CGuiPkgManifest_Base::TGuiPkgDependency& CGuiPkgManifest_Base::SetGuiPkgDependency(void)
{
    m_set_State[0] |= 0x100;
    return m_GuiPkgDependency;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_FRAMEWORK_GUIPKGMANIFEST_BASE_HPP