dcdict.h

/*
 *
 *  Copyright (C) 1994-2005, OFFIS
 *
 *  This software and supporting documentation were developed by
 *
 *    Kuratorium OFFIS e.V.
 *    Healthcare Information and Communication Systems
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *  THIS SOFTWARE IS MADE AVAILABLE,  AS IS,  AND OFFIS MAKES NO  WARRANTY
 *  REGARDING  THE  SOFTWARE,  ITS  PERFORMANCE,  ITS  MERCHANTABILITY  OR
 *  FITNESS FOR ANY PARTICULAR USE, FREEDOM FROM ANY COMPUTER DISEASES  OR
 *  ITS CONFORMITY TO ANY SPECIFICATION. THE ENTIRE RISK AS TO QUALITY AND
 *  PERFORMANCE OF THE SOFTWARE IS WITH THE USER.
 *
 *  Module:  dcmdata
 *
 *  Author:  Andrew Hewett
 *
 *  Purpose: Interface for loadable DICOM data dictionary
 *
 *  Last Update:      $Author: meichel $
 *  Update Date:      $Date: 2005/12/08 16:28:09 $
 *  CVS/RCS Revision: $Revision: 1.20 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DCMDICT_H
#define DCMDICT_H

#include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
#include "dcmtk/dcmdata/dchashdi.h"
#include "dcmtk/ofstd/ofthread.h"

#define DCM_MAXDICTLINESIZE     2048

#define DCM_MAXDICTFIELDS       6

#define DCM_DICT_ENVIRONMENT_VARIABLE   "DCMDICTPATH"

#ifndef DCM_DICT_DEFAULT_PATH
/*
** The default dictionary path is system dependent.  It should
** be defined in a configuration file included from "osconfig.h"
*/
#error "DCM_DICT_DEFAULT_PATH is not defined via osconfig.h"
#endif /* !DCM_DICT_DEFAULT_PATH */

#ifndef ENVIRONMENT_PATH_SEPARATOR
#define ENVIRONMENT_PATH_SEPARATOR '\n' /* at least define something unlikely */
#endif


class DcmDataDictionary
{
public:

    DcmDataDictionary(OFBool loadBuiltin, OFBool loadExternal);

    ~DcmDataDictionary();

    OFBool isDictionaryLoaded() const { return dictionaryLoaded; }

    int numberOfNormalTagEntries() const { return hashDict.size(); }

    int numberOfRepeatingTagEntries() const { return repDict.size(); }

    int numberOfEntries() const
        { return numberOfNormalTagEntries()
              + numberOfRepeatingTagEntries() - skeletonCount; }

    int numberOfSkeletonEntries() const { return skeletonCount; }

    OFBool loadDictionary(const char* fileName, OFBool errorIfAbsent=OFTrue);

    const DcmDictEntry* findEntry(const DcmTagKey& key, const char *privCreator) const;

    const DcmDictEntry* findEntry(const char *name) const;

    void clear();

    void addEntry(DcmDictEntry* entry);

    /* Iterators to access the normal and the repeating entries */

    DcmHashDictIterator normalBegin() { return hashDict.begin(); }

    DcmHashDictIterator normalEnd() { return hashDict.end(); }

    DcmDictEntryListIterator repeatingBegin() { return repDict.begin(); }

    DcmDictEntryListIterator repeatingEnd() { return repDict.end(); }

private:

    DcmDataDictionary &operator=(const DcmDataDictionary &);

    DcmDataDictionary(const DcmDataDictionary &);

    OFBool loadExternalDictionaries();

    void loadBuiltinDictionary();

    OFBool loadSkeletonDictionary();

    const DcmDictEntry* findEntry(const DcmDictEntry& entry) const;

    void deleteEntry(const DcmDictEntry& entry);


    DcmHashDict hashDict;

    DcmDictEntryList repDict;

    int skeletonCount;

    OFBool dictionaryLoaded;

};


class GlobalDcmDataDictionary
{
public:
  GlobalDcmDataDictionary(OFBool loadBuiltin, OFBool loadExternal);

  ~GlobalDcmDataDictionary();

