text: /*
   *
   *  Copyright (C) 1994-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:  Gerd Ehlers, Andreas Barth
   *
   *  Purpose: Interface of class DcmLongText
   *
   *  Last Update:      $Author: joergr $
   *  Update Date:      $Date: 2010-10-14 13:15:43 $
   *  CVS/RCS Revision: $Revision: 1.20 $
   *  Status:           $State: Exp $
   *
   *  CVS/RCS Log at end of file
   *
   */
  
  #ifndef DCVRLT_H
  #define DCVRLT_H
  
  #include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
  
  #include "dcmtk/dcmdata/dcchrstr.h"
  
  
  /** a class representing the DICOM value representation 'Long Text' (LT)
   */
  class DcmLongText
    : public DcmCharString
  {
    public:
  
      /** constructor.
       *  Create new element from given tag and length.
       *  @param tag DICOM tag for the new element
       *  @param len value length for the new element
       */
      DcmLongText(const DcmTag &tag,
                  const Uint32 len = 0);
  
      /** copy constructor
       *  @param old element to be copied
       */
      DcmLongText(const DcmLongText &old);
  
      /** destructor
       */
      virtual ~DcmLongText();
  
      /** assignment operator
       *  @param obj element to be assigned/copied
       *  @return reference to this object
       */
      DcmLongText &operator=(const DcmLongText &obj);
  
      /** clone method
       *  @return deep copy of this object
       */
      virtual DcmObject *clone() const
      {
        return new DcmLongText(*this);
      }
  
      /** Virtual object copying. This method can be used for DcmObject
       *  and derived classes to get a deep copy of an object. Internally
       *  the assignment operator is called if the given DcmObject parameter
       *  is of the same type as "this" object instance. If not, an error
       *  is returned. This function permits copying an object by value
       *  in a virtual way which therefore is different to just calling the
       *  assignment operator of DcmElement which could result in slicing
       *  the object.
       *  @param rhs - [in] The instance to copy from. Has to be of the same
       *                class type as "this" object
       *  @return EC_Normal if copying was successful, error otherwise
       */
      virtual OFCondition copyFrom(const DcmObject& rhs);
  
      /** get element type identifier
       *  @return type identifier of this class (EVR_LT)
       */
      virtual DcmEVR ident() const;
  
      /** check whether stored value conforms to the VR and to the specified VM
       *  @param vm parameter not used for this VR
       *  @param oldFormat parameter not used for this VR (only for DA, TM, PN)
       *  @return status of the check, EC_Normal if value is correct, an error code otherwise
       */
      virtual OFCondition checkValue(const OFString &vm = "",
                                     const OFBool oldFormat = OFFalse);
  
      /** get the value multiplicity.
       *  Since the backslash "\" is not regarded as a separator the value
       *  multiplicity is always 1.
       *  @return value multiplicity of the currently stored value
       */
      virtual unsigned long getVM();
  
      /** get a copy of a particular string component
       *  @param stringVal variable in which the result value is stored
       *  @param pos index of the value in case of multi-valued elements (0..vm-1)
       *  @param normalize delete leading and trailing spaces if OFTrue
       *  @return status, EC_Normal if successful, an error code otherwise
       */
      virtual OFCondition getOFString(OFString &stringVal,
                                      const unsigned long pos,
                                      OFBool normalize = OFTrue);
  
      /** get the string value (all compenents)
       *  @param stringVal string variable in which the result value is stored
       *  @param normalize remove trailing spaces if OFTrue
       *  @return status, EC_Normal if successful, an error code otherwise
       */
      virtual OFCondition getOFStringArray(OFString &stringVal,
                                           OFBool normalize = OFTrue);
  
      /* --- static helper functions --- */
  
      /** check whether given string value conforms to the VR "LT" (Long Text)
       *  @param value string value to be checked (possibly multi-valued)
       *  @return status of the check, EC_Normal if value is correct, an error code otherwise
       */
      static OFCondition checkStringValue(const OFString &value);
  };
  
  
  #endif // DCVRLT_H
  
  
  /*
  ** CVS/RCS Log:
  ** $Log: dcvrlt.h,v $
  ** Revision 1.20  2010-10-14 13:15:43  joergr
  ** Updated copyright header. Added reference to COPYRIGHT file.
  **
  ** Revision 1.19  2010-04-23 15:26:13  joergr
  ** Specify an appropriate default value for the "vm" parameter of checkValue().
  **
  ** Revision 1.18  2010-04-23 14:25:27  joergr
  ** Added new method to all VR classes which checks whether the stored value
  ** conforms to the VR definition and to the specified VM.
  **
  ** Revision 1.17  2010-03-01 09:08:45  uli
  ** Removed some unnecessary include directives in the headers.
  **
  ** Revision 1.16  2009-08-03 09:05:30  joergr
  ** Added methods that check whether a given string value conforms to the VR and
  ** VM definitions of the DICOM standards.
  **
  ** Revision 1.15  2008-07-17 11:19:49  onken
  ** Updated copyFrom() documentation.
  **
  ** Revision 1.14  2008-07-17 10:30:23  onken
  ** Implemented copyFrom() method for complete DcmObject class hierarchy, which
  ** permits setting an instance's value from an existing object. Implemented
  ** assignment operator where necessary.
  **
  ** Revision 1.13  2005-12-08 16:29:02  meichel
  ** Changed include path schema for all DCMTK header files
  **
  ** Revision 1.12  2004/07/01 12:28:25  meichel
  ** Introduced virtual clone method for DcmObject and derived classes.
  **
  ** Revision 1.11  2002/12/06 12:49:17  joergr
  ** Enhanced "print()" function by re-working the implementation and replacing
  ** the boolean "showFullData" parameter by a more general integer flag.
  ** Added doc++ documentation.
  ** Made source code formatting more consistent with other modules/files.
  **
  ** Revision 1.10  2001/09/25 17:19:32  meichel
  ** Adapted dcmdata to class OFCondition
  **
  ** Revision 1.9  2001/06/01 15:48:51  meichel
  ** Updated copyright header
  **
  ** Revision 1.8  2000/03/08 16:26:24  meichel
  ** Updated copyright header.
  **
  ** Revision 1.7  1999/03/31 09:25:03  meichel
  ** Updated copyright header in module dcmdata
  **
  ** Revision 1.6  1998/11/12 16:47:51  meichel
  ** Implemented operator= for all classes derived from DcmObject.
  **
  ** Revision 1.5  1997/09/11 15:13:15  hewett
  ** Modified getOFString method arguments by removing a default value
  ** for the pos argument.  By requiring the pos argument to be provided
  ** ensures that callers realise getOFString only gets one component of
  ** a multi-valued string.
  **
  ** Revision 1.4  1997/08/29 08:32:43  andreas
  ** - Added methods getOFString and getOFStringArray for all
  **   string VRs. These methods are able to normalise the value, i. e.
  **   to remove leading and trailing spaces. This will be done only if
  **   it is described in the standard that these spaces are not relevant.
  **   These methods do not test the strings for conformance, this means
  **   especially that they do not delete spaces where they are not allowed!
  **   getOFStringArray returns the string with all its parts separated by \
  **   and getOFString returns only one value of the string.
  **   CAUTION: Currently getString returns a string with trailing
  **   spaces removed (if dcmEnableAutomaticInputDataCorrection == OFTrue) and
  **   truncates the original string (since it is not copied!). If you rely on this
  **   behaviour please change your application now.
  **   Future changes will ensure that getString returns the original
  **   string from the DICOM object (NULL terminated) inclusive padding.
  **   Currently, if you call getOF... before calling getString without
  **   normalisation, you can get the original string read from the DICOM object.
  **
  ** Revision 1.3  1996/01/05 13:23:07  andreas
  ** - changed to support new streaming facilities
  ** - more cleanups
  ** - merged read / write methods for block and file transfer
  **
  */
  