GBenchVersionInfo_.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 GBenchVersionInfo_.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_GBENCHVERSIONINFO_BASE_HPP
#define GUI_OBJECTS_GBENCHVERSIONINFO_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 CDate;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GBenchService
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CGBenchVersionInfo_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CGBenchVersionInfo_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGBenchVersionInfo_Base(void);
    // destructor
    virtual ~CGBenchVersionInfo_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef int TVer_major;
    typedef int TVer_minor;
    typedef int TVer_patch;
    typedef int TOs_ver;
    typedef string TOs_ver_string;
    typedef CDate TBuild_date;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_ver_major,
        e_ver_minor,
        e_ver_patch,
        e_os_ver,
        e_os_ver_string,
        e_build_date
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 7> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Ver_major data member.
    ///
    /// Data member Ver_major is mandatory;
    /// its type is defined as 'typedef int TVer_major'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVer_major(void) const;
 
    /// Check if it is safe to call GetVer_major method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVer_major(void) const;
 
    /// Reset Ver_major data member.
    void ResetVer_major(void);
 
    /// Get the Ver_major member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVer_major GetVer_major(void) const;
 
    /// Assign a value to Ver_major data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVer_major(TVer_major value);
 
    /// Assign a value to Ver_major data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVer_major& SetVer_major(void);
 
    /// Check if a value has been assigned to Ver_minor data member.
    ///
    /// Data member Ver_minor is mandatory;
    /// its type is defined as 'typedef int TVer_minor'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVer_minor(void) const;
 
    /// Check if it is safe to call GetVer_minor method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVer_minor(void) const;
 
    /// Reset Ver_minor data member.
    void ResetVer_minor(void);
 
    /// Get the Ver_minor member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVer_minor GetVer_minor(void) const;
 
    /// Assign a value to Ver_minor data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVer_minor(TVer_minor value);
 
    /// Assign a value to Ver_minor data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVer_minor& SetVer_minor(void);
 
    /// Check if a value has been assigned to Ver_patch data member.
    ///
    /// Data member Ver_patch is mandatory;
    /// its type is defined as 'typedef int TVer_patch'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVer_patch(void) const;
 
    /// Check if it is safe to call GetVer_patch method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVer_patch(void) const;
 
    /// Reset Ver_patch data member.
    void ResetVer_patch(void);
 
    /// Get the Ver_patch member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVer_patch GetVer_patch(void) const;
 
    /// Assign a value to Ver_patch data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVer_patch(TVer_patch value);
 
    /// Assign a value to Ver_patch data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVer_patch& SetVer_patch(void);
 
    /// Check if a value has been assigned to Os_ver data member.
    ///
    /// Data member Os_ver is mandatory;
    /// its type is defined as 'typedef int TOs_ver'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOs_ver(void) const;
 
    /// Check if it is safe to call GetOs_ver method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOs_ver(void) const;
 
    /// Reset Os_ver data member.
    void ResetOs_ver(void);
 
    /// Get the Os_ver member data.
    ///
    /// @return
    ///   Copy of the member data.
    TOs_ver GetOs_ver(void) const;
 
    /// Assign a value to Os_ver data member.
    ///
    /// @param value
    ///   Value to assign
    void SetOs_ver(TOs_ver value);
 
    /// Assign a value to Os_ver data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOs_ver& SetOs_ver(void);
 
    /// os-arch INTEGER OPTIONAL,
    /// Check if a value has been assigned to Os_ver_string data member.
    ///
    /// Data member Os_ver_string is optional;
    /// its type is defined as 'typedef string TOs_ver_string'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetOs_ver_string(void) const;
 
    /// Check if it is safe to call GetOs_ver_string method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetOs_ver_string(void) const;
 
    /// Reset Os_ver_string data member.
    void ResetOs_ver_string(void);
 
    /// Get the Os_ver_string member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TOs_ver_string& GetOs_ver_string(void) const;
 
    /// Assign a value to Os_ver_string data member.
    ///
    /// @param value
    ///   Value to assign
    void SetOs_ver_string(const TOs_ver_string& value);
    void SetOs_ver_string(TOs_ver_string&& value);
 
    /// Assign a value to Os_ver_string data member.
    ///
    /// @return
    ///   Reference to the data value.
    TOs_ver_string& SetOs_ver_string(void);
 
    /// Check if a value has been assigned to Build_date data member.
    ///
    /// Data member Build_date is optional;
    /// its type is defined as 'typedef CDate TBuild_date'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetBuild_date(void) const;
 
    /// Check if it is safe to call GetBuild_date method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetBuild_date(void) const;
 
    /// Reset Build_date data member.
    void ResetBuild_date(void);
 
    /// Get the Build_date member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TBuild_date& GetBuild_date(void) const;
 
    /// Assign a value to Build_date data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetBuild_date(TBuild_date& value);
 
    /// Assign a value to Build_date data member.
    ///
    /// @return
    ///   Reference to the data value.
    TBuild_date& SetBuild_date(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGBenchVersionInfo_Base(const CGBenchVersionInfo_Base&);
    CGBenchVersionInfo_Base& operator=(const CGBenchVersionInfo_Base&);
 
    // data
    Uint4 m_set_State[1];
    int m_Ver_major;
    int m_Ver_minor;
    int m_Ver_patch;
    int m_Os_ver;
    string m_Os_ver_string;
    CRef< TBuild_date > m_Build_date;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGBenchVersionInfo_Base::IsSetVer_major(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CGBenchVersionInfo_Base::CanGetVer_major(void) const
{
    return IsSetVer_major();
}
 
inline
void CGBenchVersionInfo_Base::ResetVer_major(void)
{
    m_Ver_major = 0;
    m_set_State[0] &= ~0x3;
}
 
inline
CGBenchVersionInfo_Base::TVer_major CGBenchVersionInfo_Base::GetVer_major(void) const
{
    if (!CanGetVer_major()) {
        ThrowUnassigned(0);
    }
    return m_Ver_major;
}
 
inline
void CGBenchVersionInfo_Base::SetVer_major(CGBenchVersionInfo_Base::TVer_major value)
{
    m_Ver_major = value;
    m_set_State[0] |= 0x3;
}
 
inline
CGBenchVersionInfo_Base::TVer_major& CGBenchVersionInfo_Base::SetVer_major(void)
{
#ifdef _DEBUG
    if (!IsSetVer_major()) {
        memset(&m_Ver_major,UnassignedByte(),sizeof(m_Ver_major));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Ver_major;
}
 
inline
bool CGBenchVersionInfo_Base::IsSetVer_minor(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGBenchVersionInfo_Base::CanGetVer_minor(void) const
{
    return IsSetVer_minor();
}
 
inline
void CGBenchVersionInfo_Base::ResetVer_minor(void)
{
    m_Ver_minor = 0;
    m_set_State[0] &= ~0xc;
}
 
inline
CGBenchVersionInfo_Base::TVer_minor CGBenchVersionInfo_Base::GetVer_minor(void) const
{
    if (!CanGetVer_minor()) {
        ThrowUnassigned(1);
    }
    return m_Ver_minor;
}
 
inline
void CGBenchVersionInfo_Base::SetVer_minor(CGBenchVersionInfo_Base::TVer_minor value)
{
    m_Ver_minor = value;
    m_set_State[0] |= 0xc;
}
 
inline
CGBenchVersionInfo_Base::TVer_minor& CGBenchVersionInfo_Base::SetVer_minor(void)
{
#ifdef _DEBUG
    if (!IsSetVer_minor()) {
        memset(&m_Ver_minor,UnassignedByte(),sizeof(m_Ver_minor));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Ver_minor;
}
 
inline
bool CGBenchVersionInfo_Base::IsSetVer_patch(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGBenchVersionInfo_Base::CanGetVer_patch(void) const
{
    return IsSetVer_patch();
}
 
inline
void CGBenchVersionInfo_Base::ResetVer_patch(void)
{
    m_Ver_patch = 0;
    m_set_State[0] &= ~0x30;
}
 
inline
CGBenchVersionInfo_Base::TVer_patch CGBenchVersionInfo_Base::GetVer_patch(void) const
{
    if (!CanGetVer_patch()) {
        ThrowUnassigned(2);
    }
    return m_Ver_patch;
}
 
inline
void CGBenchVersionInfo_Base::SetVer_patch(CGBenchVersionInfo_Base::TVer_patch value)
{
    m_Ver_patch = value;
    m_set_State[0] |= 0x30;
}
 
inline
CGBenchVersionInfo_Base::TVer_patch& CGBenchVersionInfo_Base::SetVer_patch(void)
{
#ifdef _DEBUG
    if (!IsSetVer_patch()) {
        memset(&m_Ver_patch,UnassignedByte(),sizeof(m_Ver_patch));
    }
#endif
    m_set_State[0] |= 0x10;
    return m_Ver_patch;
}
 
inline
bool CGBenchVersionInfo_Base::IsSetOs_ver(void) const
{
    return ((m_set_State[0] & 0xc0) != 0);
}
 
inline
bool CGBenchVersionInfo_Base::CanGetOs_ver(void) const
{
    return IsSetOs_ver();
}
 
inline
void CGBenchVersionInfo_Base::ResetOs_ver(void)
{
    m_Os_ver = 0;
    m_set_State[0] &= ~0xc0;
}
 
inline
CGBenchVersionInfo_Base::TOs_ver CGBenchVersionInfo_Base::GetOs_ver(void) const
{
    if (!CanGetOs_ver()) {
        ThrowUnassigned(3);
    }
    return m_Os_ver;
}
 
inline
void CGBenchVersionInfo_Base::SetOs_ver(CGBenchVersionInfo_Base::TOs_ver value)
{
    m_Os_ver = value;
    m_set_State[0] |= 0xc0;
}
 
inline
CGBenchVersionInfo_Base::TOs_ver& CGBenchVersionInfo_Base::SetOs_ver(void)
{
#ifdef _DEBUG
    if (!IsSetOs_ver()) {
        memset(&m_Os_ver,UnassignedByte(),sizeof(m_Os_ver));
    }
#endif
    m_set_State[0] |= 0x40;
    return m_Os_ver;
}
 
inline
bool CGBenchVersionInfo_Base::IsSetOs_ver_string(void) const
{
    return ((m_set_State[0] & 0x300) != 0);
}
 
inline
bool CGBenchVersionInfo_Base::CanGetOs_ver_string(void) const
{
    return IsSetOs_ver_string();
}
 
inline
const CGBenchVersionInfo_Base::TOs_ver_string& CGBenchVersionInfo_Base::GetOs_ver_string(void) const
{
    if (!CanGetOs_ver_string()) {
        ThrowUnassigned(4);
    }
    return m_Os_ver_string;
}
 
inline
void CGBenchVersionInfo_Base::SetOs_ver_string(const CGBenchVersionInfo_Base::TOs_ver_string& value)
{
    m_Os_ver_string = value;
    m_set_State[0] |= 0x300;
}
 
inline
void CGBenchVersionInfo_Base::SetOs_ver_string(CGBenchVersionInfo_Base::TOs_ver_string&& value)
{
    m_Os_ver_string = std::forward<CGBenchVersionInfo_Base::TOs_ver_string>(value);
    m_set_State[0] |= 0x300;
}
 
inline
CGBenchVersionInfo_Base::TOs_ver_string& CGBenchVersionInfo_Base::SetOs_ver_string(void)
{
#ifdef _DEBUG
    if (!IsSetOs_ver_string()) {
        m_Os_ver_string = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x100;
    return m_Os_ver_string;
}
 
inline
bool CGBenchVersionInfo_Base::IsSetBuild_date(void) const
{
    return m_Build_date.NotEmpty();
}
 
inline
bool CGBenchVersionInfo_Base::CanGetBuild_date(void) const
{
    return IsSetBuild_date();
}
 
inline
const CGBenchVersionInfo_Base::TBuild_date& CGBenchVersionInfo_Base::GetBuild_date(void) const
{
    if (!CanGetBuild_date()) {
        ThrowUnassigned(5);
    }
    return (*m_Build_date);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_GBENCHVERSIONINFO_BASE_HPP