Program: gdcm
Module: $RCSfile: gdcmSQItem.h,v $
Language: C++
- Date: $Date: 2004/08/01 00:59:22 $
- Version: $Revision: 1.13 $
+ Date: $Date: 2005/02/07 08:48:18 $
+ Version: $Revision: 1.41 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
#ifndef GDCMSQITEM_H
#define GDCMSQITEM_H
-#include <list>
-#include "gdcmDocEntry.h"
#include "gdcmDocEntrySet.h"
-#include "gdcmDocument.h"
+#include "gdcmElementSet.h"
+#include <list>
+#include <fstream>
-class gdcmBinEntry;
+namespace gdcm
+{
+class DocEntry;
//-----------------------------------------------------------------------------
-typedef std::list<gdcmDocEntry *> ListDocEntry;
+typedef std::list<DocEntry *> ListDocEntry;
+
//-----------------------------------------------------------------------------
-class GDCM_EXPORT gdcmSQItem : public gdcmDocEntrySet
+/**
+ * \brief a SeqEntry is composed by a set of SQItems.
+ * Each SQItem is composed by a set of DocEntry
+ * A DocEntry may be a SeqEntry
+ * ... and so forth
+ */
+class GDCM_EXPORT SQItem : public DocEntrySet
{
public:
- gdcmSQItem(int);
- ~gdcmSQItem();
-
- virtual void Print(std::ostream &os = std::cout);
- virtual void Write(FILE *fp, FileType filetype);
+ SQItem(int depthLevel);
+ ~SQItem();
- /// \brief returns the DocEntry chained List for this SQ Item.
- ListDocEntry &GetDocEntries() { return docEntries; };
-
- /// \brief adds the passed DocEntry to the DocEntry chained List for
- /// this SQ Item.
- void AddDocEntry(gdcmDocEntry *e) { docEntries.push_back(e); };
+ virtual void Print(std::ostream &os = std::cout, std::string const &indent = "" );
+ void WriteContent(std::ofstream *fp, FileType filetype);
- virtual bool AddEntry(gdcmDocEntry *Entry); // add to the List
+ bool AddEntry(DocEntry *Entry); // add to the List
+ bool RemoveEntry(DocEntry *EntryToRemove);
+ bool RemoveEntryNoDestroy(DocEntry *EntryToRemove);
+ void ClearEntry();
- gdcmDocEntry *GetDocEntryByNumber(uint16_t group, uint16_t element);
- // FIXME method to write
- //gdcmDocEntry *GetDocEntryByName (std::string Name);
-
- bool SetEntryByNumber(std::string val, uint16_t group, uint16_t element);
-
- virtual std::string GetEntryByNumber(uint16_t group, uint16_t element);
+ DocEntry *GetFirstEntry();
+ DocEntry *GetNextEntry();
- int GetSQItemNumber() { return SQItemNumber; };
+ DocEntry *GetDocEntry(uint16_t group, uint16_t elem);
+
+ bool IsEmpty() { return DocEntries.empty(); };
+ /// \brief returns the ordinal position of a given SQItem
+ int GetSQItemNumber() { return SQItemNumber; };
+ /// \brief Sets the ordinal position of a given SQItem
void SetSQItemNumber(int itemNumber) { SQItemNumber = itemNumber; };
-protected:
+ /// \brief Accessor on \ref SQDepthLevel.
+ int GetDepthLevel() { return SQDepthLevel; }
-// Variables
+ /// \brief Accessor on \ref SQDepthLevel.
+ void SetDepthLevel(int depth) { SQDepthLevel = depth; }
- /// \brief chained list of (Elementary) Doc Entries
- ListDocEntry docEntries;
-
- /// \brief SQ Item ordinal number
- int SQItemNumber;
+ /// \brief Accessor on \ref BaseTagKey.
+ void SetBaseTagKey( BaseTagKey const &key ) { BaseTagKeyNested = key; }
- ///\brief pointer to the HTable of the gdcmDocument,
- /// (because we don't know it within any gdcmObject nor any gdcmSQItem)
- TagDocEntryHT *PtagHT;
-
+ /// \brief Accessor on \ref BaseTagKey.
+ BaseTagKey const &GetBaseTagKey() const { return BaseTagKeyNested; }
+
+protected:
+// Variables that need to be accessed in subclasses
+ /// \brief Chained list of Doc Entries
+ ListDocEntry DocEntries;
+ /// Iterator, used to visit the entries
+ ListDocEntry::iterator ItDocEntries;
+ /// Iterator, used to visit the Val Entries (for Python users)
+ ListDocEntry::iterator ItValEntries;
+
private:
+ /// \brief Sequences can be nested. This \ref SQDepthLevel represents
+ /// the level of the nesting of instances of this class.
+ /// \ref SQDepthLevel and its \ref SeqEntry::SQDepthLevel
+ /// counterpart are only defined on printing purposes
+ /// (see \ref Print).
+ int SQDepthLevel;
+ /// \brief A TagKey of a DocEntry nested in a sequence is prepended
+ /// with this BaseTagKey.
+ BaseTagKey BaseTagKeyNested;
+ /// \brief SQ Item ordinal number
+ int SQItemNumber;
};
-
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif