OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Private Types | Private Attributes | List of all members
DcmByteString Class Reference

base class for all DICOM value representations storing a character string More...

Inheritance diagram for DcmByteString:
[legend]
Collaboration diagram for DcmByteString:
[legend]

Public Member Functions

 DcmByteString (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmByteString (const DcmByteString &old)
 copy constructor
 
virtual ~DcmByteString ()
 destructor
 
DcmByteStringoperator= (const DcmByteString &obj)
 assignment operator
 
virtual DcmObjectclone () const
 clone method
 
virtual OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying.
 
virtual DcmEVR ident () const
 get element type identifier
 
virtual OFCondition clear ()
 clear the currently stored value
 
virtual unsigned long getVM ()
 get value multiplicity
 
Uint32 getRealLength ()
 get length of the stored value.
 
virtual Uint32 getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)
 get DICOM length of the stored value.
 
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.
 
virtual OFCondition write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 write data element to a stream
 
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
 
virtual OFCondition getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
 get a copy of a particular string component
 
virtual OFCondition getString (char *&stringVal)
 get a pointer to the current string value.
 
virtual OFCondition putString (const char *stringVal)
 set element value from the given character string
 
virtual OFCondition putOFStringArray (const OFString &stringVal)
 set element value from the given character string.
 
virtual OFCondition verify (const OFBool autocorrect=OFFalse)
 check the currently stored string value.
 
virtual OFBool containsExtendedCharacters (const OFBool checkAllStrings=OFFalse)
 check if this element contains non-ASCII characters
 
virtual OFBool isAffectedBySpecificCharacterSet () const
 check if this element is affected by SpecificCharacterSet
 
virtual OFBool isEmpty (const OFBool normalize=OFTrue)
 check if this object is empty
 
- Public Member Functions inherited from DcmElement
 DcmElement (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmElement (const DcmElement &old)
 copy constructor
 
virtual ~DcmElement ()
 destructor
 
DcmElementoperator= (const DcmElement &obj)
 assignment operator
 
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.
 
virtual OFBool isLeaf () const
 check if this element is a leaf node in a dataset tree.
 
OFBool valueLoaded () const
 check if value of this element is loaded into main memory
 
virtual void transferInit ()
 initialize the transfer state of this object.
 
virtual OFBool canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer)
 check if this DICOM object can be encoded in the given transfer syntax.
 
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.
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
 write object in XML format
 
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
 
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.
 
virtual OFCondition getUint8 (Uint8 &val, const unsigned long pos=0)
 retrieve a single value of type Uint8.
 
virtual OFCondition getSint16 (Sint16 &val, const unsigned long pos=0)
 retrieve a single value of type Sint16.
 
virtual OFCondition getUint16 (Uint16 &val, const unsigned long pos=0)
 retrieve a single value of type Uint16.
 
virtual OFCondition getSint32 (Sint32 &val, const unsigned long pos=0)
 retrieve a single value of type Sint32.
 
virtual OFCondition getUint32 (Uint32 &val, const unsigned long pos=0)
 retrieve a single value of type Uint32.
 
virtual OFCondition getFloat32 (Float32 &val, const unsigned long pos=0)
 retrieve a single value of type Float32.
 
virtual OFCondition getFloat64 (Float64 &val, const unsigned long pos=0)
 retrieve a single value of type Float64.
 
virtual OFCondition getTagVal (DcmTagKey &val, const unsigned long pos=0)
 retrieve a single value of type DcmTagKey.
 
virtual OFCondition getOFStringArray (OFString &value, OFBool normalize=OFTrue)
 get entire element value as a character string.
 
virtual OFCondition getUint8Array (Uint8 *&val)
 get a pointer to the element value of the current element as type string.
 
virtual OFCondition getSint16Array (Sint16 *&val)
 get a pointer to the element value of the current element as type Sint16.
 
virtual OFCondition getUint16Array (Uint16 *&val)
 get a pointer to the element value of the current element as type Uint16.
 
virtual OFCondition getSint32Array (Sint32 *&val)
 get a pointer to the element value of the current element as type Sint32.
 
virtual OFCondition getUint32Array (Uint32 *&val)
 get a pointer to the element value of the current element as type Uint32.
 
virtual OFCondition getFloat32Array (Float32 *&val)
 get a pointer to the element value of the current element as type Float32.
 
virtual OFCondition getFloat64Array (Float64 *&val)
 get a pointer to the element value of the current element as type Float64.
 
OFCondition detachValueField (OFBool copy=OFFalse)
 detach the value field from the DICOM element (i.e., this object).
 
virtual OFCondition putSint16 (const Sint16 val, const unsigned long pos=0)
 insert into the element value a copy of the given Sint16 value.
 
virtual OFCondition putUint16 (const Uint16 val, const unsigned long pos=0)
 insert into the element value a copy of the given Uint16 value.
 
virtual OFCondition putSint32 (const Sint32 val, const unsigned long pos=0)
 insert into the element value a copy of the given Sint32 value.
 
virtual OFCondition putUint32 (const Uint32 val, const unsigned long pos=0)
 insert into the element value a copy of the given Uint32 value.
 
virtual OFCondition putFloat32 (const Float32 val, const unsigned long pos=0)
 insert into the element value a copy of the given Float32 value.
 
virtual OFCondition putFloat64 (const Float64 val, const unsigned long pos=0)
 insert into the element value a copy of the given Float64 value.
 
virtual OFCondition putTagVal (const DcmTagKey &attrTag, const unsigned long pos=0)
 insert into the element value a copy of the given DcmTagKey value.
 
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).
 
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).
 
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).
 
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).
 
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).
 
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).
 
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).
 
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.
 
virtual OFCondition createUint8Array (const Uint32 numBytes, Uint8 *&bytes)
 create an empty Uint8 array of given number of bytes and set it.
 
virtual OFCondition createUint16Array (const Uint32 numWords, Uint16 *&words)
 create an empty Uint16 array of given number of words and set it.
 
virtual OFCondition createValueFromTempFile (DcmInputStreamFactory *factory, const Uint32 length, const E_ByteOrder byteOrder)
 replace the attribute value with the content of the given temporary file.
 
virtual void compact ()
 remove the attribute value from memory if the attribute value can be loaded from file when needed again.
 
virtual OFCondition getUncompressedFrameSize (DcmItem *dataset, Uint32 &frameSize) const
 compute uncompressed frame size of a single frame of this image.
 
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.
 
virtual OFCondition getDecompressedColorModel (DcmItem *dataset, OFString &decompressedColorModel)
 determine color model of the decompressed image
 
- Public Member Functions inherited from DcmObject
 DcmObject (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmObject (const DcmObject &obj)
 copy constructor
 
virtual ~DcmObject ()
 destructor
 
DcmObjectoperator= (const DcmObject &obj)
 copy assignment operator
 
DcmEVR getVR () const
 return the value representation assigned to this object.
 
OFBool isaString () const
 check if this element is a string type, based on the VR.
 
E_TransferState transferState () const
 return the current transfer (read/write) state of this object.
 
virtual void transferEnd (void)
 finalize the transfer state of this object.
 
Uint16 getGTag () const
 return the group number of the attribute tag for this object
 
Uint16 getETag () const
 return the element number of the attribute tag for this object
 
const DcmTaggetTag () const
 return const reference to the attribute tag for this object
 
void setGTag (Uint16 gtag)
 assign group tag (but not element tag) of the attribute tag for this object.
 
virtual OFCondition setVR (DcmEVR)
 assign a new Value Representation (VR) to this object.
 
virtual OFBool isSignable () const
 returns true if the current object may be included in a digital signature
 
virtual OFBool containsUnknownVR () const
 returns true if the object contains an element with Unknown VR at any nesting level
 
virtual DcmObjectnextInContainer (const DcmObject *obj)
 this method is only used in container classes derived from this class, that is, DcmItem and DcmSequenceOfItems.
 
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).
 
virtual OFCondition search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue)
 a complex, stack-based, hierarchical search method.
 
Uint32 getLengthField () const
 return the current value of the Length field (which is different from the functionality of the public getLength method).
 

Protected Member Functions

virtual Uint8 * newValueField ()
 create a new value field (string buffer) of the previously defined size (member variable 'Length').
 
virtual void postLoadValue ()
 method is called after the element value has been loaded.
 
virtual OFCondition makeMachineByteString ()
 convert currently stored string value to internal representation.
 
OFCondition makeDicomByteString ()
 convert currently stored string value to DICOM representation.
 
OFCondition getStringValue (OFString &stringVal)
 get a copy of the current string value.
 
void setPaddingChar (char c)
 set the end-of-string padding character
 
void setMaxLength (Uint32 val)
 set the maximum number of characters for each string component
 
void setNonSignificantChars (const OFString &characters)
 set non-significant characters used to determine whether the value is empty
 
- Protected Member Functions inherited from DcmElement
void * getValue (const E_ByteOrder newByteOrder=gLocalByteOrder)
 This function returns this element's value.
 
OFCondition changeValue (const void *value, const Uint32 position, const Uint32 num)
 insert into the element value a copy of the given raw value.
 
OFCondition putValue (const void *value, const Uint32 length)
 replace the element value by a copy of the given raw data block
 
OFCondition createEmptyValue (const Uint32 length)
 create a new, empty value field of given size.
 
OFCondition loadValue (DcmInputStream *inStream=NULL)
 This function reads the data value of an attribute and stores the information which was read in this.
 
void swapValueField (size_t valueWidth)
 swaps the content of the value field (if loaded) from big-endian to little-endian or back
 
virtual void writeXMLStartTag (STD_NAMESPACE ostream &out, const size_t flags, const char *attrText=NULL)
 write element start tag in XML format
 
virtual void writeXMLEndTag (STD_NAMESPACE ostream &out, const size_t flags)
 write element end tag in XML format
 
E_ByteOrder getByteOrder () const
 return the current byte order of the value field
 
void setByteOrder (E_ByteOrder val)
 set the current byte order of the value field
 
- Protected Member Functions inherited from DcmObject
void printNestingLevel (STD_NAMESPACE ostream &out, const size_t flags, const int level)
 print line indentation, e.g.
 
void printInfoLineStart (STD_NAMESPACE ostream &out, const size_t flags, const int level, DcmTag *tag=NULL)
 print beginning of the info line.
 
void printInfoLineEnd (STD_NAMESPACE ostream &out, const size_t flags, const unsigned long printedLength=0xffffffff, DcmTag *tag=NULL)
 print end of the info line.
 
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.
 
virtual OFCondition writeTagAndLength (DcmOutputStream &outStream, const E_TransferSyntax oxfer, Uint32 &writtenBytes) const
 write tag, VR and length field to the given output stream
 
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.
 
const char * getTagName ()
 return the DICOM attribute tag name for this object.
 
void setTagVR (DcmEVR vr)
 set the VR for this attribute
 
E_TransferState getTransferState () const
 return the current transfer state of this object during serialization/deserialization
 
void setTransferState (E_TransferState newState)
 set the current transfer state of this object during serialization/deserialization
 
Uint32 getTransferredBytes () const
 return the number of transferred bytes for this object during serialization/deserialization
 
void setTransferredBytes (Uint32 val)
 set the number of transferred bytes for this object during serialization/deserialization
 
void incTransferredBytes (Uint32 val)
 add to the number of transferred bytes for this object during serialization/deserialization
 
void setLengthField (Uint32 val)
 set the current value of the Length field
 

Static Protected Member Functions

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.
 
- Static Protected Member Functions inherited from DcmElement
static OFCondition checkVM (const unsigned long vmNum, const OFString &vmStr)
 check for correct value multiplicity (VM)
 
- Static Protected Member Functions inherited from DcmObject
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.
 

Private Types

enum  E_StringMode { DCM_MachineString, DCM_DicomString, DCM_UnknownString }
 internal type used to specify the current string representation More...
 

Private Attributes

char paddingChar
 padding character used to adjust odd value length (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 Public Member Functions inherited from DcmElement
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)
 
- Protected Attributes inherited from DcmObject
OFCondition errorFlag
 error flag for this object.
 

Detailed Description

base class for all DICOM value representations storing a character string

Definition at line 42 of file dcbytstr.h.

Member Enumeration Documentation

internal type used to specify the current string representation

Enumerator:
DCM_MachineString 

string has internal representation (no padding)

DCM_DicomString 

string has DICOM representation (even length)

DCM_UnknownString 

string has unknown representation (maybe multiple padding chars?)

Definition at line 46 of file dcbytstr.h.

Constructor & Destructor Documentation

DcmByteString::DcmByteString ( const DcmTag tag,
const Uint32  len = 0 
)

constructor.

Create new element from given tag and length.

Parameters
tagDICOM tag for the new element
lenvalue length for the new element

Referenced by clone().

