GBenchVersionRequest_.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 GBenchVersionRequest_.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_GBENCHVERSIONREQUEST_BASE_HPP
#define GUI_OBJECTS_GBENCHVERSIONREQUEST_BASE_HPP
 
// extra headers
#include <gui/gui_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
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 CGBenchVersionInfo;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GBenchService
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// CGBenchVersionRequest_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CGBenchVersionRequest_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGBenchVersionRequest_Base(void);
    // destructor
    virtual ~CGBenchVersionRequest_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    enum EVersion_request {
        eVersion_request_download_url = 0,
        eVersion_request_package      = 1
    };
    
    /// Access to EVersion_request's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(EVersion_request)(void);
    
    // types
    typedef CGBenchVersionInfo TVersion;
    typedef EVersion_request TVersion_request;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_version,
        e_version_request
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 3> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Version data member.
    ///
    /// Data member Version is mandatory;
    /// its type is defined as 'typedef CGBenchVersionInfo 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
    ///   Reference to 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 Version_request data member.
    ///
    /// Data member Version_request is optional with default eVersion_request_download_url;
    /// its type is defined as 'typedef EVersion_request TVersion_request'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetVersion_request(void) const;
 
    /// Check if it is safe to call GetVersion_request method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetVersion_request(void) const;
 
    /// Reset Version_request data member.
    void ResetVersion_request(void);
 
    /// Assign default value to Version_request data member.
    void SetDefaultVersion_request(void);
 
    /// Get the Version_request member data.
    ///
    /// @return
    ///   Copy of the member data.
    TVersion_request GetVersion_request(void) const;
 
    /// Assign a value to Version_request data member.
    ///
    /// @param value
    ///   Value to assign
    void SetVersion_request(TVersion_request value);
 
    /// Assign a value to Version_request data member.
    ///
    /// @return
    ///   Reference to the data value.
    TVersion_request& SetVersion_request(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGBenchVersionRequest_Base(const CGBenchVersionRequest_Base&);
    CGBenchVersionRequest_Base& operator=(const CGBenchVersionRequest_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TVersion > m_Version;
    EVersion_request m_Version_request;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGBenchVersionRequest_Base::IsSetVersion(void) const
{
    return m_Version.NotEmpty();
}
 
inline
bool CGBenchVersionRequest_Base::CanGetVersion(void) const
{
    return true;
}
 
inline
const CGBenchVersionRequest_Base::TVersion& CGBenchVersionRequest_Base::GetVersion(void) const
{
    if ( !m_Version ) {
        const_cast<CGBenchVersionRequest_Base*>(this)->ResetVersion();
    }
    return (*m_Version);
}
 
inline
CGBenchVersionRequest_Base::TVersion& CGBenchVersionRequest_Base::SetVersion(void)
{
    if ( !m_Version ) {
        ResetVersion();
    }
    return (*m_Version);
}
 
inline
bool CGBenchVersionRequest_Base::IsSetVersion_request(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGBenchVersionRequest_Base::CanGetVersion_request(void) const
{
    return true;
}
 
inline
void CGBenchVersionRequest_Base::ResetVersion_request(void)
{
    m_Version_request = eVersion_request_download_url;
    m_set_State[0] &= ~0xc;
}
 
inline
void CGBenchVersionRequest_Base::SetDefaultVersion_request(void)
{
    ResetVersion_request();
}
 
inline
CGBenchVersionRequest_Base::TVersion_request CGBenchVersionRequest_Base::GetVersion_request(void) const
{
    return m_Version_request;
}
 
inline
void CGBenchVersionRequest_Base::SetVersion_request(CGBenchVersionRequest_Base::TVersion_request value)
{
    m_Version_request = value;
    m_set_State[0] |= 0xc;
}
 
inline
CGBenchVersionRequest_Base::TVersion_request& CGBenchVersionRequest_Base::SetVersion_request(void)
{
#ifdef _DEBUG
    if (!IsSetVersion_request()) {
        memset(&m_Version_request,UnassignedByte(),sizeof(m_Version_request));
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Version_request;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_GBENCHVERSIONREQUEST_BASE_HPP