]> Creatis software - gdcm.git/blob - src/gdcmObject.h
e3be05aa2a031f2ab7c922a28418181b4490bc18
[gdcm.git] / src / gdcmObject.h
1 // gdcmObject.h
2 //-----------------------------------------------------------------------------
3 #ifndef GDCMOBJECT_H
4 #define GDCMOBJECT_H
5
6 #include <string>
7 #include <list>
8 #include "gdcmCommon.h"
9 #include "gdcmHeaderEntry.h"
10 #include "gdcmParser.h"
11 #include "gdcmDicomDirElement.h"
12 //-----------------------------------------------------------------------------
13 class gdcmObject;
14 typedef std::list<gdcmObject *> ListContent;
15
16 //-----------------------------------------------------------------------------
17 /**
18  * \ingroup gdcmObject
19  * \brief   Base object
20  */
21 class GDCM_EXPORT gdcmObject 
22 {
23 public:
24    /**
25     * \ingroup gdcmParser
26     * \brief   Sets the print level for the Dicom Header 
27     * \note    0 for Light Print; 1 for 'medium' Print, 2 for Heavy
28     */
29    void SetPrintLevel(int level) 
30       { printLevel = level; };
31    virtual void Print(std::ostream &os = std::cout);
32
33    std::string GetEntryByNumber(guint16 group, guint16 element);
34    std::string GetEntryByName(TagName name);
35    bool SetEntryByNumber(std::string val,guint16 group,guint16 element);
36    
37    TagHeaderEntryHT GetEntry(void);
38    ListTag GetListEntry(void);
39    
40    void ResetBoundaries(int flag);
41 /**
42  * \ingroup gdcmObject
43  * \brief   returns an iterator on the first Header Entry (i.e Dicom Element),
44  *          inside the DICOMDIR chained list,
45  *          related to this 'Object' 
46  * @return
47  */
48    ListTag::iterator debut(void) 
49       { return(beginObj);}
50    /**
51     * \ingroup gdcmObject
52     * \brief   returns an iterator on the last Header Entry (i.e Dicom Element),
53     *          inside the DICOMDIR chained list,
54     *          related to this 'Object' 
55     * @return
56     */
57     ListTag::iterator fin  (void) 
58        { return(endObj);  }
59
60 protected:
61  // constructor and destructor are protected to avoid end user to instanciate this class.
62    gdcmObject(ListTag::iterator begin,ListTag::iterator end,
63               TagHeaderEntryHT *ptagHT, ListTag *plistEntries); 
64    ~gdcmObject(void);
65
66
67    void FillObject(std::list<gdcmElement> elemList);
68
69 /**
70 * \brief iterator on the first Header Entry (i.e Dicom Element), 
71 *       inside the DICOMDIR chained list,
72 *       related to this 'Object'
73 */   
74    ListTag::iterator beginObj;
75 /**
76 * \brief iterator on the last Header Entry (i.e Dicom Element), 
77 *       inside the DICOMDIR chained list,
78 *       related to this 'Object'
79 */
80    ListTag::iterator endObj;
81 /**
82 * \brief pointer to the HTable of the gdcmParser,
83 *        (because we don't know it within any gdcmObject) 
84 */
85   TagHeaderEntryHT *ptagHT;
86 /**
87 * \brief pointer to the Chained List of the gdcmParser,
88 *        (because we don't know it within any gdcmObject)  
89 */  
90    ListTag *plistEntries;
91 /**
92 * \brief detail level to be printed
93 */   
94    int printLevel;
95    
96    /**
97    * \brief used to pass variables to FillObject function
98    *        Works as 'global' variable
99    */
100    std::list<gdcmHeaderEntry *>::iterator debInsertion, finInsertion, i,j;
101
102 private:
103
104 };
105
106 //-----------------------------------------------------------------------------
107 #endif