PluginReplyAction_.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 PluginReplyAction_.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_PLUGINREPLYACTION_BASE_HPP
#define GUI_OBJECTS_PLUGINREPLYACTION_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 CGBProjectHandle;
class CPluginMRUEntry;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- PluginReplyAction lists possible modes of action for the items returned
///- from a plugin
///-
///
/// CPluginReplyAction_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginReplyAction_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginReplyAction_Base(void);
    // destructor
    virtual ~CPluginReplyAction_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
 
    /// Choice variants.
    enum E_Choice {
        e_not_set = 0,            ///< No variant selected
        e_Add_to_project,         ///< add this item to the associated project
        e_New_view,               ///< launch a view named by the supplied argument
        e_New_composite_view,     ///< launch a view named by the supplied argument
        e_Store,                  ///< store this object for future use  The string parameter is used as a caller-defined key for retrieval
        e_Create_project,         ///< create an empty project(s) for Raw item(s), takes plugin param as argument
        e_Create_single_project,  ///< create single project for any number of Raw items
        e_Attach_project,         ///< attach loaded project to Project Manager
        e_Refresh_project,        ///< refresh loaded project to Project Manager
        e_Add_to_MRU,             ///<a dd an entry to the MRU list
        e_Error,                  ///< show an error message
        e_Plugin_cmd_run,         ///< execute 'run' on a named plugin with our results
        e_Register_interface,     ///< register object created by the plugin
        e_Warning,                ///< report a warning to the user
        e_Info                    ///< report an info-level message to the user
    };
    /// Maximum+1 value of the choice variant enumerator.
    enum E_ChoiceStopper {
        e_MaxChoice = 15 ///< == e_Info+1
    };
 
    /// Reset the whole object
    virtual void Reset(void);
 
    /// Reset the selection (set it to e_not_set).
    virtual void ResetSelection(void);
 
    /// Which variant is currently selected.
    ///
    /// @return
    ///   Choice state enumerator.
    E_Choice Which(void) const;
 
    /// Verify selection, throw exception if it differs from the expected.
    ///
    /// @param index
    ///   Expected selection.
    void CheckSelected(E_Choice index) const;
 
    /// Throw 'InvalidSelection' exception.
    ///
    /// @param index
    ///   Expected selection.
    NCBI_NORETURN void ThrowInvalidSelection(E_Choice index) const;
 
    /// Retrieve selection name (for diagnostic purposes).
    ///
    /// @param index
    ///   One of possible selection states.
    /// @return
    ///   Name string.
    static string SelectionName(E_Choice index);
 
    /// Select the requested variant if needed.
    ///
    /// @param index
    ///   New selection state.
    /// @param reset
    ///   Flag that defines the resetting of the variant data. The data will
    ///   be reset if either the current selection differs from the new one,
    ///   or the flag is set to eDoResetVariant.
    void Select(E_Choice index, EResetVariant reset = eDoResetVariant);
    /// Select the requested variant if needed,
    /// allocating CObject variants from memory pool.
    void Select(E_Choice index,
                EResetVariant reset,
                CObjectMemoryPool* pool);
 
    // types
    typedef string TNew_view;
    typedef string TNew_composite_view;
    typedef string TStore;
    typedef string TCreate_project;
    typedef string TCreate_single_project;
    typedef CGBProjectHandle TAttach_project;
    typedef CGBProjectHandle TRefresh_project;
    typedef CPluginMRUEntry TAdd_to_MRU;
    typedef string TError;
    typedef string TPlugin_cmd_run;
    typedef string TWarning;
    typedef string TInfo;
 
    // getters
    // setters
 
 
    /// Check if variant Add_to_project is selected.
    ///
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsAdd_to_project(void) const;
 
    /// Select the variant.
    void SetAdd_to_project(void);
 
 
    /// Check if variant New_view is selected.
    ///
    /// New_view type is defined as 'typedef string TNew_view'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsNew_view(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TNew_view& GetNew_view(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TNew_view& SetNew_view(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetNew_view(const TNew_view& value);
 
 
    /// Check if variant New_composite_view is selected.
    ///
    /// New_composite_view type is defined as 'typedef string TNew_composite_view'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsNew_composite_view(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TNew_composite_view& GetNew_composite_view(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TNew_composite_view& SetNew_composite_view(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetNew_composite_view(const TNew_composite_view& value);
 
 
    /// Check if variant Store is selected.
    ///
    /// Store type is defined as 'typedef string TStore'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsStore(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TStore& GetStore(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TStore& SetStore(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetStore(const TStore& value);
 
 
    /// Check if variant Create_project is selected.
    ///
    /// Create_project type is defined as 'typedef string TCreate_project'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsCreate_project(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TCreate_project& GetCreate_project(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TCreate_project& SetCreate_project(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetCreate_project(const TCreate_project& value);
 
 
    /// Check if variant Create_single_project is selected.
    ///
    /// Create_single_project type is defined as 'typedef string TCreate_single_project'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsCreate_single_project(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TCreate_single_project& GetCreate_single_project(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TCreate_single_project& SetCreate_single_project(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetCreate_single_project(const TCreate_single_project& value);
 
 
    /// Check if variant Attach_project is selected.
    ///
    /// Attach_project type is defined as 'typedef CGBProjectHandle TAttach_project'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsAttach_project(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TAttach_project& GetAttach_project(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TAttach_project& SetAttach_project(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetAttach_project(TAttach_project& value);
 
 
    /// Check if variant Refresh_project is selected.
    ///
    /// Refresh_project type is defined as 'typedef CGBProjectHandle TRefresh_project'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsRefresh_project(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TRefresh_project& GetRefresh_project(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TRefresh_project& SetRefresh_project(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetRefresh_project(TRefresh_project& value);
 
 
    /// Check if variant Add_to_MRU is selected.
    ///
    /// Add_to_MRU type is defined as 'typedef CPluginMRUEntry TAdd_to_MRU'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsAdd_to_MRU(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TAdd_to_MRU& GetAdd_to_MRU(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TAdd_to_MRU& SetAdd_to_MRU(void);
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Reference to the data.
    void SetAdd_to_MRU(TAdd_to_MRU& value);
 
 
    /// Check if variant Error is selected.
    ///
    /// Error type is defined as 'typedef string TError'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsError(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TError& GetError(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TError& SetError(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetError(const TError& value);
 
 
    /// Check if variant Plugin_cmd_run is selected.
    ///
    /// Plugin_cmd_run type is defined as 'typedef string TPlugin_cmd_run'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsPlugin_cmd_run(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TPlugin_cmd_run& GetPlugin_cmd_run(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TPlugin_cmd_run& SetPlugin_cmd_run(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetPlugin_cmd_run(const TPlugin_cmd_run& value);
 
 
    /// Check if variant Register_interface is selected.
    ///
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsRegister_interface(void) const;
 
    /// Select the variant.
    void SetRegister_interface(void);
 
 
    /// Check if variant Warning is selected.
    ///
    /// Warning type is defined as 'typedef string TWarning'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsWarning(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TWarning& GetWarning(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TWarning& SetWarning(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetWarning(const TWarning& value);
 
 
    /// Check if variant Info is selected.
    ///
    /// Info type is defined as 'typedef string TInfo'.
    /// @return
    ///   - true, if the variant is selected.
    ///   - false, otherwise.
    bool IsInfo(void) const;
 
    /// Get the variant data.
    ///
    /// @return
    ///   Reference to the data.
    const TInfo& GetInfo(void) const;
 
    /// Select the variant.
    ///
    /// @return
    ///   Reference to the variant data.
    TInfo& SetInfo(void);
 
    /// Select the variant and set its data.
    ///
    /// @param value
    ///   Variant data.
    void SetInfo(const TInfo& value);
 
 
