usModule.h

Go to the documentation of this file.

/*============================================================================
 
The Medical Imaging Interaction Toolkit (MITK)
 
Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.
 
Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.
 
============================================================================*/
 
 
#ifndef USMODULE_H
#define USMODULE_H
 
#include <usModuleVersion.h>
 
#include <vector>
 
namespace us {
 
class Any;
class CoreModuleContext;
struct ModuleInfo;
class ModuleContext;
class ModuleResource;
class ModulePrivate;
 
template<class S>
class ServiceReference;
 
typedef ServiceReference<void> ServiceReferenceU;
 
class MITKCPPMICROSERVICES_EXPORT Module
{
 
public:
 
  static const std::string& PROP_ID();
 
  static const std::string& PROP_NAME();
 
  static const std::string& PROP_LOCATION();
 
  static const std::string& PROP_VERSION();
 
  static const std::string& PROP_VENDOR();
 
  static const std::string& PROP_DESCRIPTION();
 
  static const std::string& PROP_AUTOLOAD_DIR();
 
  static const std::string& PROP_AUTOLOADED_MODULES();
 
  ~Module();
 
  bool IsLoaded() const;
 
  ModuleContext* GetModuleContext() const;
 
  long GetModuleId() const;
 
  std::string GetLocation() const;
 
  std::string GetName() const;
 
  ModuleVersion GetVersion() const;
 
  Any GetProperty(const std::string& key) const;
 
  std::vector<std::string> GetPropertyKeys() const;
 
  std::vector<ServiceReferenceU> GetRegisteredServices() const;
 
  std::vector<ServiceReferenceU> GetServicesInUse() const;
 
  ModuleResource GetResource(const std::string& path) const;
 
  std::vector<ModuleResource> FindResources(const std::string& path, const std::string& filePattern, bool recurse) const;
 
private:
 
  friend class CoreModuleActivator;
  friend class ModuleRegistry;
  friend class ServiceReferencePrivate;
 
  ModulePrivate* d;
 
  Module();
 
  void Init(CoreModuleContext* coreCtx, ModuleInfo* info);
  void Uninit();
 
  void Start();
  void Stop();
 
  // purposely not implemented
  Module(const Module &);
  Module& operator=(const Module&);
 
};
 
}
 
MITKCPPMICROSERVICES_EXPORT std::ostream& operator<<(std::ostream& os, const us::Module& module);
MITKCPPMICROSERVICES_EXPORT std::ostream& operator<<(std::ostream& os, us::Module const * module);
 
#endif // USMODULE_H