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

Go to the SVN repository for this file.

1 #ifndef GUI_UTILS___OBJECT_LOADER__HPP
2 #define GUI_UTILS___OBJECT_LOADER__HPP
3 
4 /* $Id: object_loader.hpp 38443 2017-05-10 15:49:30Z katargir $
5  * ===========================================================================
6  *
7  * PUBLIC DOMAIN NOTICE
8  * National Center for Biotechnology Information
9  *
10  * This software/database is a "United States Government Work" under the
11  * terms of the United States Copyright Act. It was written as part of
12  * the author's official duties as a United States Government employee and
13  * thus cannot be copyrighted. This software/database is freely available
14  * to the public for use. The National Library of Medicine and the U.S.
15  * Government have not placed any restriction on its use or reproduction.
16  *
17  * Although all reasonable efforts have been taken to ensure the accuracy
18  * and reliability of the software and data, the NLM and the U.S.
19  * Government do not and cannot warrant the performance or results that
20  * may be obtained by using this software or data. The NLM and the U.S.
21  * Government disclaim all warranties, express or implied, including
22  * warranties of performance, merchantability or fitness for any particular
23  * purpose.
24  *
25  * Please cite the author in any work or product based on this material.
26  *
27  * ===========================================================================
28  *
29  * Authors: Roman Katargin
30  *
31  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 #include <corelib/ncbiobj.hpp>
37 
39 
41 {
42 public:
43  virtual ~IObjectLoader() {}
44 
45  struct SObject
46  {
47  SObject() {}
48  SObject(CObject& obj, const string& desc)
49  : object(&obj), description(desc) {}
50  SObject(CObject& obj, const string& desc, const string& comm)
51  : object(&obj), description(desc), comment(comm) {}
52 
53  const string& GetDescription() const { return description; }
54  const string& GetComment() const { return comment; }
55  const CObject& GetObject() const { return *object; }
56  const CObject* GetObjectPtr() const { return object; }
57  CObject* GetObjectPtr() { return object; }
58 
59  const string& GetFileName() const { return fileName; }
60  void SetFileName(const string& f) { fileName = f; }
61 
62  private:
64  string description;
65  string comment;
66  string fileName;
67  };
68 
69  typedef vector<SObject> TObjects;
70 
71  virtual TObjects& GetObjects() = 0;
72  virtual string GetDescription() const = 0;
73 
74  virtual CObject* GetLoader() { return 0; }
75 };
76 
78 
79 
80 #endif // GUI_UTILS___OBJECT_LOADER__HPP
81 
CObject –.
Definition: ncbiobj.hpp:180
virtual CObject * GetLoader()
virtual TObjects & GetObjects()=0
virtual ~IObjectLoader()
vector< SObject > TObjects
virtual string GetDescription() const =0
Include a standard set of the NCBI C++ Toolkit most basic headers.
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Portable reference counted smart and weak pointers using CWeakRef, CRef, CObject and CObjectEx.
double f(double x_, const double &y_)
Definition: njn_root.hpp:188
const CObject & GetObject() const
const string & GetComment() const
SObject(CObject &obj, const string &desc, const string &comm)
const CObject * GetObjectPtr() const
const string & GetDescription() const
void SetFileName(const string &f)
CRef< CObject > object
const string & GetFileName() const
SObject(CObject &obj, const string &desc)
Modified on Fri Dec 01 04:46:00 2023 by modify_doxy.py rev. 669887