private:
    // copy constructor and assignment operator
    CPluginReplyAction_Base(const CPluginReplyAction_Base& );
    CPluginReplyAction_Base& operator=(const CPluginReplyAction_Base& );
    // choice state
    E_Choice m_choice;
    // helper methods
    void DoSelect(E_Choice index, CObjectMemoryPool* pool = 0);
 
    static const char* const sm_SelectionNames[];
    // data
    union {
        NCBI_NS_NCBI::CUnionBuffer<NCBI_NS_STD::string> m_string;
        NCBI_NS_NCBI::CSerialObject *m_object;
    };
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
CPluginReplyAction_Base::E_Choice CPluginReplyAction_Base::Which(void) const
{
    return m_choice;
}
 
inline
void CPluginReplyAction_Base::CheckSelected(E_Choice index) const
{
    if ( m_choice != index )
        ThrowInvalidSelection(index);
}
 
inline
void CPluginReplyAction_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset, NCBI_NS_NCBI::CObjectMemoryPool* pool)
{
    if ( reset == NCBI_NS_NCBI::eDoResetVariant || m_choice != index ) {
        if ( m_choice != e_not_set )
            ResetSelection();
        DoSelect(index, pool);
    }
}
 
inline
void CPluginReplyAction_Base::Select(E_Choice index, NCBI_NS_NCBI::EResetVariant reset)
{
    Select(index, reset, 0);
}
 
