dcmdata/include/dcmtk/dcmdata/dcvrst.h

00001 /*
00002  *
00003  *  Copyright (C) 1994-2010, OFFIS e.V.
00004  *  All rights reserved.  See COPYRIGHT file for details.
00005  *
00006  *  This software and supporting documentation were developed by
00007  *
00008  *    OFFIS e.V.
00009  *    R&D Division Health
00010  *    Escherweg 2
00011  *    D-26121 Oldenburg, Germany
00012  *
00013  *
00014  *  Module:  dcmdata
00015  *
00016  *  Author:  Gerd Ehlers
00017  *
00018  *  Purpose: Interface of class DcmShortText
00019  *
00020  *  Last Update:      $Author: joergr $
00021  *  Update Date:      $Date: 2010-10-14 13:15:43 $
00022  *  CVS/RCS Revision: $Revision: 1.19 $
00023  *  Status:           $State: Exp $
00024  *
00025  *  CVS/RCS Log at end of file
00026  *
00027  */
00028 
00029 
00030 #ifndef DCVRST_H
00031 #define DCVRST_H
00032 
00033 #include "dcmtk/config/osconfig.h"    /* make sure OS specific configuration is included first */
00034 
00035 #include "dcmtk/dcmdata/dcchrstr.h"
00036 
00037 
00040 class DcmShortText
00041   : public DcmCharString
00042 {
00043   public:
00044 
00050     DcmShortText(const DcmTag &tag,
00051                  const Uint32 len = 0);
00052 
00056     DcmShortText(const DcmShortText &old );
00057 
00060     virtual ~DcmShortText();
00061 
00066     DcmShortText &operator=(const DcmShortText &obj);
00067 
00071     virtual DcmObject *clone() const
00072     {
00073       return new DcmShortText(*this);
00074     }
00075 
00088     virtual OFCondition copyFrom(const DcmObject& rhs);
00089 
00093     virtual DcmEVR ident() const;
00094 
00100     virtual OFCondition checkValue(const OFString &vm = "",
00101                                    const OFBool oldFormat = OFFalse);
00102 
00108     virtual unsigned long getVM();
00109 
00116     virtual OFCondition getOFString(OFString &stringVal,
00117                                     const unsigned long pos,
00118                                     OFBool normalize = OFTrue);
00119 
00125     virtual OFCondition getOFStringArray(OFString &stringVal,
00126                                          OFBool normalize = OFTrue);
00127 
00128     /* --- static helper functions --- */
00129 
00134     static OFCondition checkStringValue(const OFString &value);
00135 };
00136 
00137 
00138 #endif // DCVRST_H
00139 
00140 /*
00141 ** CVS/RCS Log:
00142 ** $Log: dcvrst.h,v $
00143 ** Revision 1.19  2010-10-14 13:15:43  joergr
00144 ** Updated copyright header. Added reference to COPYRIGHT file.
00145 **
00146 ** Revision 1.18  2010-04-23 15:26:13  joergr
00147 ** Specify an appropriate default value for the "vm" parameter of checkValue().
00148 **
00149 ** Revision 1.17  2010-04-23 14:25:27  joergr
00150 ** Added new method to all VR classes which checks whether the stored value
00151 ** conforms to the VR definition and to the specified VM.
00152 **
00153 ** Revision 1.16  2009-08-03 09:05:30  joergr
00154 ** Added methods that check whether a given string value conforms to the VR and
00155 ** VM definitions of the DICOM standards.
00156 **
00157 ** Revision 1.15  2008-07-17 11:19:49  onken
00158 ** Updated copyFrom() documentation.
00159 **
00160 ** Revision 1.14  2008-07-17 10:30:23  onken
00161 ** Implemented copyFrom() method for complete DcmObject class hierarchy, which
00162 ** permits setting an instance's value from an existing object. Implemented
00163 ** assignment operator where necessary.
00164 **
00165 ** Revision 1.13  2005-12-08 16:29:10  meichel
00166 ** Changed include path schema for all DCMTK header files
00167 **
00168 ** Revision 1.12  2004/07/01 12:28:25  meichel
00169 ** Introduced virtual clone method for DcmObject and derived classes.
00170 **
00171 ** Revision 1.11  2002/12/06 12:49:19  joergr
00172 ** Enhanced "print()" function by re-working the implementation and replacing
00173 ** the boolean "showFullData" parameter by a more general integer flag.
00174 ** Added doc++ documentation.
00175 ** Made source code formatting more consistent with other modules/files.
00176 **
00177 ** Revision 1.10  2001/09/25 17:19:34  meichel
00178 ** Adapted dcmdata to class OFCondition
00179 **
00180 ** Revision 1.9  2001/06/01 15:48:53  meichel
00181 ** Updated copyright header
00182 **
00183 ** Revision 1.8  2000/03/08 16:26:26  meichel
00184 ** Updated copyright header.
00185 **
00186 ** Revision 1.7  1999/03/31 09:25:08  meichel
00187 ** Updated copyright header in module dcmdata
00188 **
00189 ** Revision 1.6  1998/11/12 16:47:55  meichel
00190 ** Implemented operator= for all classes derived from DcmObject.
00191 **
00192 ** Revision 1.5  1997/09/11 15:13:17  hewett
00193 ** Modified getOFString method arguments by removing a default value
00194 ** for the pos argument.  By requiring the pos argument to be provided
00195 ** ensures that callers realise getOFString only gets one component of
00196 ** a multi-valued string.
00197 **
00198 ** Revision 1.4  1997/08/29 08:32:44  andreas
00199 ** - Added methods getOFString and getOFStringArray for all
00200 **   string VRs. These methods are able to normalise the value, i. e.
00201 **   to remove leading and trailing spaces. This will be done only if
00202 **   it is described in the standard that these spaces are not relevant.
00203 **   These methods do not test the strings for conformance, this means
00204 **   especially that they do not delete spaces where they are not allowed!
00205 **   getOFStringArray returns the string with all its parts separated by \
00206 **   and getOFString returns only one value of the string.
00207 **   CAUTION: Currently getString returns a string with trailing
00208 **   spaces removed (if dcmEnableAutomaticInputDataCorrection == OFTrue) and
00209 **   truncates the original string (since it is not copied!). If you rely on this
00210 **   behaviour please change your application now.
00211 **   Future changes will ensure that getString returns the original
00212 **   string from the DICOM object (NULL terminated) inclusive padding.
00213 **   Currently, if you call getOF... before calling getString without
00214 **   normalisation, you can get the original string read from the DICOM object.
00215 **
00216 ** Revision 1.3  1996/01/05 13:23:10  andreas
00217 ** - changed to support new streaming facilities
00218 ** - more cleanups
00219 ** - merged read / write methods for block and file transfer
00220 **
00221 */


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