gdcmModule.h
Go to the documentation of this file.
/*=========================================================================
Program: GDCM (Grassroots DICOM). A DICOM library
Copyright (c) 2006-2011 Mathieu Malaterre
All rights reserved.
See Copyright.txt or http://gdcm.sourceforge.net/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
#ifndef GDCMMODULE_H
#define GDCMMODULE_H
#include "gdcmTypes.h"
#include "gdcmTag.h"
#include "gdcmModuleEntry.h"
#include <map>
#include <vector>
namespace gdcm
{
class DataSet;
class Usage;
class Macros;
class GDCM_EXPORT Module
{
public:
typedef std::map<Tag, ModuleEntry> MapModuleEntry;
typedef std::vector<std::string> ArrayIncludeMacrosType;
//typedef MapModuleEntry::const_iterator ConstIterator;
//typedef MapModuleEntry::iterator Iterator;
//ConstIterator Begin() const { return ModuleInternal.begin(); }
//Iterator Begin() { return ModuleInternal.begin(); }
//ConstIterator End() const { return ModuleInternal.end(); }
//Iterator End() { return ModuleInternal.end(); }
Module() = default;
friend std::ostream& operator<<(std::ostream& _os, const Module &_val);
void Clear() { ModuleInternal.clear(); }
void AddModuleEntry(const Tag& tag, const ModuleEntry & module)
{
ModuleInternal.insert(
MapModuleEntry::value_type(tag, module));
}
void AddMacro(const char *include)
{
ArrayIncludeMacros.push_back( include );
}
bool FindModuleEntryInMacros(Macros const &macros, const Tag &tag) const;
const ModuleEntry& GetModuleEntryInMacros(Macros const &macros, const Tag &tag) const;
void SetName( const char *name) { Name = name; }
const char *GetName() const { return Name.c_str(); }
// Verify will print on std::cerr for error
// Upon success will return true, false otherwise
bool Verify(const DataSet& ds, Usage const & usage) const;
private:
//Module &operator=(const Module &_val); // purposely not implemented
//Module(const Module &_val); // purposely not implemented
MapModuleEntry ModuleInternal;
std::string Name;
ArrayIncludeMacrosType ArrayIncludeMacros;
};
//-----------------------------------------------------------------------------
inline std::ostream& operator<<(std::ostream& _os, const Module &_val)
{
_os << _val.Name << '\n';
Module::MapModuleEntry::const_iterator it = _val.ModuleInternal.begin();
for(;it != _val.ModuleInternal.end(); ++it)
{
const Tag &t = it->first;
const ModuleEntry &de = it->second;
_os << t << " " << de << '\n';
}
return _os;
}
} // end namespace gdcm
#endif //GDCMMODULE_H
gdcm::DataSet
Class to represent a Data Set (which contains Data Elements).
Definition gdcmDataSet.h:56
gdcm::Macros
Class for representing a Modules.
Definition gdcmMacros.h:30
gdcm::ModuleEntry
Class for representing a ModuleEntry.
Definition gdcmModuleEntry.h:30
gdcm::Module::Verify
bool Verify(const DataSet &ds, Usage const &usage) const
gdcm::Module::Module
Module()=default
gdcm::Module::Clear
void Clear()
Definition gdcmModule.h:53
gdcm::Module::AddModuleEntry
void AddModuleEntry(const Tag &tag, const ModuleEntry &module)
Will add a ModuleEntry directly at root-level. See Macro for nested-included level.
Definition gdcmModule.h:56
gdcm::Module::AddMacro
void AddMacro(const char *include)
Definition gdcmModule.h:62
gdcm::Module::operator<<
friend std::ostream & operator<<(std::ostream &_os, const Module &_val)
Definition gdcmModule.h:88
gdcm::Module::SetName
void SetName(const char *name)
Definition gdcmModule.h:72
gdcm::Module::FindModuleEntryInMacros
bool FindModuleEntryInMacros(Macros const &macros, const Tag &tag) const
gdcm::Module::GetModuleEntryInMacros
const ModuleEntry & GetModuleEntryInMacros(Macros const &macros, const Tag &tag) const
gdcm::Module::ArrayIncludeMacrosType
std::vector< std::string > ArrayIncludeMacrosType
Definition gdcmModule.h:41
gdcm::Module::GetName
const char * GetName() const
Definition gdcmModule.h:73
gdcm::Module::MapModuleEntry
std::map< Tag, ModuleEntry > MapModuleEntry
Definition gdcmModule.h:40
gdcm::Tag
Class to represent a DICOM Data Element (Attribute) Tag (Group, Element).
Definition gdcmTag.h:39
gdcm::Usage
Usage.
Definition gdcmUsage.h:49
gdcmModuleEntry.h
gdcmTag.h
gdcmTypes.h
GDCM_EXPORT
#define GDCM_EXPORT
Definition gdcmWin32.h:34
gdcm
Definition gdcmASN1.h:21
gdcm::operator<<
std::ostream & operator<<(std::ostream &os, const Directory &d)
Definition gdcmDirectory.h:88