OFFIS DCMTK  Version 3.6.0
dcvrst.h
1 /*
2  *
3  * Copyright (C) 1994-2010, OFFIS e.V.
4  * All rights reserved. See COPYRIGHT file for details.
5  *
6  * This software and supporting documentation were developed by
7  *
8  * OFFIS e.V.
9  * R&D Division Health
10  * Escherweg 2
11  * D-26121 Oldenburg, Germany
12  *
13  *
14  * Module: dcmdata
15  *
16  * Author: Gerd Ehlers
17  *
18  * Purpose: Interface of class DcmShortText
19  *
20  * Last Update: $Author: joergr $
21  * Update Date: $Date: 2010-10-14 13:15:43 $
22  * CVS/RCS Revision: $Revision: 1.19 $
23  * Status: $State: Exp $
24  *
25  * CVS/RCS Log at end of file
26  *
27  */
28 
29 
30 #ifndef DCVRST_H
31 #define DCVRST_H
32 
33 #include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
34 
35 #include "dcmtk/dcmdata/dcchrstr.h"
36 
37 
41  : public DcmCharString
42 {
43  public:
44 
50  DcmShortText(const DcmTag &tag,
51  const Uint32 len = 0);
52 
56  DcmShortText(const DcmShortText &old );
57 
60  virtual ~DcmShortText();
61 
66  DcmShortText &operator=(const DcmShortText &obj);
67 
71  virtual DcmObject *clone() const
72  {
73  return new DcmShortText(*this);
74  }
75 
88  virtual OFCondition copyFrom(const DcmObject& rhs);
89 
93  virtual DcmEVR ident() const;
94 
100  virtual OFCondition checkValue(const OFString &vm = "",
101  const OFBool oldFormat = OFFalse);
102 
108  virtual unsigned long getVM();
109 
116  virtual OFCondition getOFString(OFString &stringVal,
117  const unsigned long pos,
118  OFBool normalize = OFTrue);
119 
125  virtual OFCondition getOFStringArray(OFString &stringVal,
126  OFBool normalize = OFTrue);
127 
128  /* --- static helper functions --- */
129 
134  static OFCondition checkStringValue(const OFString &value);
135 };
136 
137 
138 #endif // DCVRST_H
139 
140 /*
141 ** CVS/RCS Log:
142 ** $Log: dcvrst.h,v $
143 ** Revision 1.19 2010-10-14 13:15:43 joergr
144 ** Updated copyright header. Added reference to COPYRIGHT file.
145 **
146 ** Revision 1.18 2010-04-23 15:26:13 joergr
147 ** Specify an appropriate default value for the "vm" parameter of checkValue().
148 **
149 ** Revision 1.17 2010-04-23 14:25:27 joergr
150 ** Added new method to all VR classes which checks whether the stored value
151 ** conforms to the VR definition and to the specified VM.
152 **
153 ** Revision 1.16 2009-08-03 09:05:30 joergr
154 ** Added methods that check whether a given string value conforms to the VR and
155 ** VM definitions of the DICOM standards.
156 **
157 ** Revision 1.15 2008-07-17 11:19:49 onken
158 ** Updated copyFrom() documentation.
159 **
160 ** Revision 1.14 2008-07-17 10:30:23 onken
161 ** Implemented copyFrom() method for complete DcmObject class hierarchy, which
162 ** permits setting an instance's value from an existing object. Implemented
163 ** assignment operator where necessary.
164 **
165 ** Revision 1.13 2005-12-08 16:29:10 meichel
166 ** Changed include path schema for all DCMTK header files
167 **
168 ** Revision 1.12 2004/07/01 12:28:25 meichel
169 ** Introduced virtual clone method for DcmObject and derived classes.
170 **
171 ** Revision 1.11 2002/12/06 12:49:19 joergr
172 ** Enhanced "print()" function by re-working the implementation and replacing
173 ** the boolean "showFullData" parameter by a more general integer flag.
174 ** Added doc++ documentation.
175 ** Made source code formatting more consistent with other modules/files.
176 **
177 ** Revision 1.10 2001/09/25 17:19:34 meichel
178 ** Adapted dcmdata to class OFCondition
179 **
180 ** Revision 1.9 2001/06/01 15:48:53 meichel
181 ** Updated copyright header
182 **
183 ** Revision 1.8 2000/03/08 16:26:26 meichel
184 ** Updated copyright header.
185 **
186 ** Revision 1.7 1999/03/31 09:25:08 meichel
187 ** Updated copyright header in module dcmdata
188 **
189 ** Revision 1.6 1998/11/12 16:47:55 meichel
190 ** Implemented operator= for all classes derived from DcmObject.
191 **
192 ** Revision 1.5 1997/09/11 15:13:17 hewett
193 ** Modified getOFString method arguments by removing a default value
194 ** for the pos argument. By requiring the pos argument to be provided
195 ** ensures that callers realise getOFString only gets one component of
196 ** a multi-valued string.
197 **
198 ** Revision 1.4 1997/08/29 08:32:44 andreas
199 ** - Added methods getOFString and getOFStringArray for all
200 ** string VRs. These methods are able to normalise the value, i. e.
201 ** to remove leading and trailing spaces. This will be done only if
202 ** it is described in the standard that these spaces are not relevant.
203 ** These methods do not test the strings for conformance, this means
204 ** especially that they do not delete spaces where they are not allowed!
205 ** getOFStringArray returns the string with all its parts separated by \
206 ** and getOFString returns only one value of the string.
207 ** CAUTION: Currently getString returns a string with trailing
208 ** spaces removed (if dcmEnableAutomaticInputDataCorrection == OFTrue) and
209 ** truncates the original string (since it is not copied!). If you rely on this
210 ** behaviour please change your application now.
211 ** Future changes will ensure that getString returns the original
212 ** string from the DICOM object (NULL terminated) inclusive padding.
213 ** Currently, if you call getOF... before calling getString without
214 ** normalisation, you can get the original string read from the DICOM object.
215 **
216 ** Revision 1.3 1996/01/05 13:23:10 andreas
217 ** - changed to support new streaming facilities
218 ** - more cleanups
219 ** - merged read / write methods for block and file transfer
220 **
221 */


Generated on Thu Dec 20 2012 for OFFIS DCMTK Version 3.6.0 by Doxygen 1.8.2