usModuleResource.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 USMODULERESOURCE_H
#define USMODULERESOURCE_H
 
#include <usGlobalConfig.h>
#include <MitkCppMicroServicesExports.h>
 
#include <ostream>
#include <vector>
 
US_MSVC_PUSH_DISABLE_WARNING(4396)
 
namespace us {
 
class ModuleResourcePrivate;
class ModuleResourceContainer;
 
class MITKCPPMICROSERVICES_EXPORT ModuleResource
{
 
private:
 
  typedef ModuleResourcePrivate* ModuleResource::*bool_type;
 
public:
 
  ModuleResource();
  ModuleResource(const ModuleResource& resource);
 
  ~ModuleResource();
 
  ModuleResource& operator=(const ModuleResource& resource);
 
  bool operator<(const ModuleResource& resource) const;
 
  bool operator==(const ModuleResource& resource) const;
 
  bool operator!=(const ModuleResource& resource) const;
 
  bool IsValid() const;
 
  operator bool_type() const;
 
  std::string GetName() const;
 
  std::string GetPath() const;
 
  std::string GetResourcePath() const;
 
  std::string GetBaseName() const;
 
  std::string GetCompleteBaseName() const;
 
  std::string GetSuffix() const;
 
  std::string GetCompleteSuffix() const;
 
  bool IsDir() const;
 
  bool IsFile() const;
 
  std::vector<std::string> GetChildren() const;
 
  std::vector<ModuleResource> GetChildResources() const;
 
  int GetSize() const;
 
  time_t GetLastModified() const;
 
private:
 
  ModuleResource(const std::string& file, const ModuleResourceContainer& resourceContainer);
  ModuleResource(int index, const ModuleResourceContainer& resourceContainer);
 
  friend class Module;
  friend class ModulePrivate;
  friend class ModuleResourceContainer;
  friend class ModuleResourceStream;
 
  friend struct std::hash<ModuleResource>;
 
  std::size_t Hash() const;
 
  void* GetData() const;
 
  ModuleResourcePrivate* d;
 
};
 
}
 
US_MSVC_POP_WARNING
 
MITKCPPMICROSERVICES_EXPORT std::ostream& operator<<(std::ostream& os, const us::ModuleResource& resource);
 
namespace std {
template<> struct hash<us::ModuleResource> { std::size_t operator()(const us::ModuleResource& arg) const {
  return arg.Hash();
} };
}
 
#endif // USMODULERESOURCE_H