]> Creatis software - gdcm.git/blob - src/gdcmObject.h
Fix warnings, add a GDCM_DATA_ROOT to CMake
[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    virtual ~gdcmObject(void);
65
66    void FillObject(std::list<gdcmElement> elemList);
67
68 /**
69 * \brief iterator on the first Header Entry (i.e Dicom Element), 
70 *       inside the DICOMDIR chained list,
71 *       related to this 'Object'
72 */   
73    ListTag::iterator beginObj;
74 /**
75 * \brief iterator on the last Header Entry (i.e Dicom Element), 
76 *       inside the DICOMDIR chained list,
77 *       related to this 'Object'
78 */
79    ListTag::iterator endObj;
80 /**
81 * \brief pointer to the HTable of the gdcmParser,
82 *        (because we don't know it within any gdcmObject) 
83 */
84   TagHeaderEntryHT *ptagHT;
85 /**
86 * \brief pointer to the Chained List of the gdcmParser,
87 *        (because we don't know it within any gdcmObject)  
88 */  
89    ListTag *plistEntries;
90 /**
91 * \brief detail level to be printed
92 */   
93    int printLevel;
94    
95    /**
96    * \brief used to pass variables to FillObject function
97    *        Works as 'global' variable
98    */
99    std::list<gdcmHeaderEntry *>::iterator debInsertion, finInsertion, i,j;
100
101 private:
102
103 };
104
105 //-----------------------------------------------------------------------------
106 #endif