DcmByteString::DcmByteString ( const DcmByteString old)

copy constructor

Parameters
oldelement to be copied

Member Function Documentation

static OFCondition DcmByteString::checkStringValue ( const OFString value,
const OFString vm,
const OFString vr,
const int  vrID,
const size_t  maxLen = 0 
)
staticprotected

check whether given string value conforms to a certain VR and VM.

Parameters
valuestring value to be checked (possibly multi-valued)
vmvalue multiplicity (according to the data dictionary) to be checked for. (valid values: "1", "1-2", "1-3", "1-8", "1-99", "1-n", "2", "2-n", "2-2n", "3", "3-n", "3-3n", "4", "6", "9", "16", "32" or "" for no check)
vrtwo-character identifier of the VR to be checked (lower case)
vrIDexpected numeric identifier of the VR
maxLenmaximum number of characters allowed for a single value (0 = no check)
Returns
status of the check, EC_Normal if value is correct, an error code otherwise
virtual OFCondition DcmByteString::clear ( )
virtual

clear the currently stored value

Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

Referenced by DVPSStoredPrint::clearInstanceUID().

virtual DcmObject* DcmByteString::clone ( ) const
inlinevirtual
virtual OFBool DcmByteString::containsExtendedCharacters ( const OFBool  checkAllStrings = OFFalse)
virtual

check if this element contains non-ASCII characters

Parameters
checkAllStringsif true, also check elements with string values not affected by SpecificCharacterSet (0008,0005), default: only check PN, LO, LT, SH, ST, UT
Returns
true if element contains non-ASCII characters, false otherwise

Reimplemented from DcmObject.

Reimplemented in DcmCharString.

virtual OFCondition DcmByteString::copyFrom ( const DcmObject rhs)
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.

Parameters
rhs- [in] The instance to copy from. Has to be of the same class type as "this" object
Returns
EC_Normal if copying was successful, error otherwise

Reimplemented from DcmElement.

Reimplemented in DcmCharString, DcmDecimalString, DcmTime, DcmApplicationEntity, DcmAgeString, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, DcmShortString, DcmIntegerString, DcmShortText, DcmUniqueIdentifier, DcmUnlimitedText, and DcmLongText.

virtual Uint32 DcmByteString::getLength ( const E_TransferSyntax  xfer = EXS_LittleEndianImplicit,
const E_EncodingType  enctype = EET_UndefinedLength 
)
virtual

get DICOM length of the stored value.

The string value is padded if required. Therefore, the returned length always has an even value.

Parameters
xfernot used
enctypenot used
Returns
number of characters stored in DICOM representation

Reimplemented from DcmElement.

virtual OFCondition DcmByteString::getOFString ( OFString stringVal,
const unsigned long  pos,
OFBool  normalize = OFTrue 
)
virtual

get a copy of a particular string component

Parameters
stringValvariable in which the result value is stored
posindex of the value in case of multi-valued elements (0..vm-1)
normalizenot used since string normalization depends on value representation
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

Reimplemented in DcmDecimalString, DcmIntegerString, DcmUnlimitedText, DcmShortText, DcmLongText, DcmTime, DcmApplicationEntity, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, and DcmShortString.

Uint32 DcmByteString::getRealLength ( )

get length of the stored value.

Trailing spaces (padding characters) are ignored for the "real" length.

Returns
number of characters stored for the string value
virtual OFCondition DcmByteString::getString ( char *&  stringVal)
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.

Parameters
stringValreference to the pointer variable
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

OFCondition DcmByteString::getStringValue ( OFString stringVal)
protected

get a copy of the current string value.

This includes all string components and separators.

Parameters
stringValvariable in which the result is stored
Returns
status, EC_Normal if successful, an error code otherwise
virtual unsigned long DcmByteString::getVM ( )
virtual

get value multiplicity

Returns
number of string components (separated by a backslash)

Implements DcmObject.

Reimplemented in DcmUnlimitedText, DcmShortText, and DcmLongText.

virtual DcmEVR DcmByteString::ident ( ) const
virtual

get element type identifier

Returns
type identifier of this class (EVR_UNKNOWN)

Implements DcmObject.

Reimplemented in DcmUnlimitedText, DcmDecimalString, DcmTime, DcmApplicationEntity, DcmAgeString, DcmCodeString, DcmDate, DcmDateTime, DcmLongString, DcmPersonName, DcmShortString, DcmIntegerString, DcmShortText, DcmUniqueIdentifier, and DcmLongText.

