pluginrequest.hpp

ncbi源码

/*
 * ===========================================================================
 * PRODUCTION $Log: PluginRequest.hpp,v $
 * PRODUCTION Revision 1000.1  2003/11/05 15:24:56  gouriano
 * PRODUCTION PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.6
 * PRODUCTION
 * ===========================================================================
 */

/* $Id: PluginRequest.hpp,v 1000.1 2003/11/05 15:24:56 gouriano Exp $
 * ===========================================================================
 *
 *                            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.
 *
 * ===========================================================================
 *
 * Author:  .......
 *
 * File Description:
 *   .......
 *
 * Remark:
 *   This code was originally generated by application DATATOOL
 *   using specifications from the data definition file
 *   'plugin.asn'.
 */

#ifndef GUI_CORE_PLUGIN_PLUGINREQUEST_HPP
#define GUI_CORE_PLUGIN_PLUGINREQUEST_HPP


// generated includes
#include <gui/plugin/PluginRequest_.hpp>
#include <gui/plugin/AlgoCommand.hpp>
#include <gui/plugin/DataCommand.hpp>
#include <gui/plugin/ViewCommand.hpp>

// generated classes

BEGIN_NCBI_SCOPE

BEGIN_objects_SCOPE // namespace ncbi::objects::

class CPluginCommand;


class NCBI_XGBPLUGIN_EXPORT CPluginRequest : public CPluginRequest_Base
{
    typedef CPluginRequest_Base Tparent;
public:
    // constructor
    CPluginRequest(void);
    // destructor
    ~CPluginRequest(void);

    // a plugin request is a variant selecting between three command types
    // this utility returns the command objec, whichever one is set
    const CPluginCommand& GetCommand(void) const;
    CPluginCommand&       SetCommand(void);

    // utility functions to ease the syntax of creating new commands
    CPluginCommand& SetCommand(EAlgoCommand cmd);
    CPluginCommand& SetCommand(EDataCommand cmd);
    CPluginCommand& SetCommand(EViewCommand cmd);

private:
    // Prohibit copy constructor and assignment operator
    CPluginRequest(const CPluginRequest& value);
    CPluginRequest& operator=(const CPluginRequest& value);

};



/////////////////// CPluginRequest inline methods

// constructor
inline
CPluginRequest::CPluginRequest(void)
{
}


/////////////////// end of CPluginRequest inline methods


END_objects_SCOPE // namespace ncbi::objects::

END_NCBI_SCOPE


/*
* ===========================================================================
*
* $Log: PluginRequest.hpp,v $
* Revision 1000.1  2003/11/05 15:24:56  gouriano
* PRODUCTION: UPGRADED [ORIGINAL] Dev-tree R1.6
*
* Revision 1.6  2003/11/04 17:14:05  dicuccio
* Added API to retrieve the command portion of the argument
*
* Revision 1.5  2003/05/19 13:33:02  dicuccio
* Moved gui/core/plugin --> gui/plugin/
*
* Revision 1.4  2003/04/16 18:18:10  dicuccio
* Renamed command retrieval functions to make them available for templates
*
* Revision 1.3  2003/02/24 13:00:18  dicuccio
* Renamed classes in plugin spec:
*     CArgSeg --> CPluginArgSet
*     CArgument --> CPluginArg
*     CPluginArgs --> CPluginCommand
*     CPluginCommands --> CPluginCommandSet
*
* Revision 1.2  2003/02/21 16:44:13  dicuccio
* Added Win32 export specifiers for new plugin library.  Fixed compilation
* issues for Win32.
*
* Revision 1.1  2003/02/20 19:44:06  dicuccio
* Created new plugin architecture, mediated via an ASN.1 spec.  Moved GBENCH
* framework over to use new plugin architecture.
*
*
* ===========================================================================
*/

#endif // GUI_CORE_PLUGIN_PLUGINREQUEST_HPP
/* Original file checksum: lines: 93, chars: 2467, CRC32: 3ad7a1c6 */