-remove InitTraversal method.
Program: gdcm
Module: $RCSfile: gdcmDicomDir.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.103 $
+ Date: $Date: 2005/01/18 07:53:41 $
+ Version: $Revision: 1.104 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
// Constructor / Destructor
/**
- * \ingroup DicomDir
* \brief Constructor : creates an empty DicomDir
*/
DicomDir::DicomDir()
/**
- * \ingroup DicomDir
* \brief fills the whole structure, starting from a root Directory
*/
void DicomDir::ParseDirectory()
}
/**
- * \ingroup DicomDir
* \brief Set the start method to call when the parsing of the
* directory starts.
* @param method Method to call
}
/**
- * \ingroup DicomDir
* \brief Set the method to delete the argument
* The argument is destroyed when the method is changed or when the
* class is destroyed
}
/**
- * \ingroup DicomDir
* \brief Set the progress method to call when the parsing of the
* directory progress
* @param method Method to call
}
/**
- * \ingroup DicomDir
* \brief Set the method to delete the argument
* The argument is destroyed when the method is changed or when the
* class is destroyed
}
/**
- * \ingroup DicomDir
* \brief Set the end method to call when the parsing of the directory ends
* @param method Method to call
* @param arg Argument to pass to the method
}
/**
- * \ingroup DicomDir
* \brief Set the method to delete the argument
* The argument is destroyed when the method is changed or when
* the class is destroyed
}
/**
- * \ingroup DicomDir
* \brief writes on disc a DICOMDIR
* \ warning does NOT add the missing elements in the header :
* it's up to the user doing it !
// Protected
/**
- * \ingroup DicomDir
* \brief create a Document-like chained list from a root Directory
* @param path entry point of the tree-like structure
*/
}
/**
- * \ingroup DicomDir
* \brief adds *the* Meta to a partially created DICOMDIR
*/
//-----------------------------------------------------------------------------
/**
- * \ingroup DicomDir
* \brief CallProgressMethod
*/
void DicomDir::CallProgressMethod()
//-----------------------------------------------------------------------------
/**
- * \ingroup DicomDir
* \brief CallEndMethod
*/
void DicomDir::CallEndMethod()
//-----------------------------------------------------------------------------
// Private
/**
- * \ingroup DicomDir
* \brief create a 'DicomDir' from a DICOMDIR Header
*/
void DicomDir::CreateDicomDir()
}
/**
- * \ingroup DicomDir
* \brief Well ... there is only one occurence
*/
bool DicomDir::AddDicomDirMeta()
}
/**
- * \ingroup DicomDir
* \brief AddDicomDirPatientToEnd
* @param dd SQ Item to enqueue to the DicomPatient chained List
*/
}
/**
- * \ingroup DicomDir
* \brief AddDicomDirStudyToEnd
* @param dd SQ Item to enqueue to the DicomDirStudy chained List
*/
}
/**
- * \ingroup DicomDir
* \brief AddDicomDirSerieToEnd
* @param dd SQ Item to enqueue to the DicomDirSerie chained List
*/
}
/**
- * \ingroup DicomDir
* \brief AddDicomDirImageToEnd
* @param dd SQ Item to enqueue to the DicomDirImage chained List
*/
}
/**
- * \ingroup DicomDir
* \brief for each Header of the chained list, add/update the Patient/Study/Serie/Image info
* @param path path of the root directory
* @param list chained list of Headers
}
/**
- * \ingroup DicomDir
* \brief Move the content of the src SQItem to the dst SQItem
* Only DocEntry's are moved
*
}
/**
- * \ingroup DicomDir
* \brief compares two dgcmHeaders
*/
bool DicomDir::HeaderLessThan(Document *header1, Document *header2)
return *header1 < *header2;
}
+
/**
- * \brief Initialise the visit of the DicomDirPatients of the DicomDir
- */
-void DicomDir::InitTraversal()
+ * \brief Get the first entry while visiting the DicomDirPatients
+ * \return The next DicomDirPatient if found, otherwhise NULL
+ */
+DicomDirPatient *DicomDir::GetFirstEntry()
{
ItDicomDirPatient = Patients.begin();
+ return *ItDicomDirPatient;
}
/**
* \brief Get the next entry while visiting the DicomDirPatients
+ * \note : meaningfull only if GetFirstEntry already called
* \return The next DicomDirPatient if found, otherwhise NULL
*/
DicomDirPatient *DicomDir::GetNextEntry()
Program: gdcm
Module: $RCSfile: gdcmDicomDir.h,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.47 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.48 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
DicomDirMeta* GetDicomDirMeta() { return MetaElems; };
// should avoid exposing internal mechanism
- void InitTraversal();
+ DicomDirPatient *GetFirstEntry();
DicomDirPatient *GetNextEntry();
/// Parsing
Program: gdcm
Module: $RCSfile: gdcmDicomDirElement.cxx,v $
Language: C++
- Date: $Date: 2005/01/07 22:03:30 $
- Version: $Revision: 1.26 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.27 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
}
/**
- * \ingroup DicomDirElement
* \brief canonical destructor
*/
DicomDirElement::~DicomDirElement()
//-----------------------------------------------------------------------------
// Print
/**
- * \ingroup DicomDirElement
* \brief Print all
* \todo add a 'Print Level' check
* @param os The output stream to be written to.
//-----------------------------------------------------------------------------
// Public
+/**
+ * \brief AddNewEntry
+ * @param type type
+ * @param elem elem
+ */
bool DicomDirElement::AddNewEntry(std::string const &type,
Element const &elem)
{
Program: gdcm
Module: $RCSfile: gdcmDicomDirImage.cxx,v $
Language: C++
- Date: $Date: 2005/01/16 04:50:41 $
- Version: $Revision: 1.16 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.17 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
// Constructor / Destructor
/**
- * \ingroup DicomDirImage
* \brief Constructor
*/
DicomDirImage::DicomDirImage():
{
}
/**
- * \ingroup DicomDirImage
* \brief Canonical destructor.
*/
DicomDirImage::~DicomDirImage()
//-----------------------------------------------------------------------------
// Print
/**
- * \ingroup DicomDirImage
* \brief Prints the Object
+ * @param os ostream to write to
* @return
*/
void DicomDirImage::Print(std::ostream &os, std::string const & )
Program: gdcm
Module: $RCSfile: gdcmDicomDirMeta.cxx,v $
Language: C++
- Date: $Date: 2005/01/16 04:50:41 $
- Version: $Revision: 1.21 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ 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
// Constructor / Destructor
/**
- * \ingroup DicomDirMeta
* \brief Constructor
*/
DicomDirMeta::DicomDirMeta():
}
/**
- * \ingroup DicomDirMeta
* \brief Canonical destructor.
*/
DicomDirMeta::~DicomDirMeta()
// Print
/**
* \brief Prints the Meta Elements
+ * @param os ostream to write to
*/
void DicomDirMeta::Print(std::ostream &os, std::string const & )
{
/**
* \brief Writes the Meta Elements
+ * @param fp ofstream to write to
+ * @param t File Type
* @return
*/
void DicomDirMeta::WriteContent(std::ofstream *fp, FileType t)
Program: gdcm
Module: $RCSfile: gdcmDicomDirPatient.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.25 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.26 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
}
/**
- * \brief Initialise the visit of the DicomDirPatients
- */
-void DicomDirPatient::InitTraversal()
+ * \brief Get the first entry while visiting the DicomDirStudy
+ * \return The first DicomDirStudy if found, otherwhise NULL
+ */
+DicomDirStudy *DicomDirPatient::GetFirstEntry()
{
ItDicomDirStudy = Studies.begin();
+ return *ItDicomDirStudy;
}
/**
* \brief Get the next entry while visiting the DicomDirStudies
+ * \note : meaningfull only if GetFirstEntry already called
* \return The next DicomDirStudies if found, otherwhise NULL
*/
DicomDirStudy *DicomDirPatient::GetNextEntry()
Program: gdcm
Module: $RCSfile: gdcmDicomDirPatient.h,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.19 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.20 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
void Print(std::ostream &os = std::cout, std::string const & indent = "" );
void WriteContent(std::ofstream *fp, FileType t);
-
- // TODO Remove GetDicomDirStudies
- // use InitTraversal + GetNextEntry instead.
/// Returns the STUDY chained List for this PATIENT.
ListDicomDirStudy const &GetDicomDirStudies() const { return Studies; };
// should avoid exposing internal mechanism
- void InitTraversal();
+ DicomDirStudy *GetFirstEntry();
DicomDirStudy *GetNextEntry();
/// adds the passed STUDY to the STUDY chained List for this PATIENT.
Program: gdcm
Module: $RCSfile: gdcmDicomDirSerie.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.27 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.28 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
}
/**
- * \brief Initialise the visit of the Images
+ * \brief Get the first entry while visiting the DicomDirImage
+ * \return The first DicomDirImage if found, otherwhise NULL
*/
-void DicomDirSerie::InitTraversal()
+DicomDirImage *DicomDirSerie::GetFirstEntry()
{
ItDicomDirImage = Images.begin();
+ return *ItDicomDirImage;
}
/**
* \brief Get the next entry while visiting the DicomDirImages
+ * \note : meaningfull only if GetFirstEntry already called
* \return The next DicomDirImages if found, otherwhise NULL
*/
DicomDirImage *DicomDirSerie::GetNextEntry()
Program: gdcm
Module: $RCSfile: gdcmDicomDirSerie.h,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.20 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.21 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
void Print( std::ostream &os = std::cout, std::string const & indent = "" );
void WriteContent( std::ofstream *fp, FileType t );
-
- // TODO Remove GetDicomDirImages
- // use InitTraversal + GetNextEntry instead.
/// Returns the IMAGE chained List for this SERIE.
ListDicomDirImage const &GetDicomDirImages() const { return Images; };
// should avoid exposing internal mechanism
- void InitTraversal();
+ DicomDirImage *GetFirstEntry();
DicomDirImage *GetNextEntry();
/// adds the passed IMAGE to the IMAGE chained List for this SERIE.
Program: gdcm
Module: $RCSfile: gdcmDicomDirStudy.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.24 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.25 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
{
}
/**
- * \ingroup DicomDirStudy
* \brief Canonical destructor.
*/
DicomDirStudy::~DicomDirStudy()
return st;
}
-/**
- * \brief Initialise the visit of the Series
+ /**
+ * \brief Get the first entry while visiting the DicomDirSeries
+ * \return The first DicomDirSerie if found, otherwhise NULL
*/
-void DicomDirStudy::InitTraversal()
+DicomDirSerie *DicomDirStudy::GetFirstEntry()
{
ItDicomDirSerie = Series.begin();
+ return *ItDicomDirSerie;
}
/**
* \brief Get the next entry while visiting the DicomDirSeries
- * \return The next DicomDirSeries if found, otherwhise NULL
+ * \note : meaningfull only if GetFirstEntry already called
+ * \return The next DicomDirSerie if found, otherwhise NULL
*/
DicomDirSerie *DicomDirStudy::GetNextEntry()
{
Program: gdcm
Module: $RCSfile: gdcmDicomDirStudy.h,v $
Language: C++
- Date: $Date: 2005/01/17 10:59:52 $
- Version: $Revision: 1.18 $
+ Date: $Date: 2005/01/18 07:53:42 $
+ Version: $Revision: 1.19 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
void Print(std::ostream &os = std::cout, std::string const & indent = "" );
void WriteContent(std::ofstream *fp, FileType t);
- // TODO Remove GetDicomDirSeries
- // use InitTraversal + GetNextEntry instead.
-
/// Returns the SERIE chained List for this STUDY.
ListDicomDirSerie const &GetDicomDirSeries() const { return Series; };
// should avoid exposing internal mechanism
- void InitTraversal();
+ DicomDirSerie *GetFirstEntry();
DicomDirSerie *GetNextEntry();
/// adds the passed SERIE to the SERIE chained List for this STUDY.
Program: gdcm
Module: $RCSfile: gdcmDict.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 11:13:21 $
- Version: $Revision: 1.65 $
+ Date: $Date: 2005/01/18 07:49:41 $
+ Version: $Revision: 1.66 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
// Public
/**
- * \ingroup Dict
* \brief Remove all Dicom Dictionary Entries
*/
void Dict::ClearEntry()
}
/**
- * \ingroup Dict
* \brief adds a new Dicom Dictionary Entry
* @param newEntry entry to add
* @return false if Dicom Element already exists
}
/**
- * \ingroup Dict
* \brief replaces an already existing Dicom Element by a new one
* @param newEntry new entry (overwrites any previous one with same tag)
* @return false if Dicom Element doesn't exist
}
/**
- * \ingroup Dict
* \brief removes an already existing Dicom Dictionary Entry,
* identified by its Tag
* @param key (group|element)
//}
/**
- * \ingroup Dict
* \brief Consider all the entries of the public dicom dictionary.
* Build an hashtable whose keys are the names of the groups
* (fourth field in each line of dictionary) and whose corresponding
//}
/**
- * \brief Initialise the visit of the Hash table (KeyHt)
+ * \brief Get the first entry while visiting the Dict entries
+ * \return The first DicEntry if found, otherwhise NULL
*/
-void Dict::InitTraversal()
+DictEntry *Dict::GetFirstEntry()
{
ItKeyHt = KeyHt.begin();
+ return &(ItKeyHt->second);
}
/**
* \brief Get the next entry while visiting the Hash table (KeyHt)
+ * \note : meaningfull only if GetFirstEntry already called
* \return The next DictEntry if found, otherwhise NULL
*/
DictEntry *Dict::GetNextEntry()
Program: gdcm
Module: $RCSfile: gdcmDict.h,v $
Language: C++
- Date: $Date: 2005/01/16 04:50:41 $
- Version: $Revision: 1.32 $
+ Date: $Date: 2005/01/18 07:49:41 $
+ Version: $Revision: 1.33 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
// EntryNamesList *GetDictEntryNames();
// EntryNamesByCatMap *GetDictEntryNamesByCategory();
- /// \brief Returns a ref to the Dicom Dictionary H table (map)
- /// @return the Dicom Dictionary H table
- //const TagKeyHT & GetEntries() const { return KeyHt; }
-
- void InitTraversal();
+ DictEntry *GetFirstEntry();
DictEntry *GetNextEntry();
private:
Program: gdcm
Module: $RCSfile: gdcmDictSet.cxx,v $
Language: C++
- Date: $Date: 2005/01/17 10:56:50 $
- Version: $Revision: 1.51 $
+ Date: $Date: 2005/01/18 07:50:58 $
+ Version: $Revision: 1.52 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
//-----------------------------------------------------------------------------
// Constructor / Destructor
/**
- * \ingroup DictSet
* \brief The Dictionary Set obtained with this constructor simply
* contains the Default Public dictionary.
*/
}
/**
- * \ingroup DictSet
* \brief Destructor
*/
DictSet::~DictSet()
//-----------------------------------------------------------------------------
// Print
/**
- * \ingroup DictSet
* \brief Print, in an informal fashion, the list of all the dictionaries
* contained is this DictSet, along with their respective content.
* @param os Output stream used for printing.
//-----------------------------------------------------------------------------
// Public
/**
- * \ingroup DictSet
* \brief Consider all the entries of the public dicom dictionary.
* Build all list of all the tag names of all those entries.
* \sa DictSet::GetPubDictTagNamesByCategory
//}
/**
- * \ingroup DictSet
* \brief
* - Consider all the entries of the public dicom dictionary.
* - Build an hashtable whose keys are the names of the groups
//}
/**
- * \ingroup DictSet
* \brief Loads a dictionary from a specified file, and add it
* to already the existing ones contained in this DictSet.
* @param filename Absolute or relative filename containing the
}
/**
- * \ingroup DictSet
* \brief Retrieve the specified dictionary (when existing) from this
* DictSet.
* @param dictName The symbolic name of the searched dictionary.
/**
- * \brief Initialise the visit of the Hash table (DictSetHT)
+ * \brief Get the first entry while visiting the DictSet
+ * \return The first Dict if found, otherwhise NULL
*/
-void DictSet::InitTraversal()
+Dict *DictSet::GetFirstEntry()
{
ItDictHt = Dicts.begin();
+ return ItDictHt->second;
}
/**
* \brief Get the next entry while visiting the Hash table (DictSetHT)
+ * \note : meaningfull only if GetFirstEntry already called
* \return The next Dict if found, otherwhise NULL
*/
Dict *DictSet::GetNextEntry()
//-----------------------------------------------------------------------------
// Protected
+
+/**
+ * \brief Adds a Dictionary to a DictSet
+ * \return always true
+ */
bool DictSet::AppendDict(Dict *newDict, DictKey const &name)
{
Dicts[name] = newDict;
Program: gdcm
Module: $RCSfile: gdcmDictSet.h,v $
Language: C++
- Date: $Date: 2005/01/17 10:56:50 $
- Version: $Revision: 1.37 $
+ Date: $Date: 2005/01/18 07:50:58 $
+ Version: $Revision: 1.38 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
static std::string BuildDictPath();
- void InitTraversal();
+ Dict *GetFirstEntry();
Dict *GetNextEntry();
protected: