GBenchInitReply_.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 GBenchInitReply_.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_GBENCHINITREPLY_BASE_HPP
#define GUI_OBJECTS_GBENCHINITREPLY_BASE_HPP
 
// extra headers
#include <gui/gui_export.h>
 
// standard includes
#include <serial/serialbase.hpp>
 
// generated includes
#include <list>
 
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;
class CPluginInfo;
class CUser_object;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_GBenchService
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///
/// We reply to 'init' with the current version so the client can make a
/// decision about whether to request an update
/// We also send some configuration information, including:
///
///  - a description of publically-available services
///  - a set of optional config libraries we can use to customize and upgrade
///    the configuration
///
///
/// CGBenchInitReply_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CGBenchInitReply_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CGBenchInitReply_Base(void);
    // destructor
    virtual ~CGBenchInitReply_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CGBenchVersionInfo TCurrent_version;
    typedef list< CRef< CPluginInfo > > TPublic_services;
    typedef list< CRef< CUser_object > > TExtra_configs;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_current_version,
        e_public_services,
        e_extra_configs
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Current_version data member.
    ///
    /// Data member Current_version is mandatory;
    /// its type is defined as 'typedef CGBenchVersionInfo TCurrent_version'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCurrent_version(void) const;
 
    /// Check if it is safe to call GetCurrent_version method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCurrent_version(void) const;
 
    /// Reset Current_version data member.
    void ResetCurrent_version(void);
 
    /// Get the Current_version member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCurrent_version& GetCurrent_version(void) const;
 
    /// Assign a value to Current_version data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetCurrent_version(TCurrent_version& value);
 
    /// Assign a value to Current_version data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCurrent_version& SetCurrent_version(void);
 
    /// Check if a value has been assigned to Public_services data member.
    ///
    /// Data member Public_services is optional;
    /// its type is defined as 'typedef list< CRef< CPluginInfo > > TPublic_services'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetPublic_services(void) const;
 
    /// Check if it is safe to call GetPublic_services method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetPublic_services(void) const;
 
    /// Reset Public_services data member.
    void ResetPublic_services(void);
 
    /// Get the Public_services member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TPublic_services& GetPublic_services(void) const;
 
    /// Assign a value to Public_services data member.
    ///
    /// @return
    ///   Reference to the data value.
    TPublic_services& SetPublic_services(void);
 
    /// Check if a value has been assigned to Extra_configs data member.
    ///
    /// Data member Extra_configs is optional;
    /// its type is defined as 'typedef list< CRef< CUser_object > > TExtra_configs'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetExtra_configs(void) const;
 
    /// Check if it is safe to call GetExtra_configs method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetExtra_configs(void) const;
 
    /// Reset Extra_configs data member.
    void ResetExtra_configs(void);
 
    /// Get the Extra_configs member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TExtra_configs& GetExtra_configs(void) const;
 
    /// Assign a value to Extra_configs data member.
    ///
    /// @return
    ///   Reference to the data value.
    TExtra_configs& SetExtra_configs(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CGBenchInitReply_Base(const CGBenchInitReply_Base&);
    CGBenchInitReply_Base& operator=(const CGBenchInitReply_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TCurrent_version > m_Current_version;
    list< CRef< CPluginInfo > > m_Public_services;
    list< CRef< CUser_object > > m_Extra_configs;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CGBenchInitReply_Base::IsSetCurrent_version(void) const
{
    return m_Current_version.NotEmpty();
}
 
inline
bool CGBenchInitReply_Base::CanGetCurrent_version(void) const
{
    return true;
}
 
inline
const CGBenchInitReply_Base::TCurrent_version& CGBenchInitReply_Base::GetCurrent_version(void) const
{
    if ( !m_Current_version ) {
        const_cast<CGBenchInitReply_Base*>(this)->ResetCurrent_version();
    }
    return (*m_Current_version);
}
 
inline
CGBenchInitReply_Base::TCurrent_version& CGBenchInitReply_Base::SetCurrent_version(void)
{
    if ( !m_Current_version ) {
        ResetCurrent_version();
    }
    return (*m_Current_version);
}
 
inline
bool CGBenchInitReply_Base::IsSetPublic_services(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CGBenchInitReply_Base::CanGetPublic_services(void) const
{
    return true;
}
 
inline
const CGBenchInitReply_Base::TPublic_services& CGBenchInitReply_Base::GetPublic_services(void) const
{
    return m_Public_services;
}
 
inline
CGBenchInitReply_Base::TPublic_services& CGBenchInitReply_Base::SetPublic_services(void)
{
    m_set_State[0] |= 0x4;
    return m_Public_services;
}
 
inline
bool CGBenchInitReply_Base::IsSetExtra_configs(void) const
{
    return ((m_set_State[0] & 0x30) != 0);
}
 
inline
bool CGBenchInitReply_Base::CanGetExtra_configs(void) const
{
    return true;
}
 
inline
const CGBenchInitReply_Base::TExtra_configs& CGBenchInitReply_Base::GetExtra_configs(void) const
{
    return m_Extra_configs;
}
 
inline
CGBenchInitReply_Base::TExtra_configs& CGBenchInitReply_Base::SetExtra_configs(void)
{
    m_set_State[0] |= 0x10;
    return m_Extra_configs;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_GBENCHINITREPLY_BASE_HPP