dcmdata/include/dcmtk/dcmdata/dcpath.h

/*
 *
 *  Copyright (C) 2008-2010, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module:  dcmdata
 *
 *  Author:  Michael Onken
 *
 *  Purpose: Class declarations for accessing DICOM dataset structures (items,
 *           sequences and leaf elements via string-based path access.
 *
 *  Last Update:      $Author: joergr $
 *  Update Date:      $Date: 2010-10-14 13:15:41 $
 *  CVS/RCS Revision: $Revision: 1.10 $
 *  Status:           $State: Exp $
 *
 *  CVS/RCS Log at end of file
 *
 */

#ifndef DCPATH_H
#define DCPATH_H

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

#include "dcmtk/dcmdata/dcdatset.h"


class DcmPathNode
{

public:

  DcmPathNode() : m_obj(NULL), m_itemNo(0) {}

  DcmPathNode(DcmObject* obj, Uint32 itemNo)    : m_obj(obj), m_itemNo(itemNo) {}

  ~DcmPathNode() { }

  DcmObject* m_obj;

  Uint32 m_itemNo;

private:

  DcmPathNode(const DcmPathNode& rhs);

  DcmPathNode& operator=(const DcmPathNode& arg);

};


class DcmPath
{

public:

  DcmPath();

  DcmPath(const OFList<DcmPathNode*>& currentPath);

  void append(DcmPathNode* node);

  void deleteBackNode();

  OFListIterator(DcmPathNode*) begin();

  DcmPathNode* back();

  OFListIterator(DcmPathNode*) end();

  Uint32 size() const;

  OFBool empty() const;

  OFString toString() const;

  OFBool containsGroup(const Uint16& groupNo) const;

  static OFCondition separatePathNodes(const OFString& path, OFList<OFString>& result);

  static OFCondition parseItemNoFromPath(OFString& path,                   // inout
                                         Uint32& itemNo,                   // out
                                         OFBool& wasWildcard);             // out

  static OFCondition parseTagFromPath(OFString& path,         // inout
                                      DcmTag& tag);           // out

  ~DcmPath();

private:

  OFList<DcmPathNode*> m_path;

  DcmPath(const DcmPath& rhs);

  DcmPath& operator=(const DcmPath& arg);
};


class DcmPathProcessor
{

public:

  DcmPathProcessor();

  void setItemWildcardSupport(const OFBool& supported);


  void checkPrivateReservations(const OFBool& doChecking);

  OFCondition findOrCreatePath(DcmObject* obj,
                               const OFString& path,
                               OFBool createIfNecessary = OFFalse);

  OFCondition findOrDeletePath(DcmObject* obj,
                               const OFString& path,
                               Uint32& numDeleted);

  Uint32 getResults(OFList<DcmPath*>& searchResults);


  OFCondition applyPathWithValue(DcmDataset *dataset,
                                         const OFString& overrideKey);

  ~DcmPathProcessor();

protected:

  OFCondition findOrCreateItemPath(DcmItem* item,
                                   OFString& path);

  OFCondition findOrCreateSequencePath(DcmSequenceOfItems* seq,
                                       OFString& path);

  static OFCondition deleteLastElemFromPath(DcmObject* objSearchedIn,
                                            DcmPath *path,
                                            DcmPathNode* toDelete);

  static OFCondition deleteLastItemFromPath(DcmObject* objSearchedIn,
                                            DcmPath *path,
                                            DcmPathNode* toDelete);

  OFCondition checkPrivateTagReservation(DcmItem *item,
                                         DcmTag& tag);
  static DcmTagKey calcPrivateReservationTag(const DcmTagKey &privateKey);

  void clear();

private:

  OFList<DcmPathNode*> m_currentPath;

  OFList<DcmPath*> m_results;

  OFBool m_createIfNecessary;

  OFBool m_checkPrivateReservations;

  OFBool m_itemWildcardsEnabled;

  DcmPathProcessor(const DcmPathProcessor& rhs);

  DcmPathProcessor& operator=(const DcmPathProcessor& arg);

};


#endif // DCPATH_H

/*
** CVS/RCS Log:
** $Log: dcpath.h,v $
** Revision 1.10  2010-10-14 13:15:41  joergr
** Updated copyright header. Added reference to COPYRIGHT file.
**
** Revision 1.9  2010-08-09 13:02:56  joergr
** Updated data dictionary to 2009 edition of the DICOM standard. From now on,
** the official "keyword" is used for the attribute name which results in a
** number of minor changes (e.g. "PatientsName" is now called "PatientName").
**
** Revision 1.8  2009-11-04 09:58:07  uli
** Switched to logging mechanism provided by the "new" oflog module
**
** Revision 1.7  2009-09-29 12:55:17  uli
** Include only the needed headers in dcpath.h and dcpath.cc
**
** Revision 1.6  2009-07-10 13:12:30  onken
** Added override key functionality used by tools like findscu to the more
** central DcmPathProcessor class.
**
** Revision 1.5  2009-07-08 16:09:30  onken
** Cleaned up code for private reservation checking and added option for
** disabling item wildcards for searching/creating tag paths.
**
** Revision 1.4  2009-01-15 16:04:06  onken
** Added options for handling of private tags and fixed bug for deleting
** tags on main level.
**
** Revision 1.3  2009-01-12 12:37:45  onken
** Fixed iterators to also compile with STL classes being enabled.
**
** Revision 1.2  2008-12-12 13:16:03  onken
** Fixed doxygen documentation.
**
** Revision 1.1  2008-12-12 11:44:40  onken
** Moved path access functions to separate classes
**
*/

---

Generated on 6 Jan 2011 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.5.1