PluginRequest_.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 PluginRequest_.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_PLUGINREQUEST_BASE_HPP
#define GUI_OBJECTS_PLUGINREQUEST_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 CPluginCommand;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- PluginRequest defines the commands we can issue to a plugin
///-
///
/// CPluginRequest_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginRequest_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginRequest_Base(void);
    // destructor
    virtual ~CPluginRequest_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    // types
    typedef CPluginCommand TCommand;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_command
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 2> TmemberIndex;
 
    // getters
    // setters
 
    /// Check if a value has been assigned to Command data member.
    ///
    /// Data member Command is mandatory;
    /// its type is defined as 'typedef CPluginCommand TCommand'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetCommand(void) const;
 
    /// Check if it is safe to call GetCommand method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetCommand(void) const;
 
    /// Reset Command data member.
    void ResetCommand(void);
 
    /// Get the Command member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TCommand& GetCommand(void) const;
 
    /// Assign a value to Command data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetCommand(TCommand& value);
 
    /// Assign a value to Command data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCommand& SetCommand(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginRequest_Base(const CPluginRequest_Base&);
    CPluginRequest_Base& operator=(const CPluginRequest_Base&);
 
    // data
    Uint4 m_set_State[1];
    CRef< TCommand > m_Command;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginRequest_Base::IsSetCommand(void) const
{
    return m_Command.NotEmpty();
}
 
inline
bool CPluginRequest_Base::CanGetCommand(void) const
{
    return true;
}
 
inline
const CPluginRequest_Base::TCommand& CPluginRequest_Base::GetCommand(void) const
{
    if ( !m_Command ) {
        const_cast<CPluginRequest_Base*>(this)->ResetCommand();
    }
    return (*m_Command);
}
 
inline
CPluginRequest_Base::TCommand& CPluginRequest_Base::SetCommand(void)
{
    if ( !m_Command ) {
        ResetCommand();
    }
    return (*m_Command);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINREQUEST_BASE_HPP