inline
bool CPluginReplyAction_Base::IsAdd_to_project(void) const
{
    return m_choice == e_Add_to_project;
}
 
inline
void CPluginReplyAction_Base::SetAdd_to_project(void)
{
    Select(e_Add_to_project, NCBI_NS_NCBI::eDoNotResetVariant);
}
 
inline
bool CPluginReplyAction_Base::IsNew_view(void) const
{
    return m_choice == e_New_view;
}
 
inline
const CPluginReplyAction_Base::TNew_view& CPluginReplyAction_Base::GetNew_view(void) const
{
    CheckSelected(e_New_view);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TNew_view& CPluginReplyAction_Base::SetNew_view(void)
{
    Select(e_New_view, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsNew_composite_view(void) const
{
    return m_choice == e_New_composite_view;
}
 
inline
const CPluginReplyAction_Base::TNew_composite_view& CPluginReplyAction_Base::GetNew_composite_view(void) const
{
    CheckSelected(e_New_composite_view);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TNew_composite_view& CPluginReplyAction_Base::SetNew_composite_view(void)
{
    Select(e_New_composite_view, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsStore(void) const
{
    return m_choice == e_Store;
}
 
inline
const CPluginReplyAction_Base::TStore& CPluginReplyAction_Base::GetStore(void) const
{
    CheckSelected(e_Store);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TStore& CPluginReplyAction_Base::SetStore(void)
{
    Select(e_Store, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsCreate_project(void) const
{
    return m_choice == e_Create_project;
}
 
inline
const CPluginReplyAction_Base::TCreate_project& CPluginReplyAction_Base::GetCreate_project(void) const
{
    CheckSelected(e_Create_project);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TCreate_project& CPluginReplyAction_Base::SetCreate_project(void)
{
    Select(e_Create_project, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsCreate_single_project(void) const
{
    return m_choice == e_Create_single_project;
}
 
inline
const CPluginReplyAction_Base::TCreate_single_project& CPluginReplyAction_Base::GetCreate_single_project(void) const
{
    CheckSelected(e_Create_single_project);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TCreate_single_project& CPluginReplyAction_Base::SetCreate_single_project(void)
{
    Select(e_Create_single_project, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsAttach_project(void) const
{
    return m_choice == e_Attach_project;
}
 
inline
bool CPluginReplyAction_Base::IsRefresh_project(void) const
{
    return m_choice == e_Refresh_project;
}
 
inline
bool CPluginReplyAction_Base::IsAdd_to_MRU(void) const
{
    return m_choice == e_Add_to_MRU;
}
 
inline
bool CPluginReplyAction_Base::IsError(void) const
{
    return m_choice == e_Error;
}
 
inline
const CPluginReplyAction_Base::TError& CPluginReplyAction_Base::GetError(void) const
{
    CheckSelected(e_Error);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TError& CPluginReplyAction_Base::SetError(void)
{
    Select(e_Error, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsPlugin_cmd_run(void) const
{
    return m_choice == e_Plugin_cmd_run;
}
 
inline
const CPluginReplyAction_Base::TPlugin_cmd_run& CPluginReplyAction_Base::GetPlugin_cmd_run(void) const
{
    CheckSelected(e_Plugin_cmd_run);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TPlugin_cmd_run& CPluginReplyAction_Base::SetPlugin_cmd_run(void)
{
    Select(e_Plugin_cmd_run, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsRegister_interface(void) const
{
    return m_choice == e_Register_interface;
}
 
inline
void CPluginReplyAction_Base::SetRegister_interface(void)
{
    Select(e_Register_interface, NCBI_NS_NCBI::eDoNotResetVariant);
}
 
inline
bool CPluginReplyAction_Base::IsWarning(void) const
{
    return m_choice == e_Warning;
}
 
inline
const CPluginReplyAction_Base::TWarning& CPluginReplyAction_Base::GetWarning(void) const
{
    CheckSelected(e_Warning);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TWarning& CPluginReplyAction_Base::SetWarning(void)
{
    Select(e_Warning, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
inline
bool CPluginReplyAction_Base::IsInfo(void) const
{
    return m_choice == e_Info;
}
 
inline
const CPluginReplyAction_Base::TInfo& CPluginReplyAction_Base::GetInfo(void) const
{
    CheckSelected(e_Info);
    return *m_string;
}
 
inline
CPluginReplyAction_Base::TInfo& CPluginReplyAction_Base::SetInfo(void)
{
    Select(e_Info, NCBI_NS_NCBI::eDoNotResetVariant);
    return *m_string;
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINREPLYACTION_BASE_HPP