DCMTK  Version 3.6.4
OFFIS DICOM Toolkit
Public Member Functions | Private Attributes | List of all members
DcmPolymorphOBOW Class Reference

a class representing DICOM elements (such as uncompressed pixel data) that can be interpreted either as OB or as OW, i.e. More...

+ Inheritance diagram for DcmPolymorphOBOW:

Public Member Functions

 DcmPolymorphOBOW (const DcmTag &tag, const Uint32 len=0)
 constructor More...
 
 DcmPolymorphOBOW (const DcmPolymorphOBOW &old)
 copy constructor
 
virtual ~DcmPolymorphOBOW ()
 destructor
 
DcmPolymorphOBOWoperator= (const DcmPolymorphOBOW &obj)
 copy assignment operator More...
 
virtual DcmObjectclone () const
 clone method More...
 
virtual int compare (const DcmElement &rhs) const
 Comparison operator that compares the normalized value of this element with a given element of the same type (e.g. More...
 
virtual OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying. More...
 
virtual OFCondition read (DcmInputStream &inStream, const E_TransferSyntax ixfer, const E_GrpLenEncoding glenc, const Uint32 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 write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 This function writes this element's value to the outstream which was passed. More...
 
virtual OFCondition writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 special write method for creation of digital signatures More...
 
virtual void transferInit ()
 initialize the transfer state of this object. More...
 
virtual void transferEnd ()
 finalize the transfer state of this object. More...
 
virtual OFCondition getUint8Array (Uint8 *&val)
 get a pointer to the element value of the current element as type string. More...
 
virtual OFCondition getUint16Array (Uint16 *&val)
 get a pointer to the element value of the current element as type Uint16. 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 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 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...
 
- Public Member Functions inherited from DcmOtherByteOtherWord
 DcmOtherByteOtherWord (const DcmTag &tag)
 constructor. More...
 
 DcmOtherByteOtherWord (const DcmOtherByteOtherWord &old)
 copy constructor More...
 
virtual ~DcmOtherByteOtherWord ()
 destructor
 
DcmOtherByteOtherWordoperator= (const DcmOtherByteOtherWord &obj)
 assignment operator More...
 
virtual DcmEVR ident () const
 get element type identifier 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 value multiplicity More...
 
virtual unsigned long getNumberOfValues ()
 get number of values stored in this element More...
 
virtual OFCondition setVR (DcmEVR vr)
 set/change the current value representation 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 the current value to a stream. More...
 
virtual OFBool canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer)
 check whether the transfer syntax can be changed as specified More...
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
 write object in XML format to a stream More...
 
virtual OFCondition writeJson (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
 write object in JSON format to a stream More...
 
virtual OFCondition getUint8 (Uint8 &byteVal, const unsigned long pos=0)
 get particular 8 bit value. More...
 
virtual OFCondition getUint16 (Uint16 &wordVal, const unsigned long pos=0)
 get particular 16 bit value. More...
 
virtual OFCondition getOFString (OFString &stringVal, const unsigned long pos, OFBool normalize=OFTrue)
 get a particular value as a character string. More...
 
virtual OFCondition getOFStringArray (OFString &stringVal, OFBool normalize=OFTrue)
 get element value as a character string. 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 element value More...
 
- Public Member Functions inherited from DcmElement
 DcmElement (const DcmTag &tag, const Uint32 len=0)
 constructor. More...
 
 DcmElement (const DcmElement &old)
 copy constructor More...
 
virtual ~DcmElement ()
 destructor
 
DcmElementoperator= (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 Uint32 getLength (const E_TransferSyntax=EXS_LittleEndianImplicit, const E_EncodingType=EET_UndefinedLength)
 calculate the value length (without attribute tag, VR and length field) 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 OFCondition clear ()
 clear (remove) attribute value 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 getSint16 (Sint16 &val, const unsigned long pos=0)
 retrieve a single value of type Sint16. 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 getString (char *&val)
 get a pointer to the element value of the current element as type string. More...
 
virtual OFCondition getString (char *&val, Uint32 &len)
 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 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 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 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 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...
 
virtual OFBool isUniversalMatch (const OFBool normalize=OFTrue, const OFBool enableWildCardMatching=OFTrue)
 Determine if this element is universal matching. More...
 
virtual OFBool matches (const DcmElement &candidate, const OFBool enableWildCardMatching=OFTrue) const
 perform attribute matching. More...
 
virtual OFBool combinationMatches (const DcmElement &keySecond, const DcmElement &candidateFirst, const DcmElement &candidateSecond) const
 perform combined attribute matching. More...
 
const DcmInputStreamFactorygetInputStream () const
 returns a pointer to the input stream, if available, NULL otherwise. More...
 
- Public Member Functions inherited from DcmObject
 DcmObject (const DcmTag &tag, const Uint32 len=0)
 constructor. More...
 
 DcmObject (const DcmObject &obj)
 copy constructor More...
 
virtual ~DcmObject ()
 destructor
 
DcmObjectoperator= (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...
 
DcmItemgetRootItem ()
 get root dataset/item (top-level) that contains this object. More...
 
virtual DcmItemgetParentItem ()
 get parent item of this object. More...
 
DcmObjectgetParent ()
 get parent of this object. More...
 
const DcmObjectgetParent () 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 DcmTaggetTag () 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 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 OFBool containsExtendedCharacters (const OFBool checkAllStrings=OFFalse)
 check if this object contains non-ASCII characters More...
 
virtual OFBool isAffectedBySpecificCharacterSet () const
 check if this object is affected by SpecificCharacterSet 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 OFBool isEmpty (const OFBool normalize=OFTrue)
 check if this object is empty More...
 
virtual DcmObjectnextInContainer (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...
 

Private Attributes

OFBool changeVR
 this flag is used during write operations in Implicit VR Little Endian and notes that the VR has temporarily been changed from OB to OW at the beginning to the write operation and needs to be changed back once the operation has finished.
 
DcmEVR currentVR
 the current VR of value field, which can change over time
 

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) More...
 
static int scanValue (const OFString &vr, const char *const value, const size_t size)
 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...
 
- Protected Member Functions inherited from DcmOtherByteOtherWord
 DcmOtherByteOtherWord (const DcmTag &tag, const Uint32 len)
 constructor. More...
 
virtual void postLoadValue ()
 method is called after the element value has been loaded. More...
 
OFCondition alignValue ()
 align the element value to an even length (padding) More...
 
void printPixel (STD_NAMESPACE ostream &out, const size_t flags, const int level, const char *pixelFileName, size_t *pixelCounter)
 print pixel data and optionally write it to a binary file. More...
 
- Protected Member Functions inherited from DcmElement
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...
 
virtual Uint8 * newValueField ()
 This function creates a byte array of Length bytes and returns this array. 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...
 
virtual void writeJsonOpener (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
 write element start tag in JSON format More...
 
virtual void writeJsonCloser (STD_NAMESPACE ostream &out, DcmJsonFormat &format)
 write element end tag in JSON 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...
 
- Protected Member Functions inherited from DcmObject
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 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. More...
 
- Protected Attributes inherited from DcmObject
OFCondition errorFlag
 error flag for this object.
 

Detailed Description

a class representing DICOM elements (such as uncompressed pixel data) that can be interpreted either as OB or as OW, i.e.

are polymorph.

Constructor & Destructor Documentation

◆ DcmPolymorphOBOW()

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

constructor

Parameters
tagattribute tag
lenlength of the attribute value

Member Function Documentation

◆ clone()

virtual DcmObject* DcmPolymorphOBOW::clone ( ) const
inlinevirtual

clone method

Returns
deep copy of this object

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData, and DcmOverlayData.

◆ compare()

virtual int DcmPolymorphOBOW::compare ( const DcmElement rhs) const
virtual

Comparison operator that compares the normalized value of this element with a given element of the same type (e.g.

an DcmPolymorphOBOW with a DcmPolymorphOBOW). 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). The DcmPolymorphOBOW implementation checks then whether the length of both elements are equal and if so continues comparing the values serialized to Little Endian using memcpy.

Parameters
rhsthe right hand side of the comparison
Returns
0 if the object values are equal. -1 if this element has fewer components than the rhs element. Also -1 if the value of the first component that does not match is lower in this object than in rhs. Also returned if rhs cannot be casted to this object type or both objects are of different VR (i.e. the DcmEVR returned by the element's ident() call are different). 1 if either this element has more components than the rhs element, or if the first component that does not match is greater in this object than in rhs object.

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.

◆ copyFrom()

virtual OFCondition DcmPolymorphOBOW::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 DcmOtherByteOtherWord.

Reimplemented in DcmPixelData, and DcmOverlayData.

◆ createUint16Array()

virtual OFCondition DcmPolymorphOBOW::createUint16Array ( const Uint32  numWords,
Uint16 *&  words 
)
virtual

create an empty Uint16 array of given number of words and set it.

All array elements are initialized with a value of 0 (using 'memzero'). This method is only applicable to OW data.

Parameters
numWordsnumber of words (16 bit) to be created
wordsstores the pointer to the resulting buffer
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.

◆ createUint8Array()

virtual OFCondition DcmPolymorphOBOW::createUint8Array ( const Uint32  numBytes,
Uint8 *&  bytes 
)
virtual

create an empty Uint8 array of given number of bytes and set it.

All array elements are initialized with a value of 0 (using 'memzero'). This method is only applicable to certain VRs, e.g. OB.

Parameters
numBytesnumber of bytes (8 bit) to be created
bytesstores the pointer to the resulting buffer
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.

◆ getUint16Array()

virtual OFCondition DcmPolymorphOBOW::getUint16Array ( Uint16 *&  val)
virtual

get a pointer to the element value of the current element as type Uint16.

Requires element to be of corresponding VR, otherwise an error is returned. This method does not copy, but returns a pointer to the element value, which remains under control of this object and is valid only until the next read, write or put operation.

Parameters
valpointer to value returned in this parameter upon success
Returns
EC_Normal upon success, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

◆ getUint8Array()

virtual OFCondition DcmPolymorphOBOW::getUint8Array ( Uint8 *&  val)
virtual

get a pointer to the element value of the current element as type string.

Requires element to be of corresponding VR, otherwise an error is returned. This method does not copy, but returns a pointer to the element value, which remains under control of this object and is valid only until the next read, write or put operation.

Parameters
valpointer to value returned in this parameter upon success
Returns
EC_Normal upon success, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

◆ operator=()

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

copy assignment operator

Parameters
objelement to be copied
Returns
reference to this object

Referenced by DcmOverlayData::operator=().

◆ putUint16Array()

virtual OFCondition DcmPolymorphOBOW::putUint16Array ( const Uint16 *  vals,
const unsigned long  num 
)
virtual

replace the element value by a copy of the given Uint16 array (which is possibly multi-valued).

Requires element to be of corresponding VR, otherwise an error is returned.

Parameters
valsnew attribute value
numnumber of values in array vals
Returns
EC_Normal upon success, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.

◆ putUint8Array()

virtual OFCondition DcmPolymorphOBOW::putUint8Array ( const Uint8 *  vals,
const unsigned long  num 
)
virtual

replace the element value by a copy of the given Uint8 array (which is possibly multi-valued).

Requires element to be of corresponding VR, otherwise an error is returned.

Parameters
valsnew attribute value
numnumber of values in array vals
Returns
EC_Normal upon success, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.

◆ read()

virtual OFCondition DcmPolymorphOBOW::read ( DcmInputStream inStream,
const E_TransferSyntax  ixfer,
const E_GrpLenEncoding  glenc,
const Uint32  maxReadLength 
)
virtual

This function reads the data value of an attribute which is captured in the input stream and captures this information in this.

If not all information for an attribute could be read from the stream, the function returns EC_StreamNotifyClient. Note that if certain conditions are met, this function does not actually load the data value but creates and stores an object that enables us to load this information later.

Parameters
inStreamThe stream which contains the information.
ixferThe transfer syntax which was used to encode the information in inStream.
glencEncoding type for group length; specifies what will be done with group length tags.
maxReadLengthMaximum read length for reading an attribute value.
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmElement.

Reimplemented in DcmPixelData.

◆ transferEnd()

virtual void DcmPolymorphOBOW::transferEnd ( )
virtual

finalize the transfer state of this object.

This method must be called when reading/writing this object from/to a stream has been completed.

Reimplemented from DcmObject.

Reimplemented in DcmPixelData.

◆ transferInit()

virtual void DcmPolymorphOBOW::transferInit ( )
virtual

initialize the transfer state of this object.

This method must be called before this object is written to a stream or read (parsed) from a stream.

Reimplemented from DcmElement.

Reimplemented in DcmPixelData.

◆ write()

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

This function writes this element's value to the outstream which was passed.

When writing information, the byte ordering (little or big endian) of the transfer syntax which was passed will be accounted for. In case the outstream does not provide enough space for all bytes of the current element's value, only a certain part of the value will be written to the stream. This element's transfer state indicates if the all bytes of value have already been written to the stream (ERW_ready), if the writing is still in progress and more bytes need to be written to the stream (ERW_inWork) or if the writing of the bytes of this element's value has not even begun yet (ERW_init). The member variable fTransferredBytes indicates how many bytes (starting from byte 0) of this element's value have already been written to the stream. This function will return EC_Normal, if the entire value of this element has been written to the stream, it will return EC_StreamNotifyClient, if there is no more space in the buffer and not all bytes of this element's value have been written, and it will return some other (error) value if there was an error.

Parameters
outStreamThe stream the information will be written to.
oxferThe transfer syntax which shall be used.
enctypeencoding types (undefined or explicit length) (actually unused)
wcachepointer to write cache object, may be NULL
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.

◆ writeSignatureFormat()

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

special write method for creation of digital signatures

Parameters
outStreamDICOM output stream
oxferoutput transfer syntax
enctypeencoding types (undefined or explicit length)
wcachepointer to write cache object, may be NULL
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmOtherByteOtherWord.

Reimplemented in DcmPixelData.


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


Generated on Thu Nov 29 2018 for DCMTK Version 3.6.4 by Doxygen 1.8.14