OFFIS DCMTK
Version 3.6.0
|
a class representing the DICOM value representation 'Unlimited Text' (UT) More...
Public Member Functions | |
DcmUnlimitedText (const DcmTag &tag, const Uint32 len=0) | |
constructor More... | |
DcmUnlimitedText (const DcmUnlimitedText &old) | |
copy constructor More... | |
virtual | ~DcmUnlimitedText () |
destructor | |
DcmUnlimitedText & | operator= (const DcmUnlimitedText &obj) |
copy assignment operator More... | |
virtual DcmObject * | clone () const |
clone method More... | |
virtual OFCondition | copyFrom (const DcmObject &rhs) |
Virtual object copying. More... | |
virtual DcmEVR | ident () const |
return identifier for this class. More... | |
virtual OFCondition | checkValue (const OFString &vm="", const OFBool oldFormat=OFFalse) |
check whether stored value conforms to the VR and to the specified VM More... | |
virtual unsigned long | getVM () |
get the value multiplicity. More... | |
virtual OFCondition | getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue) |
get a particular components of the string value More... | |
virtual OFCondition | getOFStringArray (OFString &stringVal, OFBool normalize=OFTrue) |
get the string value (all compenents) More... | |
![]() | |
DcmCharString (const DcmTag &tag, const Uint32 len) | |
constructor. More... | |
DcmCharString (const DcmCharString &old) | |
copy constructor More... | |
virtual | ~DcmCharString () |
destructor | |
DcmCharString & | operator= (const DcmCharString &obj) |
assignment operator More... | |
virtual OFBool | containsExtendedCharacters (const OFBool checkAllStrings=OFFalse) |
check if this element contains non-ASCII characters More... | |
virtual OFBool | isAffectedBySpecificCharacterSet () const |
check if this element is affected by SpecificCharacterSet More... | |
![]() | |
DcmByteString (const DcmTag &tag, const Uint32 len=0) | |
constructor. More... | |
DcmByteString (const DcmByteString &old) | |
copy constructor More... | |
virtual | ~DcmByteString () |
destructor | |
DcmByteString & | operator= (const DcmByteString &obj) |
assignment operator More... | |
virtual OFCondition | clear () |
clear the currently stored value More... | |
Uint32 | getRealLength () |
get length of the stored value. More... | |
virtual Uint32 | getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength) |
get DICOM length of the stored value. More... | |
virtual void | print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char *pixelFileName=NULL, size_t *pixelCounter=NULL) |
print element to a stream. More... | |
virtual OFCondition | write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache) |
write data element to a stream More... | |
virtual OFCondition | writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache) |
write data element to a stream as required for the creation of digital signatures More... | |
virtual OFCondition | getString (char *&stringVal) |
get a pointer to the current string value. More... | |
virtual OFCondition | putString (const char *stringVal) |
set element value from the given character string More... | |
virtual OFCondition | putOFStringArray (const OFString &stringVal) |
set element value from the given character string. More... | |
virtual OFCondition | verify (const OFBool autocorrect=OFFalse) |
check the currently stored string value. More... | |
virtual OFBool | isEmpty (const OFBool normalize=OFTrue) |
check if this object is empty More... | |
![]() | |
DcmElement (const DcmTag &tag, const Uint32 len=0) | |
constructor. More... | |
DcmElement (const DcmElement &old) | |
copy constructor More... | |
virtual | ~DcmElement () |
destructor | |
DcmElement & | operator= (const DcmElement &obj) |
assignment operator More... | |
virtual Uint32 | calcElementLength (const E_TransferSyntax xfer, const E_EncodingType enctype) |
calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences. More... | |
virtual OFBool | isLeaf () const |
check if this element is a leaf node in a dataset tree. More... | |
OFBool | valueLoaded () const |
check if value of this element is loaded into main memory More... | |
virtual void | transferInit () |
initialize the transfer state of this object. More... | |
virtual OFBool | canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer) |
check if this DICOM object can be encoded in the given transfer syntax. More... | |
virtual OFCondition | read (DcmInputStream &inStream, const E_TransferSyntax ixfer, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength) |
This function reads the data value of an attribute which is captured in the input stream and captures this information in this. More... | |
virtual OFCondition | writeXML (STD_NAMESPACE ostream &out, const size_t flags=0) |
write object in XML format More... | |
virtual OFCondition | loadAllDataIntoMemory () |
this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory. More... | |
virtual OFCondition | getUint8 (Uint8 &val, const unsigned long pos=0) |
retrieve a single value of type Uint8. More... | |
virtual OFCondition | getSint16 (Sint16 &val, const unsigned long pos=0) |
retrieve a single value of type Sint16. More... | |
virtual OFCondition | getUint16 (Uint16 &val, const unsigned long pos=0) |
retrieve a single value of type Uint16. More... | |
virtual OFCondition | getSint32 (Sint32 &val, const unsigned long pos=0) |
retrieve a single value of type Sint32. More... | |
virtual OFCondition | getUint32 (Uint32 &val, const unsigned long pos=0) |
retrieve a single value of type Uint32. More... | |
virtual OFCondition | getFloat32 (Float32 &val, const unsigned long pos=0) |
retrieve a single value of type Float32. More... | |
virtual OFCondition | getFloat64 (Float64 &val, const unsigned long pos=0) |
retrieve a single value of type Float64. More... | |
virtual OFCondition | getTagVal (DcmTagKey &val, const unsigned long pos=0) |
retrieve a single value of type DcmTagKey. More... | |
virtual OFCondition | getUint8Array (Uint8 *&val) |
get a pointer to the element value of the current element as type string. More... | |
virtual OFCondition | getSint16Array (Sint16 *&val) |
get a pointer to the element value of the current element as type Sint16. More... | |
virtual OFCondition | getUint16Array (Uint16 *&val) |
get a pointer to the element value of the current element as type Uint16. More... | |
virtual OFCondition | getSint32Array (Sint32 *&val) |
get a pointer to the element value of the current element as type Sint32. More... | |
virtual OFCondition | getUint32Array (Uint32 *&val) |
get a pointer to the element value of the current element as type Uint32. More... | |
virtual OFCondition | getFloat32Array (Float32 *&val) |
get a pointer to the element value of the current element as type Float32. More... | |
virtual OFCondition | getFloat64Array (Float64 *&val) |
get a pointer to the element value of the current element as type Float64. More... | |
OFCondition | detachValueField (OFBool copy=OFFalse) |
detach the value field from the DICOM element (i.e., this object). More... | |
virtual OFCondition | putSint16 (const Sint16 val, const unsigned long pos=0) |
insert into the element value a copy of the given Sint16 value. More... | |
virtual OFCondition | putUint16 (const Uint16 val, const unsigned long pos=0) |
insert into the element value a copy of the given Uint16 value. More... | |
virtual OFCondition | putSint32 (const Sint32 val, const unsigned long pos=0) |
insert into the element value a copy of the given Sint32 value. More... | |
virtual OFCondition | putUint32 (const Uint32 val, const unsigned long pos=0) |
insert into the element value a copy of the given Uint32 value. More... | |
virtual OFCondition | putFloat32 (const Float32 val, const unsigned long pos=0) |
insert into the element value a copy of the given Float32 value. More... | |
virtual OFCondition | putFloat64 (const Float64 val, const unsigned long pos=0) |
insert into the element value a copy of the given Float64 value. More... | |
virtual OFCondition | putTagVal (const DcmTagKey &attrTag, const unsigned long pos=0) |
insert into the element value a copy of the given DcmTagKey value. More... | |
virtual OFCondition | putUint8Array (const Uint8 *vals, const unsigned long num) |
replace the element value by a copy of the given Uint8 array (which is possibly multi-valued). More... | |
virtual OFCondition | putSint16Array (const Sint16 *vals, const unsigned long num) |
replace the element value by a copy of the given Sint16 array (which is possibly multi-valued). More... | |
virtual OFCondition | putUint16Array (const Uint16 *vals, const unsigned long num) |
replace the element value by a copy of the given Uint16 array (which is possibly multi-valued). More... | |
virtual OFCondition | putSint32Array (const Sint32 *vals, const unsigned long num) |
replace the element value by a copy of the given Sint32 array (which is possibly multi-valued). More... | |
virtual OFCondition | putUint32Array (const Uint32 *vals, const unsigned long num) |
replace the element value by a copy of the given Uint32 array (which is possibly multi-valued). More... | |
virtual OFCondition | putFloat32Array (const Float32 *vals, const unsigned long num) |
replace the element value by a copy of the given Float32 array (which is possibly multi-valued). More... | |
virtual OFCondition | putFloat64Array (const Float64 *vals, const unsigned long num) |
replace the element value by a copy of the given Float64 array (which is possibly multi-valued). More... | |
virtual OFCondition | getPartialValue (void *targetBuffer, const Uint32 offset, Uint32 numBytes, DcmFileCache *cache=NULL, E_ByteOrder byteOrder=gLocalByteOrder) |
Copy numBytes bytes of data from the attribute value in byteOrder byte order to targetBuffer, starting at byte offset offset of the attribute value. More... | |
virtual OFCondition | createUint8Array (const Uint32 numBytes, Uint8 *&bytes) |
create an empty Uint8 array of given number of bytes and set it. More... | |
virtual OFCondition | createUint16Array (const Uint32 numWords, Uint16 *&words) |
create an empty Uint16 array of given number of words and set it. More... | |
virtual OFCondition | createValueFromTempFile (DcmInputStreamFactory *factory, const Uint32 length, const E_ByteOrder byteOrder) |
replace the attribute value with the content of the given temporary file. More... | |
virtual void | compact () |
remove the attribute value from memory if the attribute value can be loaded from file when needed again. More... | |
virtual OFCondition | getUncompressedFrameSize (DcmItem *dataset, Uint32 &frameSize) const |
compute uncompressed frame size of a single frame of this image. More... | |
virtual OFCondition | getUncompressedFrame (DcmItem *dataset, Uint32 frameNo, Uint32 &startFragment, void *buffer, Uint32 bufSize, OFString &decompressedColorModel, DcmFileCache *cache=NULL) |
access single frame without decompressing or loading a complete multi-frame object. More... | |
virtual OFCondition | getDecompressedColorModel (DcmItem *dataset, OFString &decompressedColorModel) |
determine color model of the decompressed image More... | |
![]() | |
DcmObject (const DcmTag &tag, const Uint32 len=0) | |
constructor. More... | |
DcmObject (const DcmObject &obj) | |
copy constructor More... | |
virtual | ~DcmObject () |
destructor | |
DcmObject & | operator= (const DcmObject &obj) |
copy assignment operator More... | |
DcmEVR | getVR () const |
return the value representation assigned to this object. More... | |
OFBool | isaString () const |
check if this element is a string type, based on the VR. More... | |
E_TransferState | transferState () const |
return the current transfer (read/write) state of this object. More... | |
virtual void | transferEnd (void) |
finalize the transfer state of this object. More... | |
Uint16 | getGTag () const |
return the group number of the attribute tag for this object More... | |
Uint16 | getETag () const |
return the element number of the attribute tag for this object More... | |
const DcmTag & | getTag () const |
return const reference to the attribute tag for this object More... | |
void | setGTag (Uint16 gtag) |
assign group tag (but not element tag) of the attribute tag for this object. More... | |
virtual OFCondition | setVR (DcmEVR) |
assign a new Value Representation (VR) to this object. More... | |
virtual OFBool | isSignable () const |
returns true if the current object may be included in a digital signature More... | |
virtual OFBool | containsUnknownVR () const |
returns true if the object contains an element with Unknown VR at any nesting level More... | |
virtual DcmObject * | nextInContainer (const DcmObject *obj) |
this method is only used in container classes derived from this class, that is, DcmItem and DcmSequenceOfItems. More... | |
virtual OFCondition | nextObject (DcmStack &stack, const OFBool intoSub) |
this method enables a stack based, depth-first traversal of a complete hierarchical DICOM dataset (that is, classes derived from DcmItem or DcmSequenceOfItems). More... | |
virtual OFCondition | search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue) |
a complex, stack-based, hierarchical search method. More... | |
Uint32 | getLengthField () const |
return the current value of the Length field (which is different from the functionality of the public getLength method). More... | |
Static Public Member Functions | |
static OFCondition | checkStringValue (const OFString &value) |
check whether given string value conforms to the VR "UT" (Unlimited Text) More... | |
![]() | |
static int | scanValue (const OFString &value, const OFString &vr, const size_t pos=0, const size_t num=OFString_npos) |
scan string value for conformance with given value representation (VR) More... | |
Additional Inherited Members | |
![]() | |
virtual Uint8 * | newValueField () |
create a new value field (string buffer) of the previously defined size (member variable 'Length'). More... | |
virtual void | postLoadValue () |
method is called after the element value has been loaded. More... | |
virtual OFCondition | makeMachineByteString () |
convert currently stored string value to internal representation. More... | |
OFCondition | makeDicomByteString () |
convert currently stored string value to DICOM representation. More... | |
OFCondition | getStringValue (OFString &stringVal) |
get a copy of the current string value. More... | |
void | setPaddingChar (char c) |
set the end-of-string padding character More... | |
void | setMaxLength (Uint32 val) |
set the maximum number of characters for each string component More... | |
void | setNonSignificantChars (const OFString &characters) |
set non-significant characters used to determine whether the value is empty More... | |
![]() | |
void * | getValue (const E_ByteOrder newByteOrder=gLocalByteOrder) |
This function returns this element's value. More... | |
OFCondition | changeValue (const void *value, const Uint32 position, const Uint32 num) |
insert into the element value a copy of the given raw value. More... | |
OFCondition | putValue (const void *value, const Uint32 length) |
replace the element value by a copy of the given raw data block More... | |
OFCondition | createEmptyValue (const Uint32 length) |
create a new, empty value field of given size. More... | |
OFCondition | loadValue (DcmInputStream *inStream=NULL) |
This function reads the data value of an attribute and stores the information which was read in this. More... | |
void | swapValueField (size_t valueWidth) |
swaps the content of the value field (if loaded) from big-endian to little-endian or back More... | |
virtual void | writeXMLStartTag (STD_NAMESPACE ostream &out, const size_t flags, const char *attrText=NULL) |
write element start tag in XML format More... | |
virtual void | writeXMLEndTag (STD_NAMESPACE ostream &out, const size_t flags) |
write element end tag in XML format More... | |
E_ByteOrder | getByteOrder () const |
return the current byte order of the value field More... | |
void | setByteOrder (E_ByteOrder val) |
set the current byte order of the value field More... | |
![]() | |
void | printNestingLevel (STD_NAMESPACE ostream &out, const size_t flags, const int level) |
print line indentation, e.g. More... | |
void | printInfoLineStart (STD_NAMESPACE ostream &out, const size_t flags, const int level, DcmTag *tag=NULL) |
print beginning of the info line. More... | |
void | printInfoLineEnd (STD_NAMESPACE ostream &out, const size_t flags, const unsigned long printedLength=0xffffffff, DcmTag *tag=NULL) |
print end of the info line. More... | |
virtual void | printInfoLine (STD_NAMESPACE ostream &out, const size_t flags, const int level=0, const char *info=NULL, DcmTag *tag=NULL, const OFBool isInfo=OFTrue) |
print given text with element information. More... | |
virtual OFCondition | writeTagAndLength (DcmOutputStream &outStream, const E_TransferSyntax oxfer, Uint32 &writtenBytes) const |
write tag, VR and length field to the given output stream More... | |
virtual Uint32 | getTagAndLengthSize (const E_TransferSyntax oxfer) const |
return the number of bytes needed to serialize the tag, VR and length information of the current object using the given transfer syntax. More... | |
const char * | getTagName () |
return the DICOM attribute tag name for this object. More... | |
void | setTagVR (DcmEVR vr) |
set the VR for this attribute More... | |
E_TransferState | getTransferState () const |
return the current transfer state of this object during serialization/deserialization More... | |
void | setTransferState (E_TransferState newState) |
set the current transfer state of this object during serialization/deserialization More... | |
Uint32 | getTransferredBytes () const |
return the number of transferred bytes for this object during serialization/deserialization More... | |
void | setTransferredBytes (Uint32 val) |
set the number of transferred bytes for this object during serialization/deserialization More... | |
void | incTransferredBytes (Uint32 val) |
add to the number of transferred bytes for this object during serialization/deserialization More... | |
void | setLengthField (Uint32 val) |
set the current value of the Length field More... | |
![]() | |
static OFCondition | checkStringValue (const OFString &value, const OFString &vm, const OFString &vr, const int vrID, const size_t maxLen=0) |
check whether given string value conforms to a certain VR and VM. More... | |
![]() | |
static OFCondition | checkVM (const unsigned long vmNum, const OFString &vmStr) |
check for correct value multiplicity (VM) More... | |
![]() | |
static OFCondition | writeTag (DcmOutputStream &outStream, const DcmTag &tag, const E_TransferSyntax oxfer) |
static helper function that writes a given attribute tag to a binary output stream using the byte order indicated by the transfer syntax. More... | |
![]() | |
OFCondition | errorFlag |
error flag for this object. | |
a class representing the DICOM value representation 'Unlimited Text' (UT)
DcmUnlimitedText::DcmUnlimitedText | ( | const DcmTag & | tag, |
const Uint32 | len = 0 |
||
) |
DcmUnlimitedText::DcmUnlimitedText | ( | const DcmUnlimitedText & | old | ) |
copy constructor
old | element to be copied |
|
static |
check whether given string value conforms to the VR "UT" (Unlimited Text)
value | string value to be checked (possibly multi-valued) |
Referenced by clone().
|
virtual |
check whether stored value conforms to the VR and to the specified VM
vm | parameter not used for this VR |
oldFormat | parameter not used for this VR (only for DA, TM, PN) |
Reimplemented from DcmElement.
Referenced by clone().
|
inlinevirtual |
clone method
Reimplemented from DcmCharString.
Definition at line 71 of file dcvrut.h.
References checkStringValue(), checkValue(), copyFrom(), DcmUnlimitedText(), getOFString(), getOFStringArray(), getVM(), and ident().
|
virtual |
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.
rhs | - [in] The instance to copy from. Has to be of the same class type as "this" object |
Reimplemented from DcmCharString.
Referenced by clone().
|
virtual |
get a particular components of the string value
stringVal | string variable in which the result value is stored |
pos | not used since value multiplicity is always 1 |
normalize | remove trailing spaces if OFTrue |
Reimplemented from DcmByteString.
Referenced by clone().
|
virtual |
get the string value (all compenents)
stringVal | string variable in which the result value is stored |
normalize | remove trailing spaces if OFTrue |
Reimplemented from DcmElement.
Referenced by clone().
|
virtual |
get the value multiplicity.
Since the backslash "\" is not regarded as a separator the value multiplicity is always 1.
Reimplemented from DcmByteString.
Referenced by clone().
|
virtual |
return identifier for this class.
Every class derived from this class returns a unique value of type enum DcmEVR for this call. This is used as a "poor man's RTTI" to correctly identify instances derived from this class even on compilers not supporting RTTI.
Reimplemented from DcmByteString.
Referenced by clone().
DcmUnlimitedText& DcmUnlimitedText::operator= | ( | const DcmUnlimitedText & | obj | ) |
copy assignment operator
obj | element to be copied |