DCMTree_Tag.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef DCM_TREE_TAG_H
#define DCM_TREE_TAG_H
 
#include "DCMTree_Lib.h"
#include "DCMTree_TagInfo.h"
#include "DCMTree_Value.h"
#include "DCMTree_Defines.h"
 
#ifdef _MSC_VER
  // 4350: behavior change
  // 4365: signed/unsigned mismatch
  // 4548: expression before comma has no effect; expected expression with side-effect
  #pragma warning (push)
  #pragma warning (disable : 4350 4365 4548)
#endif
 
#include <istream>
#include <ostream>
#include <fstream>
 
#ifdef _MSC_VER
  #pragma warning (pop)
#endif
 
namespace DCMTree
{
  enum StringTrimMode { TRIM_STRING, DO_NOT_TRIM };

  class DCMTREE_EXPORT Tag:public DCMTree_Serialization::Serializable,public DCMTree_Serialization::Deserializable
  {
  public:
    Tag();

    Tag(const TagInfo &info);

    Tag(const Tag &other);

    Tag(const Tag &other, unsigned short slot);

    ~Tag() override;

    Tag &operator=(const Tag &other);

    bool operator==( const Tag& other ) const;
    bool operator!=( const Tag& other ) const;

    bool isEqual( const Tag& other, double tolerance = 0 ) const;

    virtual TagPtr copy() const;

    const TagInfo &info() const;

    const TreePtrVector &sequenceItems() const;

     TreePtrVector &sequenceItems();

    boost::uint32_t numberOfSequenceItems() const;

    void dropSequenceItems();

    void dropSequenceItem(unsigned idx);

    virtual boost::uint32_t numberOfValues() const;

    void dropValues();

    bool isEmpty() const;

    bool isSequence() const;

    bool isNull (unsigned idx) const;

    bool isSequenceItemNull (unsigned idx) const;

    void setInfo (const TagInfo &info);

    void addSequenceItem (const TreePtr &sequence);

    TreePtr &addSequenceItem();

    void setSequenceItem (const TreePtr &sequence,unsigned idx=0);

    std::string toString (unsigned int idx, StringTrimMode trimMode = DO_NOT_TRIM) const;

    std::string toString(StringTrimMode trimMode = DO_NOT_TRIM) const;

    void setValue (std::string value,unsigned int idx=0);

    void addValue (std::string value);

    Date toDate (unsigned int idx=0) const;

    void setValue (Date value,unsigned int idx=0);

    void addValue (Date value);

    Time toTime (unsigned int idx=0) const;

    void setValue (Time value,unsigned int idx=0);

    void addValue (Time value);

    DateTime toDateTime (unsigned int idx=0) const;

    void setValue (DateTime value,unsigned int idx=0);

    void addValue (DateTime value);

    float toFloat (unsigned int idx=0) const;

    void setValue (float value,unsigned int idx=0);

    void addValue (float value);

    double toDouble (unsigned int idx=0) const;

    void setValue (double value,unsigned int idx=0);

    void addValue (double value);

    int toInt (unsigned int idx=0) const;

    void setValue (int value,unsigned int idx=0);

    void addValue (int value);

    unsigned int toUInt (unsigned int idx=0) const;

    void setValue (unsigned int value,unsigned int idx=0);

    void addValue (unsigned int value);

    short int toShort (unsigned int idx=0) const;

    void setValue (short int value,unsigned int idx=0);

    void addValue (short int value);

    unsigned short toUShort (unsigned int idx=0) const;

    void setValue (unsigned short int value,unsigned int idx=0);

    void addValue (unsigned short int value);

    const Value &getValue (unsigned int idx=0) const;

    void setValue (const Value &value,unsigned int idx=0);

    virtual Value &addValue();

    virtual boost::uint32_t getValueSize (unsigned int idx) const;

    virtual boost::uint32_t getValueSize () const;

    virtual void fromStream (std::istream &in, bool readName, size_t maxSize = 0);

    virtual void toStream (std::ostream &out, bool writeName) const;

    int compare(const Tag& tag, double tolerance = 0.0001) const;

    void setVr( Vr vr );
 
    void serializeX (DCMTree_Serialization::Sink &sink) const override;
    void deserializeX (DCMTree_Serialization::Source &source) override;
 
  protected:
    TagInfo const & tagInfo() const { return _info; }
 
  private:
    int compareNumerical(const Tag& tag, int nMin, double tolerance) const;

    int compareBytes(const Tag& tag, int nMin) const;

    void typeAndRangeChecking (const VRCType &vrctype,const unsigned int &idx) const;

    void typeChecking (const VRCType &vrctype) const;

    bool isOfType(const VRCType &vrctype) const;

    void rangeChecking (const unsigned int &idx) const;

    void sequenceRangeChecking (const unsigned int &idx) const;
 
    TagInfo _info;
    ValueVector _values;
    TreePtrVector _sequences;
  };
 
  inline std::ostream &operator << (std::ostream &out,const Tag &t)
  {
      t.toStream (out, false);
      return out;
  }
 
  inline std::istream &operator >> (std::istream &in,Tag &t)
  {
      t.fromStream (in, false);
      return in;
  }
}
 
#endif