virtual OFBool DcmByteString::isAffectedBySpecificCharacterSet ( ) const
virtual

check if this element is affected by SpecificCharacterSet

Returns
always returns false

Reimplemented from DcmObject.

Reimplemented in DcmCharString.

virtual OFBool DcmByteString::isEmpty ( const OFBool  normalize = OFTrue)
virtual

check if this object is empty

Parameters
normalizenormalize value before checking (ignore non-significant characters)
Returns
true if object is empty, i.e. has no value, false otherwise

Reimplemented from DcmObject.

OFCondition DcmByteString::makeDicomByteString ( )
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).

Returns
status, EC_Normal if successful, an error code otherwise
virtual OFCondition DcmByteString::makeMachineByteString ( )
protectedvirtual

convert currently stored string value to internal representation.

It removes any trailing space character and recomputes the string length.

Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented in DcmUniqueIdentifier.

virtual Uint8* DcmByteString::newValueField ( )
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.

Returns
pointer to the newly created value field

Reimplemented from DcmElement.

DcmByteString& DcmByteString::operator= ( const DcmByteString obj)

assignment operator

Parameters
objelement to be assigned/copied
Returns
reference to this object
virtual void DcmByteString::postLoadValue ( )
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 void DcmByteString::print ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0,
const int  level = 0,
const char *  pixelFileName = NULL,
size_t *  pixelCounter = NULL 
)
virtual

print element to a stream.

The output format of the value is a backslash separated sequence of string components (if any).

Parameters
outoutput stream
flagsoptional flag used to customize the output (see DCMTypes::PF_xxx)
levelcurrent level of nested items. Used for indentation.
pixelFileNamenot used
pixelCounternot used

Implements DcmObject.

Reimplemented in DcmUniqueIdentifier.

virtual OFCondition DcmByteString::putOFStringArray ( const OFString stringVal)
virtual

set element value from the given character string.

Parameters
stringValinput character string (possibly multi-valued)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

virtual OFCondition DcmByteString::putString ( const char *  stringVal)
virtual

set element value from the given character string

Parameters
stringValinput character string (possibly multi-valued)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

Reimplemented in DcmUniqueIdentifier.

void DcmByteString::setMaxLength ( Uint32  val)
inlineprotected

set the maximum number of characters for each string component

Parameters
valmaximum number of characters for each string component

Definition at line 272 of file dcbytstr.h.

References maxLength.

void DcmByteString::setNonSignificantChars ( const OFString characters)
inlineprotected

set non-significant characters used to determine whether the value is empty

Parameters
charactersnon-significant characters used to determine whether the value is empty

Definition at line 277 of file dcbytstr.h.

References nonSignificantChars.

void DcmByteString::setPaddingChar ( char  c)
inlineprotected

set the end-of-string padding character

Parameters
cend-of-string padding character

Definition at line 267 of file dcbytstr.h.

References paddingChar.

virtual OFCondition DcmByteString::verify ( const OFBool  autocorrect = OFFalse)
virtual

check the currently stored string value.

Checks every string component for the maximum length specified for the particular value representation.

Parameters
autocorrectcorrect value and value component length if OFTrue
Returns
status, EC_Normal if value length is correct, an error code otherwise

Implements DcmObject.

virtual OFCondition DcmByteString::write ( DcmOutputStream outStream,
const E_TransferSyntax  oxfer,
const E_EncodingType  enctype,
DcmWriteCache wcache 
)
virtual

write data element to a stream

Parameters
outStreamoutput stream
oxfertransfer syntax used to write the data
enctypeflag, specifying the encoding with undefined or explicit length
wcachepointer to write cache object, may be NULL

Reimplemented from DcmElement.

virtual OFCondition DcmByteString::writeSignatureFormat ( DcmOutputStream outStream,
const E_TransferSyntax  oxfer,
const E_EncodingType  enctype,
DcmWriteCache wcache 
)
virtual

write data element to a stream as required for the creation of digital signatures

Parameters
outStreamoutput stream
oxfertransfer syntax used to write the data
enctypeflag, specifying the encoding with undefined or explicit length
wcachepointer to write cache object, may be NULL

Reimplemented from DcmElement.


The documentation for this class was generated from the following file:


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