  const DcmDataDictionary& rdlock();

  DcmDataDictionary& wrlock();

  void unlock();

  OFBool isDictionaryLoaded();

  void clear();

private:
  GlobalDcmDataDictionary &operator=(const GlobalDcmDataDictionary &);

  GlobalDcmDataDictionary(const GlobalDcmDataDictionary &);

  DcmDataDictionary dataDict;

#ifdef _REENTRANT

  OFReadWriteLock dataDictLock;
#endif
};


extern GlobalDcmDataDictionary dcmDataDict;

#endif


/*
** CVS/RCS Log:
** $Log: dcdict.h,v $
** Revision 1.20  2005/12/08 16:28:09  meichel
** Changed include path schema for all DCMTK header files
**
** Revision 1.19  2004/01/16 14:07:27  joergr
** Removed acknowledgements with e-mail addresses from CVS log.
**
** Revision 1.18  2002/07/23 14:21:25  meichel
** Added support for private tag data dictionaries to dcmdata
**
** Revision 1.17  2002/02/27 14:21:20  meichel
** Declare dcmdata read/write locks only when compiled in multi-thread mode
**
** Revision 1.16  2001/06/01 15:48:38  meichel
** Updated copyright header
**
** Revision 1.15  2000/05/03 14:19:08  meichel
** Added new class GlobalDcmDataDictionary which implements read/write lock
**   semantics for safe access to the DICOM dictionary from multiple threads
**   in parallel. The global dcmDataDict now uses this class.
**
** Revision 1.14  2000/03/08 16:26:13  meichel
** Updated copyright header.
**
** Revision 1.13  1999/03/31 09:24:35  meichel
** Updated copyright header in module dcmdata
**
** Revision 1.12  1998/07/15 15:48:45  joergr
** Removed several compiler warnings reported by gcc 2.8.1 with
** additional options, e.g. missing copy constructors and assignment
** operators, initialization of member variables in the body of a
** constructor instead of the member initialization list, hiding of
** methods by use of identical names, uninitialized member variables,
** missing const declaration of char pointers. Replaced tabs by spaces.
**
** Revision 1.11  1997/08/26 14:02:56  hewett
** New data structures for data-dictionary.  The main part of the
** data-dictionary is now stored in an hash table using an optimized
** hash function.  This new data structure reduces data-dictionary
** load times by a factor of 4!  he data-dictionary specific linked-list
** has been replaced by a linked list derived from OFList class
** (see ofstd/include/oflist.h).
** The only interface modifications are related to iterating over the entire
** data dictionary which should not be needed by "normal" applications.
**
** Revision 1.10  1997/07/21 08:25:07  andreas
** - Replace all boolean types (BOOLEAN, CTNBOOLEAN, DICOM_BOOL, BOOL)
**   with one unique boolean type OFBool.
**
** Revision 1.9  1997/05/22 13:15:54  hewett
** Added method DcmDataDictionary::isDictionaryLoaded() to ask if a full
** data dictionary has been loaded.  This method should be used in tests
** rather that querying the number of entries (a sekelton dictionary is
** now always present).
**
** Revision 1.8  1997/05/13 13:58:41  hewett
** Added member function (loadSkeletomDictionary) to preload of a few
** essential attribute descriptions into the data dictionary (e.g. Item
** and ItemDelimitation tags).
**
** Revision 1.7  1996/09/18 16:37:10  hewett
** Added capability to search data dictionary by tag name.
**
** Revision 1.6  1996/03/22 13:09:12  hewett
** Moved the definition of DCM_DICT_DEFAULT_PATH to the system
** dependent configuration files included via "osconfig.h".
**
** Revision 1.5  1996/03/21 09:50:38  hewett
** Added a  method numberOfEntries() to return the total number of
** dictionary entries.
**
** Revision 1.4  1996/03/20 16:43:49  hewett
** Updated for revised data dictionary.  Repeating tags are now handled better.
** A linear list of repeating tags has been introduced with a subset ordering
** mechanism to ensure that dictionary searches locate the most precise
** dictionary entry.
**
*/

---

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5