irods  4.2.8
About: iRODS (the integrated Rule Oriented Data System) is a distributed data-management system for creating data grids, digital libraries, persistent archives, and real-time data systems.
  Fossies Dox: irods-4.2.8.tar.gz  ("unofficial" and yet experimental doxygen-generated source code documentation)  

irods_generic_database_object.hpp
Go to the documentation of this file.
1 #ifndef __IRODS_GENERIC_DATABASE_OBJECT_HPP__
2 #define __IRODS_GENERIC_DATABASE_OBJECT_HPP__
3 
4 // =-=-=-=-=-=-=-
5 // irods includes
7 
8 // =-=-=-=-=-=-=-
9 // boost includes
10 #include <boost/shared_ptr.hpp>
11 
12 namespace irods {
13 
14 
15 // =-=-=-=-=-=-=-
16 // @brief generic database object class
18  public:
19  // =-=-=-=-=-=-=-
20  // Constructors
21  explicit generic_database_object(const std::string &);
23 
24  // =-=-=-=-=-=-=-
25  // Destructors
26  virtual ~generic_database_object();
27 
28  // =-=-=-=-=-=-=-
29  // Operators
31 
32  // =-=-=-=-=-=-=-
34  virtual bool operator==( const generic_database_object& _rhs ) const;
35 
36  // =-=-=-=-=-=-=-
37  // plugin resolution operation
38  virtual error resolve(
39  const std::string&, // plugin interface
40  plugin_ptr& ); // resolved plugin
41 
42  // =-=-=-=-=-=-=-
43  // accessor for rule engine variables
45 
46  // =-=-=-=-=-=-=-
47  // Accessors
48 
49  // =-=-=-=-=-=-=-
50  // Mutators
51 
52  private:
53  // =-=-=-=-=-=-=-
54  // Attributes
55  std::string type_;
56  }; // generic_database_object
57 
58 // =-=-=-=-=-=-=-
59 // helpful typedef for sock comm interface & factory
60  typedef boost::shared_ptr< generic_database_object > generic_database_object_ptr;
61 
62 }; // namespace irods
63 
64 #endif // __IRODS_GENERIC_DATABASE_OBJECT_HPP__
65 
66 
67 
irods::plugin_ptr
boost::shared_ptr< plugin_base > plugin_ptr
Definition: irods_first_class_object.hpp:18
irods::generic_database_object::get_re_vars
virtual error get_re_vars(rule_engine_vars_t &)
Definition: irods_generic_database_object.cpp:101
irods::generic_database_object::type_
std::string type_
Definition: irods_generic_database_object.hpp:55
irods::generic_database_object::operator=
virtual generic_database_object & operator=(const generic_database_object &)
Definition: irods_generic_database_object.cpp:29
irods::generic_database_object::generic_database_object
generic_database_object(const std::string &)
Definition: irods_generic_database_object.cpp:10
irods::generic_database_object::resolve
virtual error resolve(const std::string &, plugin_ptr &)
Definition: irods_generic_database_object.cpp:46
irods
Definition: apiHandler.hpp:35
irods_database_object.hpp
irods::generic_database_object
Definition: irods_generic_database_object.hpp:17
irods::generic_database_object::~generic_database_object
virtual ~generic_database_object()
Definition: irods_generic_database_object.cpp:24
irods::generic_database_object::operator==
virtual bool operator==(const generic_database_object &_rhs) const
Definition: irods_generic_database_object.cpp:38
irods::error
Definition: irods_error.hpp:23
irods::database_object
Definition: irods_database_object.hpp:19
irods::rule_engine_vars_t
std::map< std::string, std::string > rule_engine_vars_t
Definition: irods_first_class_object.hpp:20
irods::generic_database_object_ptr
boost::shared_ptr< generic_database_object > generic_database_object_ptr
Definition: irods_generic_database_object.hpp:60