PluginCommand_.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 PluginCommand_.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_PLUGINCOMMAND_BASE_HPP
#define GUI_OBJECTS_PLUGINCOMMAND_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 CPluginArgSet;
 
 
// generated classes
 
 
/** @addtogroup dataspec_NCBI_Plugin
 *
 * @{
 */
 
/////////////////////////////////////////////////////////////////////////////
///-
///- PluginCommand is the list of arguments that a plugin takes
///-
///
/// CPluginCommand_Base --
///
 
class NCBI_GUIOBJECTS_EXPORT CPluginCommand_Base : public CSerialObject
{
    typedef CSerialObject Tparent;
public:
    // constructor
    CPluginCommand_Base(void);
    // destructor
    virtual ~CPluginCommand_Base(void);
 
    // type info
    DECLARE_INTERNAL_TYPE_INFO();
 
    enum ECommand {
        eCommand_no_command         =  0,  ///< general-purpose commands
        eCommand_init               =  1,
        eCommand_get_status         =  2,
        eCommand_finish             =  3,
        eCommand_abort              =  4,
        eCommand_create_interface   =  5,
        eCommand_load               =  6,  ///< data commands
        eCommand_save               =  7,
        eCommand_import             =  8,
        eCommand_load_project       =  9,
        eCommand_save_project       = 10,
        eCommand_search             = 11,  ///< data source commands
        eCommand_manage             = 12,
        eCommand_run                = 13,  ///< algorithm commands
        eCommand_suspend            = 14,
        eCommand_resume             = 15,
        eCommand_new_view           = 16,  ///< view commands
        eCommand_new_composite_view = 17
    };
    
    /// Access to ECommand's attributes (values, names) as defined in spec
    static const NCBI_NS_NCBI::CEnumeratedTypeValues* ENUM_METHOD_NAME(ECommand)(void);
    
    // types
    typedef ECommand TCommand;
    typedef string TContext;
    typedef CPluginArgSet TArgs;
 
    // member index
    enum class E_memberIndex {
        e__allMandatory = 0,
        e_command,
        e_context,
        e_args
    };
    typedef Tparent::CMemberIndex<E_memberIndex, 4> 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 ECommand 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
    ///   Copy of the member data.
    TCommand GetCommand(void) const;
 
    /// Assign a value to Command data member.
    ///
    /// @param value
    ///   Value to assign
    void SetCommand(TCommand value);
 
    /// Assign a value to Command data member.
    ///
    /// @return
    ///   Reference to the data value.
    TCommand& SetCommand(void);
 
    /// optional named context
    /// Check if a value has been assigned to Context data member.
    ///
    /// Data member Context is optional;
    /// its type is defined as 'typedef string TContext'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetContext(void) const;
 
    /// Check if it is safe to call GetContext method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetContext(void) const;
 
    /// Reset Context data member.
    void ResetContext(void);
 
    /// Get the Context member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TContext& GetContext(void) const;
 
    /// Assign a value to Context data member.
    ///
    /// @param value
    ///   Value to assign
    void SetContext(const TContext& value);
    void SetContext(TContext&& value);
 
    /// Assign a value to Context data member.
    ///
    /// @return
    ///   Reference to the data value.
    TContext& SetContext(void);
 
    /// input arguments
    /// Check if a value has been assigned to Args data member.
    ///
    /// Data member Args is optional;
    /// its type is defined as 'typedef CPluginArgSet TArgs'
    /// @return
    ///   - true, if a value has been assigned.
    ///   - false, otherwise.
    bool IsSetArgs(void) const;
 
    /// Check if it is safe to call GetArgs method.
    ///
    /// @return
    ///   - true, if the data member is getatable.
    ///   - false, otherwise.
    bool CanGetArgs(void) const;
 
    /// Reset Args data member.
    void ResetArgs(void);
 
    /// Get the Args member data.
    ///
    /// @return
    ///   Reference to the member data.
    const TArgs& GetArgs(void) const;
 
