+2004-11-09 Eric Boix <Eric.Boix@creatis.insa-lyon.fr>
+ * FIX: src/* fix the doxygen warnings.
+
2004-11-15 Mathieu Malaterre <Mathieu.Malaterre@creatis.insa-lyon.fr>
1. Finish merging JMR patch for writting DICOM from scratch
2. Fix -hopefully- bug with MONOCHROME and space vs null character
Program: gdcm
Module: $RCSfile: gdcmDicomDir.cxx,v $
Language: C++
- Date: $Date: 2004/11/09 22:15:36 $
- Version: $Revision: 1.79 $
+ Date: $Date: 2004/11/16 10:25:52 $
+ Version: $Revision: 1.80 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/**
* \ingroup DicomDir
- * \brief Set the start method to call when the parsing of the directory starts
+ * \brief Set the start method to call when the parsing of the
+ * directory starts.
* @param method Method to call
* @param arg Argument to pass to the method
* @param argDelete Argument
* \warning In python : the arg parameter isn't considered
*/
-void DicomDir::SetStartMethod(Method* method, void* arg,
- Method* argDelete )
+void DicomDir::SetStartMethod( DicomDir::Method* method, void* arg,
+ DicomDir::Method* argDelete )
{
if( StartArg && StartMethodArgDelete )
{
* class is destroyed
* @param method Method to call to delete the argument
*/
-void DicomDir::SetStartMethodArgDelete(Method* method)
+void DicomDir::SetStartMethodArgDelete( DicomDir::Method* method )
{
StartMethodArgDelete = method;
}
/**
* \ingroup DicomDir
- * \brief Set the progress method to call when the parsing of the directory progress
+ * \brief Set the progress method to call when the parsing of the
+ * directory progress
* @param method Method to call
* @param arg Argument to pass to the method
* @param argDelete Argument
* \warning In python : the arg parameter isn't considered
*/
-void DicomDir::SetProgressMethod(Method* method, void* arg,
- Method* argDelete )
+void DicomDir::SetProgressMethod( DicomDir::Method* method, void* arg,
+ DicomDir::Method* argDelete )
{
if( ProgressArg && ProgressMethodArgDelete )
{
* class is destroyed
* @param method Method to call to delete the argument
*/
-void DicomDir::SetProgressMethodArgDelete(Method* method)
+void DicomDir::SetProgressMethodArgDelete( DicomDir::Method* method )
{
ProgressMethodArgDelete = method;
}
* @param argDelete Argument
* \warning In python : the arg parameter isn't considered
*/
-void DicomDir::SetEndMethod(Method* method, void* arg,
- Method* argDelete )
+void DicomDir::SetEndMethod( DicomDir::Method* method, void* arg,
+ DicomDir::Method* argDelete )
{
if( EndArg && EndMethodArgDelete )
{
/**
* \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
+ * The argument is destroyed when the method is changed or when
+ * the class is destroyed
* @param method Method to call to delete the argument
*/
-void DicomDir::SetEndMethodArgDelete(Method* method)
+void DicomDir::SetEndMethodArgDelete( DicomDir::Method* method )
{
EndMethodArgDelete = method;
}
/**
* \ingroup DicomDir
- * \brief writes on disc a 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 !
* \todo : to be re-written using the DICOMDIR tree-like structure
Program: gdcm
Module: $RCSfile: gdcmDicomDir.h,v $
Language: C++
- Date: $Date: 2004/11/09 13:10:44 $
- Version: $Revision: 1.38 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ Version: $Revision: 1.39 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/// Parsing
void ParseDirectory();
+ // Note: the DicomDir:: namespace prefix is needed by Swig in the
+ // following method declarations. Refer to gdcmPython/gdcm.i
+ // for the reasons of this unecessary notation at C++ level.
void SetStartMethod( DicomDir::Method*,
void* = NULL,
DicomDir::Method* = NULL );
Program: gdcm
Module: $RCSfile: gdcmDirList.cxx,v $
Language: C++
- Date: $Date: 2004/11/09 21:55:55 $
- Version: $Revision: 1.26 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ 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
// Private
/**
- * \ingroup DirList
* \brief Explore a directory with possibility of recursion
* return number of files read
- * @param dirName directory to explore
+ * @param dirpath directory to explore
* @param recursive whether we want recursion or not
*/
int DirList::Explore(std::string const & dirpath, bool recursive)
Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.cxx,v $
Language: C++
- Date: $Date: 2004/10/27 22:31:12 $
- Version: $Revision: 1.25 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ 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
// Protected
/**
- * \brief Gets a Dicom Element inside a SQ Item Entry, by name
+ * \brief Gets a Dicom Element inside a SQ Item Entry, by name
+ * @param name of the element to be found.
* @return
*/
- DocEntry *DocEntrySet::GetDocEntryByName(std::string const & name)
- {
+DocEntry* DocEntrySet::GetDocEntryByName( TagName const & name )
+{
Dict *pubDict = Global::GetDicts()->GetDefaultPubDict();
DictEntry *dictEntry = pubDict->GetDictEntryByName(name);
if( !dictEntry )
* @param fourth owner group
* @param name english name
*/
-DictEntry* DocEntrySet::NewVirtualDictEntry(uint16_t group,
- uint16_t element,
- std::string const & vr,
- std::string const & fourth,
- std::string const & name)
+DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group,
+ uint16_t element,
+ TagName const & vr,
+ TagName const & fourth,
+ TagName const & name )
{
return Global::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name);
}
* Creates a new DocEntry (without any 'value' ...)
* @param group group number of the underlying DictEntry
* @param elem elem number of the underlying DictEntry
- * @param VR V(alue) R(epresentation) of the Entry -if private Entry-
-
+ * @param vr V(alue) R(epresentation) of the Entry -if private Entry-
*/
DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, uint16_t elem,
TagName const & vr)
Program: gdcm
Module: $RCSfile: gdcmDocEntrySet.h,v $
Language: C++
- Date: $Date: 2004/10/25 03:35:19 $
- Version: $Revision: 1.22 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ Version: $Revision: 1.23 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
* and \ref SQItem which are both containers for DocEntries.
* \ref ElementSet is based on the STL map<> container
* (see \ref ElementSet::TagHT), as opposed to \ref SQItem
- * which is based on an STL list container (see \ref SQItem::docEntries).
+ * which is based on an STL list container (see \ref ListDocEntry).
* Since the syntax for adding a new element to a map<> or a list<>
* differ, \ref DocEntrySet is designed as an adapter to unify the
* interfaces of \ref DocEntrySet and \ref ElementSet.
virtual DocEntry* GetDocEntryByNumber(uint16_t group,
uint16_t element) = 0;
- DocEntry *GetDocEntryByName(TagName const & name);
+ DocEntry* GetDocEntryByName(TagName const & name);
virtual std::string GetEntryByNumber(uint16_t group, uint16_t element) = 0;
std::string GetEntryByName(TagName const & name);
- DictEntry *NewVirtualDictEntry(uint16_t group,
- uint16_t element,
- TagName const & vr = "unkn",
- TagName const & fourth = "unkn",
- TagName const & name = "unkn");
+ DictEntry* NewVirtualDictEntry( uint16_t group,
+ uint16_t element,
+ TagName const & vr = "unkn",
+ TagName const & fourth = "unkn",
+ TagName const & name = "unkn" );
protected:
Program: gdcm
Module: $RCSfile: gdcmDocument.cxx,v $
Language: C++
- Date: $Date: 2004/11/16 02:54:35 $
- Version: $Revision: 1.124 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ Version: $Revision: 1.125 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
return true;
}
-
/**
- * \brief Internal function that checks whether the Transfer Syntax given
- * as argument is the one present in the current document.
- * @param syntaxToCheck The transfert syntax we need to check against.
- * @return True when SyntaxToCheck corresponds to the Transfer Syntax of
- * the current document. False either when the document contains
- * no Transfer Syntax, or when the Tranfer Syntaxes doesn't match.
+ * \brief Accessor to the Transfer Syntax (when present) of the
+ * current document (it internally handles reading the
+ * value from disk when only parsing occured).
+ * @return The encountered Transfer Syntax of the current document.
*/
TransferSyntaxType Document::GetTransferSyntax()
{
* @param value (string) Value to be set
* @param group Group number of the Entry
* @param elem Element number of the Entry
- * @param VR V(alue) R(epresentation) of the Entry -if private Entry-
+ * @param vr V(alue) R(epresentation) of the Entry -if private Entry-
* \return pointer to the modified/created Header Entry (NULL when creation
* failed).
*/
* @param tagName name of the searched Dicom Element.
* @return true when found
*/
-bool Document::SetEntryByName(std::string const & content,
- TagName const & tagName)
+bool Document::SetEntryByName( std::string const & content,
+ TagName const & tagName)
{
DictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName);
if( !dictEntry )
Program: gdcm
Module: $RCSfile: gdcmDocument.h,v $
Language: C++
- Date: $Date: 2004/11/16 02:54:35 $
- Version: $Revision: 1.59 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ Version: $Revision: 1.60 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
ValEntry* ReplaceOrCreateByNumber(std::string const & value,
uint16_t group, uint16_t elem,
- std::string const & vr = "unkn");
+ TagName const & vr = "unkn");
BinEntry* ReplaceOrCreateByNumber(uint8_t* binArea, int lgth,
uint16_t group, uint16_t elem,
- std::string const & vr = "unkn");
+ TagName const & vr = "unkn");
SeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
virtual int GetEntryLengthByNumber(uint16_t group, uint16_t elem);
//protected:
- virtual bool SetEntryByName (std::string const & content,
- std::string const & tagName);
+ virtual bool SetEntryByName ( std::string const & content,
+ TagName const & tagName );
virtual bool SetEntryByNumber(std::string const & content,
uint16_t group, uint16_t element);
virtual bool SetEntryByNumber(uint8_t* content, int lgth,
virtual bool SetEntryLengthByNumber(uint32_t length,
uint16_t group, uint16_t element);
- virtual size_t GetEntryOffsetByNumber (uint16_t group, uint16_t elem);
+ virtual size_t GetEntryOffsetByNumber(uint16_t group, uint16_t elem);
virtual void* GetEntryBinAreaByNumber(uint16_t group, uint16_t elem);
virtual bool SetEntryBinAreaByNumber(uint8_t* a, uint16_t group,
uint16_t elem);
// Header entry
DocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element);
- DocEntry* GetDocEntryByName (std::string const & tagName);
+ DocEntry* GetDocEntryByName (TagName const & tagName);
ValEntry* GetValEntryByNumber(uint16_t group, uint16_t element);
//BinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element);
Program: gdcm
Module: $RCSfile: gdcmUtil.cxx,v $
Language: C++
- Date: $Date: 2004/11/16 02:54:35 $
- Version: $Revision: 1.64 $
+ Date: $Date: 2004/11/16 10:25:53 $
+ Version: $Revision: 1.65 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
/**
* \ingroup Globals
* \brief Add a SEPARATOR to the end of the name is necessary
- * @param name file/directory name to normalize
+ * @param pathname file/directory name to normalize
*/
std::string Util::NormalizePath(std::string const & pathname)
{
}
/**
- * \ingroup Util
* \brief Create a /DICOM/ string:
* It should a of even length (no odd length ever)
- * It can contains as many \0 as you want.
+ * It can contain as many (if you are reading this from your
+ * editor the following character is is backslash followed by zero
+ * that needed to be escaped with an extra backslash for doxygen) \\0
+ * as you want.
*/
std::string Util::DicomString(const char* s, size_t l)
{
* \ingroup Util
* \brief Create a /DICOM/ string:
* It should a of even lenght (no odd length ever)
- * It can contains as many \0 as you want.
+ * It can contain as many (if you are reading this from your
+ * editor the following character is is backslash followed by zero
+ * that needed to be escaped with an extra backslash for doxygen) \\0
+ * as you want.
* This function is similar to DicomString(const char*),
* except it doesn't take a lenght.
* It only pad with a null character if length is odd
projects / gdcm.git / commitdiff