137 lines
4.9 KiB
C++
137 lines
4.9 KiB
C++
/*
|
|
*
|
|
* Copyright (C) 1994-2013, 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 DcmCodeString
|
|
*
|
|
*/
|
|
|
|
|
|
#ifndef DCVRCS_H
|
|
#define DCVRCS_H
|
|
|
|
#include "dcmtk/config/osconfig.h" /* make sure OS specific configuration is included first */
|
|
|
|
#include "dcmtk/dcmdata/dcbytstr.h"
|
|
|
|
|
|
/** a class representing the DICOM value representation 'Code String' (CS)
|
|
*/
|
|
class DCMTK_DCMDATA_EXPORT DcmCodeString
|
|
: public DcmByteString
|
|
{
|
|
|
|
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
|
|
*/
|
|
DcmCodeString(const DcmTag &tag,
|
|
const Uint32 len = 0);
|
|
|
|
/** copy constructor
|
|
* @param old element to be copied
|
|
*/
|
|
DcmCodeString(const DcmCodeString &old);
|
|
|
|
/** destructor
|
|
*/
|
|
virtual ~DcmCodeString();
|
|
|
|
/** assignment operator
|
|
* @param obj element to be assigned/copied
|
|
* @return reference to this object
|
|
*/
|
|
DcmCodeString &operator=(const DcmCodeString &obj);
|
|
|
|
/** clone method
|
|
* @return deep copy of this object
|
|
*/
|
|
virtual DcmObject *clone() const
|
|
{
|
|
return new DcmCodeString(*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_CS)
|
|
*/
|
|
virtual DcmEVR ident() const;
|
|
|
|
/** check whether stored value conforms to the VR and to the specified VM
|
|
* @param vm value multiplicity (according to the data dictionary) to be checked for.
|
|
* (See DcmElement::checkVM() for a list of valid values.)
|
|
* @param oldFormat parameter not used for this VR (only for DA, TM)
|
|
* @return status of the check, EC_Normal if value is correct, an error code otherwise
|
|
*/
|
|
virtual OFCondition checkValue(const OFString &vm = "1-n",
|
|
const OFBool oldFormat = OFFalse);
|
|
|
|
/** 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);
|
|
|
|
/* --- static helper functions --- */
|
|
|
|
/** check whether given value conforms to value representation CS (Code String).
|
|
* Valid characters are: A-Z, 0-9, _ and ' ' (space). The maximum length is 16.
|
|
* NB: This method is only used by the DicomDirInterface class and might be
|
|
* replaced by the following method (checkStringValue) in the future.
|
|
* @param value string value to be checked (single value only)
|
|
* @param pos returns index of first invalid character (0..n-1) if not NULL.
|
|
* Points to trailing zero byte (eos) if value is valid.
|
|
* @param checkLength check maximum length if OFTrue, ignore length if OFFalse
|
|
* @return OFTrue if value is valid, OFFalse otherwise
|
|
*/
|
|
static OFBool checkVR(const OFString &value,
|
|
size_t *pos = NULL,
|
|
const OFBool checkLength = OFTrue);
|
|
|
|
/** check whether given string value conforms to the VR "CS" (Code String)
|
|
* and to the specified VM.
|
|
* @param value string value to be checked (possibly multi-valued)
|
|
* @param vm value multiplicity (according to the data dictionary) to be checked for.
|
|
* (See DcmElement::checkVM() for a list of valid values.)
|
|
* @return status of the check, EC_Normal if value is correct, an error code otherwise
|
|
*/
|
|
static OFCondition checkStringValue(const OFString &value,
|
|
const OFString &vm = "1-n");
|
|
};
|
|
|
|
|
|
#endif // DCVRCS_H
|