    /// Assign a value to Args data member.
    ///
    /// @param value
    ///   Reference to value.
    void SetArgs(TArgs& value);
 
    /// Assign a value to Args data member.
    ///
    /// @return
    ///   Reference to the data value.
    TArgs& SetArgs(void);
 
    /// Reset the whole object
    virtual void Reset(void);
 
 
private:
    // Prohibit copy constructor and assignment operator
    CPluginCommand_Base(const CPluginCommand_Base&);
    CPluginCommand_Base& operator=(const CPluginCommand_Base&);
 
    // data
    Uint4 m_set_State[1];
    ECommand m_Command;
    string m_Context;
    CRef< TArgs > m_Args;
};
 
/* @} */
 
 
 
 
 
///////////////////////////////////////////////////////////
///////////////////// inline methods //////////////////////
///////////////////////////////////////////////////////////
inline
bool CPluginCommand_Base::IsSetCommand(void) const
{
    return ((m_set_State[0] & 0x3) != 0);
}
 
inline
bool CPluginCommand_Base::CanGetCommand(void) const
{
    return IsSetCommand();
}
 
inline
void CPluginCommand_Base::ResetCommand(void)
{
    m_Command = (ECommand)(0);
    m_set_State[0] &= ~0x3;
}
 
inline
CPluginCommand_Base::TCommand CPluginCommand_Base::GetCommand(void) const
{
    if (!CanGetCommand()) {
        ThrowUnassigned(0);
    }
    return m_Command;
}
 
inline
void CPluginCommand_Base::SetCommand(CPluginCommand_Base::TCommand value)
{
    m_Command = value;
    m_set_State[0] |= 0x3;
}
 
inline
CPluginCommand_Base::TCommand& CPluginCommand_Base::SetCommand(void)
{
#ifdef _DEBUG
    if (!IsSetCommand()) {
        memset(&m_Command,UnassignedByte(),sizeof(m_Command));
    }
#endif
    m_set_State[0] |= 0x1;
    return m_Command;
}
 
inline
bool CPluginCommand_Base::IsSetContext(void) const
{
    return ((m_set_State[0] & 0xc) != 0);
}
 
inline
bool CPluginCommand_Base::CanGetContext(void) const
{
    return IsSetContext();
}
 
inline
const CPluginCommand_Base::TContext& CPluginCommand_Base::GetContext(void) const
{
    if (!CanGetContext()) {
        ThrowUnassigned(1);
    }
    return m_Context;
}
 
inline
void CPluginCommand_Base::SetContext(const CPluginCommand_Base::TContext& value)
{
    m_Context = value;
    m_set_State[0] |= 0xc;
}
 
inline
void CPluginCommand_Base::SetContext(CPluginCommand_Base::TContext&& value)
{
    m_Context = std::forward<CPluginCommand_Base::TContext>(value);
    m_set_State[0] |= 0xc;
}
 
inline
CPluginCommand_Base::TContext& CPluginCommand_Base::SetContext(void)
{
#ifdef _DEBUG
    if (!IsSetContext()) {
        m_Context = UnassignedString();
    }
#endif
    m_set_State[0] |= 0x4;
    return m_Context;
}
 
inline
bool CPluginCommand_Base::IsSetArgs(void) const
{
    return m_Args.NotEmpty();
}
 
inline
bool CPluginCommand_Base::CanGetArgs(void) const
{
    return IsSetArgs();
}
 
inline
const CPluginCommand_Base::TArgs& CPluginCommand_Base::GetArgs(void) const
{
    if (!CanGetArgs()) {
        ThrowUnassigned(2);
    }
    return (*m_Args);
}
 
///////////////////////////////////////////////////////////
////////////////// end of inline methods //////////////////
///////////////////////////////////////////////////////////
 
 
 
 
 
END_objects_SCOPE // namespace ncbi::objects::
 
END_NCBI_SCOPE
 
 
#endif // GUI_OBJECTS_PLUGINCOMMAND_BASE_HPP