DCMTK
Version 3.6.1 20160216
OFFIS DICOM Toolkit
|
base class for all DICOM value representations storing a character string More...
Public Member Functions | |
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 int | compare (const DcmElement &rhs) const |
comparison operator that compares the normalized value of this object with a given object of the same type. More... | |
virtual DcmObject * | clone () const |
clone method More... | |
virtual OFCondition | copyFrom (const DcmObject &rhs) |
Virtual object copying. More... | |
virtual DcmEVR | ident () const |
get element type identifier More... | |
virtual OFCondition | clear () |
clear the currently stored value More... | |
virtual unsigned long | getVM () |
get value multiplicity 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 | getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue) |
get a copy of a particular string component More... | |
virtual OFCondition | getOFStringArray (OFString &stringVal, OFBool normalize=OFTrue) |
get entire element value as a character string. More... | |
virtual OFCondition | getString (char *&stringVal) |
get a pointer to the current string value. More... | |
virtual OFCondition | getString (char *&stringVal, Uint32 &stringLen) |
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 | putString (const char *stringVal, const Uint32 stringLen) |
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 | 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... | |
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 | checkValue (const OFString &vm="1-n", const OFBool oldFormat=OFFalse) |
check whether stored value conforms to the VR and to the specified VM 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 | putOFStringArray (const OFString &val) |
replace the element value by a copy of the given string (which is possibly multi-valued). 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... | |
virtual OFBool | isNested () const |
check if this element is nested in a sequence of items, i.e. not a top-level or stand-alone element 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... | |
DcmItem * | getRootItem () |
get root dataset/item (top-level) that contains this object. More... | |
virtual DcmItem * | getParentItem () |
get parent item of this object. More... | |
DcmObject * | getParent () |
get parent of this object. More... | |
const DcmObject * | getParent () const |
get parent of this object. More... | |
void | setParent (DcmObject *parent) |
set parent 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 OFCondition | convertCharacterSet (DcmSpecificCharacterSet &converter) |
convert this object from the currently selected source character set to the currently selected destination character set (if affected by SpecificCharacterSet) 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... | |
Protected Types |
Protected Member Functions | |
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... | |
E_StringMode | getStringMode () const |
get current representation of the string value More... | |
virtual OFCondition | makeMachineByteString (const Uint32 length=0) |
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... | |
Uint32 | getMaxLength () const |
get the maximum number of characters for each string component More... | |
char | getPaddingChar () const |
get the end-of-string padding character 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. a couple of spaces for each nesting level. 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 Protected Member Functions | |
static OFCondition | checkStringValue (const OFString &value, const OFString &vm, const OFString &vr, const int vrID, const size_t maxLen=0, const OFString &charset="") |
check whether given string value conforms to a certain VR and 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... | |
Private Attributes | |
char | paddingChar |
padding character used to adjust odd value length (e.g. a space) | |
Uint32 | maxLength |
maximum number of characters for each string component | |
Uint32 | realLength |
number of characters of the internal string representation | |
E_StringMode | fStringMode |
current representation of the string value | |
OFString | nonSignificantChars |
non-significant characters used to determine whether the value is empty | |
Additional Inherited Members | |
![]() | |
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... | |
static unsigned long | determineVM (const char *str, const size_t len) |
determine the number of values stored in a string, i.e. the value multiplicity (VM) More... | |
static size_t | getValueFromString (const char *str, const size_t pos, const size_t len, OFString &val) |
get the first value stored in the given string. More... | |
static OFCondition | checkVM (const unsigned long vmNum, const OFString &vmStr) |
check for correct value multiplicity (VM) More... | |
![]() | |
OFCondition | errorFlag |
error flag for this object. | |
base class for all DICOM value representations storing a character string
|
protected |
DcmByteString::DcmByteString | ( | const DcmTag & | tag, |
const Uint32 | len = 0 |
||
) |
constructor.
Create new element from given tag and length.
tag | DICOM tag for the new element |
len | value length for the new element |
DcmByteString::DcmByteString | ( | const DcmByteString & | old | ) |
copy constructor
old | element to be copied |
|
staticprotected |
check whether given string value conforms to a certain VR and VM.
value | string value to be checked (possibly multi-valued) |
vm | value multiplicity (according to the data dictionary) to be checked for. (See DcmElement::checkVM() for a list of valid values; "" for no check.) |
vr | two-character identifier of the VR to be checked (lower case) |
vrID | expected numeric identifier of the VR |
maxLen | maximum number of characters allowed for a single value (0 = no check) |
charset | character set (according to the value of the SpecificCharacterSet element) to be used for checking the string value. The default is ASCII (7-bit). Currently, the VR checker only supports ASCII (ISO_IR 6) and Latin-1 (ISO_IR 100). All other values disable the check of the value representation, e.g. "UNKNOWN". |
Referenced by DcmLongText::clone(), DcmIntegerString::clone(), DcmUnlimitedText::clone(), DcmUniqueIdentifier::clone(), DcmShortText::clone(), DcmUnlimitedCharacters::clone(), DcmUniversalResourceIdentifierOrLocator::clone(), DcmShortString::clone(), DcmLongString::clone(), DcmAgeString::clone(), DcmDate::clone(), DcmCodeString::clone(), DcmDateTime::clone(), DcmPersonName::clone(), DcmApplicationEntity::clone(), DcmDecimalString::clone(), and DcmTime::clone().
|
virtual |
clear the currently stored value
Reimplemented from DcmElement.
|
inlinevirtual |
clone method
Implements DcmObject.
Reimplemented in DcmCharString, DcmDecimalString, DcmTime, DcmApplicationEntity, DcmAgeString, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, DcmShortString, DcmUniversalResourceIdentifierOrLocator, DcmIntegerString, DcmShortText, DcmUnlimitedCharacters, DcmUniqueIdentifier, DcmUnlimitedText, and DcmLongText.
References DcmElement::clear(), DcmObject::containsExtendedCharacters(), DcmElement::copyFrom(), EET_UndefinedLength, EXS_LittleEndianImplicit, DcmElement::getLength(), DcmElement::getOFString(), DcmElement::getOFStringArray(), DcmElement::getString(), DcmObject::getVM(), DcmObject::ident(), DcmObject::isAffectedBySpecificCharacterSet(), DcmObject::isEmpty(), DcmObject::print(), DcmElement::putString(), DcmObject::verify(), DcmElement::write(), and DcmElement::writeSignatureFormat().
|
virtual |
comparison operator that compares the normalized value of this object with a given object of the same type.
The tag of the element is also considered as the first component that is compared, followed by the object types (VR, i.e. DCMTK'S EVR) and the comparison of all value components of the object, preferrably in the order declared in the object (if applicable).
rhs | the right hand side of the comparison |
Implements DcmElement.
|
virtual |
check if this element contains non-ASCII characters.
Please note that this check is pretty simple and only works for single-byte character sets that do include the 7-bit ASCII codes, e.g. for the ISO 8859 family. In other words: All character codes below 128 are considered to be ASCII codes and all others are considered to be non-ASCII.
checkAllStrings | if true, also check elements with string values not affected by SpecificCharacterSet (0008,0005). By default, only check PN, LO, LT, SH, ST, UC and UT, i.e. none of the derived VR classes. |
Reimplemented from DcmObject.
Reimplemented in DcmCharString.
Referenced by DcmCharString::clone().
|
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 DcmElement.
Reimplemented in DcmCharString, DcmDecimalString, DcmTime, DcmApplicationEntity, DcmAgeString, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, DcmShortString, DcmUniversalResourceIdentifierOrLocator, DcmIntegerString, DcmShortText, DcmUnlimitedCharacters, DcmUniqueIdentifier, DcmUnlimitedText, and DcmLongText.
Referenced by DcmIntegerString::clone(), DcmUniqueIdentifier::clone(), DcmDate::clone(), DcmUniversalResourceIdentifierOrLocator::clone(), DcmCodeString::clone(), DcmDateTime::clone(), DcmApplicationEntity::clone(), DcmAgeString::clone(), DcmTime::clone(), DcmDecimalString::clone(), and DcmCharString::clone().
|
virtual |
get DICOM length of the stored value.
The string value is padded if required. Therefore, the returned length always has an even value.
xfer | not used |
enctype | not used |
Reimplemented from DcmElement.
|
inlineprotected |
get the maximum number of characters for each string component
|
virtual |
get a copy of a particular string component
stringVal | variable in which the result value is stored |
pos | index of the value in case of multi-valued elements (0..vm-1) |
normalize | not used since string normalization depends on value representation |
Reimplemented from DcmElement.
Reimplemented in DcmDecimalString, DcmUniqueIdentifier, DcmIntegerString, DcmUniversalResourceIdentifierOrLocator, DcmShortText, DcmUnlimitedText, DcmLongText, DcmTime, DcmApplicationEntity, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, DcmShortString, and DcmUnlimitedCharacters.
Referenced by DcmLongText::clone(), DcmIntegerString::clone(), DcmUnlimitedText::clone(), DcmShortText::clone(), DcmUnlimitedCharacters::clone(), DcmUniqueIdentifier::clone(), DcmDateTime::clone(), DcmShortString::clone(), DcmPersonName::clone(), DcmLongString::clone(), DcmDate::clone(), DcmCodeString::clone(), DcmUniversalResourceIdentifierOrLocator::clone(), DcmApplicationEntity::clone(), DcmDecimalString::clone(), and DcmTime::clone().
|
virtual |
get entire element value as a character string.
In case of VM > 1 the individual values are separated by a backslash ('\').
stringVal | variable in which the result value is stored |
normalize | normalize each element value prior to concatenation |
Reimplemented from DcmElement.
Reimplemented in DcmUniversalResourceIdentifierOrLocator, DcmShortText, DcmUnlimitedText, and DcmLongText.
Referenced by DcmLongText::clone(), DcmUnlimitedText::clone(), DcmShortText::clone(), and DcmUniversalResourceIdentifierOrLocator::clone().
|
inlineprotected |
get the end-of-string padding character
Uint32 DcmByteString::getRealLength | ( | ) |
get length of the stored value.
Trailing spaces (padding characters) are ignored for the "real" length.
|
virtual |
get a pointer to the current string value.
This includes all string components and separators. NB: This method does not copy the stored value.
stringVal | reference to the pointer variable |
Reimplemented from DcmElement.
|
virtual |
get a pointer to the current string value.
This includes all string components and separators. Since the length is returned separately, the string value can contain more than one NULL byte. NB: This method does not copy the stored value.
stringVal | reference to the pointer variable |
stringLen | length of the string (number of characters without the trailing NULL byte) |
Reimplemented from DcmElement.
|
inlineprotected |
get current representation of the string value
|
protected |
get a copy of the current string value.
This includes all string components and separators.
stringVal | variable in which the result is stored |
|
virtual |
get value multiplicity
Implements DcmObject.
Reimplemented in DcmUniversalResourceIdentifierOrLocator, DcmShortText, DcmUnlimitedText, and DcmLongText.
Referenced by DcmLongText::clone(), DcmUnlimitedText::clone(), DcmShortText::clone(), and DcmUniversalResourceIdentifierOrLocator::clone().
|
virtual |
get element type identifier
Implements DcmObject.
Reimplemented in DcmDecimalString, DcmTime, DcmApplicationEntity, DcmAgeString, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, DcmShortString, DcmUniversalResourceIdentifierOrLocator, DcmIntegerString, DcmShortText, DcmUnlimitedCharacters, DcmUniqueIdentifier, DcmUnlimitedText, and DcmLongText.
Referenced by DcmLongText::clone(), DcmIntegerString::clone(), DcmUnlimitedText::clone(), DcmUniqueIdentifier::clone(), DcmShortText::clone(), DcmUnlimitedCharacters::clone(), DcmUniversalResourceIdentifierOrLocator::clone(), DcmShortString::clone(), DcmLongString::clone(), DcmAgeString::clone(), DcmDate::clone(), DcmCodeString::clone(), DcmDateTime::clone(), DcmPersonName::clone(), DcmApplicationEntity::clone(), DcmDecimalString::clone(), and DcmTime::clone().
|
virtual |
check if this element is affected by SpecificCharacterSet
Reimplemented from DcmObject.
Reimplemented in DcmCharString.
Referenced by DcmCharString::clone().
check if this object is empty
normalize | normalize value before checking (ignore non-significant characters) |
Reimplemented from DcmObject.
|
protected |
convert currently stored string value to DICOM representation.
It removes trailing spaces apart from a possibly required single padding character (in case of odd string length).
|
protectedvirtual |
convert currently stored string value to internal representation.
It removes any trailing space character and recomputes the string length.
length | number of characters of the string value (optional) |
Reimplemented in DcmUniqueIdentifier.
Referenced by DcmUniqueIdentifier::clone().
|
protectedvirtual |
create a new value field (string buffer) of the previously defined size (member variable 'Length').
Also handles odd value length by allocating extra space for the padding character. This method is used by derived classes only.
Reimplemented from DcmElement.
DcmByteString& DcmByteString::operator= | ( | const DcmByteString & | obj | ) |
assignment operator
obj | element to be assigned/copied |
|
protectedvirtual |
method is called after the element value has been loaded.
Can be used to correct the value before it is used for the first time.
Reimplemented from DcmElement.
|
virtual |
print element to a stream.
The output format of the value is a backslash separated sequence of string components (if any).
out | output stream |
flags | optional flag used to customize the output (see DCMTypes::PF_xxx) |
level | current level of nested items. Used for indentation. |
pixelFileName | not used |
pixelCounter | not used |
Implements DcmObject.
Reimplemented in DcmUniqueIdentifier.
Referenced by DcmUniqueIdentifier::clone().
|
virtual |
set element value from the given character string.
The length of the given string is determined automatically by searching for the first NULL byte.
stringVal | input character string (possibly multi-valued) |
Reimplemented from DcmElement.
Reimplemented in DcmUniqueIdentifier.
Referenced by DcmUniqueIdentifier::clone().
|
virtual |
set element value from the given character string.
The length of the string has to be specified explicitly. The string can, therefore, also contain more than one NULL byte.
stringVal | input character string (possibly multi-valued) |
stringLen | length of the string (number of characters without the trailing NULL byte) |
Reimplemented from DcmElement.
Reimplemented in DcmUniqueIdentifier.
|
inlineprotected |
set the maximum number of characters for each string component
val | maximum number of characters for each string component |
|
inlineprotected |
set non-significant characters used to determine whether the value is empty
characters | non-significant characters used to determine whether the value is empty |
|
inlineprotected |
set the end-of-string padding character
c | end-of-string padding character |
|
virtual |
check the currently stored string value.
Checks every string component for the maximum length specified for the particular value representation.
autocorrect | correct value and value component length if OFTrue |
Implements DcmObject.
Reimplemented in DcmCharString.
Referenced by DcmCharString::clone().
|
virtual |
write data element to a stream
outStream | output stream |
oxfer | transfer syntax used to write the data |
enctype | flag, specifying the encoding with undefined or explicit length |
wcache | pointer to write cache object, may be NULL |
Reimplemented from DcmElement.
|
virtual |
write data element to a stream as required for the creation of digital signatures
outStream | output stream |
oxfer | transfer syntax used to write the data |
enctype | flag, specifying the encoding with undefined or explicit length |
wcache | pointer to write cache object, may be NULL |
Reimplemented from DcmElement.