Program: gdcm
Module: $RCSfile: gdcmHeaderHelper.h,v $
Language: C++
- Date: $Date: 2004/06/21 21:51:01 $
- Version: $Revision: 1.18 $
+ Date: $Date: 2004/10/12 04:35:46 $
+ Version: $Revision: 1.22 $
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
#include "gdcmHeader.h"
+namespace gdcm
+{
+
//-----------------------------------------------------------------------------
/*
- * \defgroup gdcmSerieHeader
+ * \defgroup SerieHeader
* \brief
*
* - This class should be used for a stack of 2D dicom images.
- * - For a multiframe dicom image better use directly gdcmHeaderHelper
+ * - For a multiframe dicom image better use directly HeaderHelper
*/
-class GDCM_EXPORT gdcmSerieHeader {
+class GDCM_EXPORT SerieHeader
+{
public:
- gdcmSerieHeader() {};
- ~gdcmSerieHeader();
+ SerieHeader();
+ ~SerieHeader();
- void AddFileName(std::string filename); //should return bool or throw error ?
- void AddGdcmFile(gdcmHeader *file);
- void SetDirectory(std::string dir);
+ /// \todo should return bool or throw error ?
+ void AddFileName(std::string const & filename);
+ void AddGdcmFile(Header *file);
+ void SetDirectory(std::string const & dir);
void OrderGdcmFileList();
- inline gdcmHeader *GetGdcmHeader()
- {
- //Assume all element in the list have the same global infos
- return CoherentGdcmFileList.front();
- }
-
- std::list<gdcmHeader*>& GetGdcmFileList();
+ /// \warning Assumes all elements in the list have the same global infos.
+ /// Assumes the list is not empty.
+ Header* GetGdcmHeader() { return CoherentGdcmFileList.front(); }
+
+ typedef std::list<Header* > GdcmHeaderList;
+
+ /// \brief Gets the *coherent* File List
+ /// @return the *coherent* File List
+ const GdcmHeaderList& GetGdcmFileList() { return CoherentGdcmFileList; }
private:
bool ImagePositionPatientOrdering();
bool ImageNumberOrdering();
bool FileNameOrdering();
- std::list<gdcmHeader*> CoherentGdcmFileList;
+ GdcmHeaderList CoherentGdcmFileList;
};
+} // end namespace gdcm
+
//-----------------------------------------------------------------------------
#endif