NCBI C++ ToolKit
PluginReply.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id: PluginReply.hpp 14666 2007-07-09 13:40:22Z dicuccio $
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  * Author: .......
27  *
28  * File Description:
29  * .......
30  *
31  * Remark:
32  * This code was originally generated by application DATATOOL
33  * using specifications from the data definition file
34  * 'plugin.asn'.
35  */
36 
37 #ifndef GUI_PLUGIN_PLUGINREPLY_HPP
38 #define GUI_PLUGIN_PLUGINREPLY_HPP
39 
40 
41 // generated includes
44 #include <gui/objutils/objects.hpp>
45 
46 // generated classes
47 
49 
50 BEGIN_objects_SCOPE /// namespace ncbi::objects::
51 
52 class CGBProjectHandle;
53 
54 
56 {
58 public:
59  /// constructor
60  CPluginReply(void);
61  /// destructor
62  ~CPluginReply(void);
63 
64  /// add an action to be undertaken when processing this reply
65  void AddAction(CPluginReplyAction::E_Choice choice,
66  const string& opts = "");
67 
68  /// add an object to this reply's raw object list
69  void AddObject(const CObject& object, const CGBProjectHandle* project = NULL);
70 
71  /// add a document to the reply's raw object list.
72  void AddObject(const CGBProjectHandle& project);
73 
74  /// Create a set of object-scope pairs for the raw reply
75  TConstScopedObjects DecomposeRaw() const;
76 
77 private:
78  /// Prohibit copy constructor and assignment operator
81 
82 };
83 
84 
85 
86 /////////////////// CPluginReply inline methods
87 
88 // constructor
89 inline
91 {
92 }
93 
94 
95 /////////////////// end of CPluginReply inline methods
96 
97 
98 END_objects_SCOPE /// namespace ncbi::objects::
99 
101 
102 #endif /// GUI_PLUGIN_PLUGINREPLY_HPP
103 /* Original file checksum: lines: 93, chars: 2435, CRC32: 4690fea4 */
User-defined methods of the data storage class.
Data storage class.
CObject –.
Definition: ncbiobj.hpp:180
CPluginReply_Base Tparent
Definition: PluginReply.hpp:57
CPluginReply & operator=(const CPluginReply &value)
CPluginReply(const CPluginReply &value)
Prohibit copy constructor and assignment operator.
CPluginReply(void)
constructor
Definition: PluginReply.hpp:90
#define NULL
Definition: ncbistd.hpp:225
vector< SConstScopedObject > TConstScopedObjects
Definition: objects.hpp:65
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_GUIOBJECTS_EXPORT
Definition: gui_export.h:511
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Modified on Wed Apr 17 13:10:01 2024 by modify_doxy.py rev. 669887