Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.h,v $
Language: C++
- Date: $Date: 2005/01/07 08:50:13 $
- Version: $Revision: 1.34 $
+ Date: $Date: 2005/01/20 16:17:00 $
+ Version: $Revision: 1.40 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
/**
+ * \brief
* \ref DocEntrySet is an abstract base class for \ref ElementSet
* and \ref SQItem which are both containers for DocEntries.
* \ref ElementSet is based on the STL map<> container
*/
class GDCM_EXPORT DocEntrySet : public Base
{
-friend class File;
+friend class FileHelper;
public:
DocEntrySet() {};
virtual ~DocEntrySet() {};
- /// \brief adds any type of entry to the entry set (pure vitual)
- virtual bool AddEntry(DocEntry *Entry) = 0; // pure virtual
- virtual bool RemoveEntry(DocEntry *EntryToRemove)=0; // pure virtual
- virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)=0; // pure virtual
+ // ------- '... =0;' stands for 'Pure Virtual'
+
+ /// \brief adds any type of entry to the entry set
+ virtual bool AddEntry(DocEntry *Entry) = 0;
+
+ /// \brief Removes any type of entry out of the entry set, and destroys it
+ virtual bool RemoveEntry(DocEntry *EntryToRemove)=0;
+
+ /// \brief Removes any type of entry out of the entry set, DOESN'T destroy it
+ virtual bool RemoveEntryNoDestroy(DocEntry *EntryToRemove)= 0;
/// \brief write any type of entry to the entry set
- virtual void WriteContent (std::ofstream *fp, FileType filetype) = 0;// pure virtual
+ virtual void WriteContent (std::ofstream *fp,
+ FileType filetype) = 0;
+
+ /// \brief Gets any type of DocEntry, identified by its (group,elem)
+ virtual DocEntry *GetDocEntry(uint16_t group,
+ uint16_t elem) = 0;
- virtual DocEntry *GetDocEntryByNumber(uint16_t group,
- uint16_t elem) = 0;
- virtual std::string GetEntryByNumber(uint16_t group, uint16_t elem) = 0;
+ /// \brief Gets a ValEntry, identified by its (group,elem)
+ virtual ValEntry *GetValEntry(uint16_t group,
+ uint16_t elem) = 0;
+ /// \brief Gets a BinEntry, identified by its (group,elem)
+ virtual BinEntry *GetBinEntry(uint16_t group,
+ uint16_t elem) = 0;
+
+ /// \brief Gets a SeqEntry, identified by its (group,elem)
+ virtual SeqEntry *GetSeqEntry(uint16_t group,
+ uint16_t elem) = 0;
+
+ /// \brief Gets the 'string value' of a ValEntry
+ /// identified by its (group,elem) - Sorry for the name !...-
+ virtual std::string GetEntry(uint16_t group, uint16_t elem) = 0;
DictEntry *NewVirtualDictEntry(uint16_t group,
- uint16_t element,
+ uint16_t elem,
TagName const &vr = GDCM_UNKNOWN,
- TagName const &fourth = GDCM_UNKNOWN,
+ TagName const &vm = GDCM_UNKNOWN,
TagName const &name = GDCM_UNKNOWN );
-
+
protected:
// DocEntry related utilities
- ValEntry *NewValEntryByNumber(uint16_t group,uint16_t elem,
- TagName const &vr = GDCM_UNKNOWN);
- BinEntry *NewBinEntryByNumber(uint16_t group,uint16_t elem,
- TagName const &vr = GDCM_UNKNOWN);
- SeqEntry *NewSeqEntryByNumber(uint16_t group,uint16_t elem);
+ ValEntry *NewValEntry(uint16_t group,uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN);
+ BinEntry *NewBinEntry(uint16_t group,uint16_t elem,
+ TagName const &vr = GDCM_UNKNOWN);
+ SeqEntry *NewSeqEntry(uint16_t group,uint16_t elem);
// DictEntry related utilities
- DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t elem);
- DictEntry *GetDictEntryByNumber(uint16_t group, uint16_t elem,
- TagName const &vr);
+ DictEntry *GetDictEntry(uint16_t group, uint16_t elem);
+ DictEntry *GetDictEntry(uint16_t group, uint16_t elem,
+ TagName const &vr);
};
} // end namespace gdcm