Inheritance diagram for DcmObject:
Public Member Functions | |
DcmObject (const DcmTag &tag, const Uint32 len=0) | |
constructor. | |
DcmObject (const DcmObject &obj) | |
copy constructor | |
virtual | ~DcmObject () |
destructor | |
virtual DcmObject * | clone () const=0 |
clone method | |
DcmObject & | operator= (const DcmObject &obj) |
copy assignment operator | |
virtual OFCondition | copyFrom (const DcmObject &rhs)=0 |
Virtual object copying. | |
virtual DcmEVR | ident () const=0 |
return identifier for this class. | |
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. | |
virtual OFBool | isLeaf () const=0 |
check if this element is a leaf node in a dataset tree. | |
virtual void | print (STD_NAMESPACE ostream &out, const size_t flags=0, const int level=0, const char *pixelFileName=NULL, size_t *pixelCounter=NULL)=0 |
print object to a stream | |
E_TransferState | transferState () const |
return the current transfer (read/write) state of this object. | |
virtual void | transferInit (void) |
initialize the transfer 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 DcmTag & | getTag () 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 unsigned long | getVM ()=0 |
return value multiplicity of the current object | |
virtual Uint32 | calcElementLength (const E_TransferSyntax xfer, const E_EncodingType enctype)=0 |
calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences. | |
virtual Uint32 | getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=EET_UndefinedLength)=0 |
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. | |
virtual OFBool | canWriteXfer (const E_TransferSyntax newXfer, const E_TransferSyntax oldXfer)=0 |
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)=0 |
read object from a stream. | |
virtual OFCondition | write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)=0 |
write object to a stream (abstract) | |
virtual OFCondition | writeXML (STD_NAMESPACE ostream &out, const size_t flags=0) |
write object in XML format to a stream | |
virtual OFCondition | writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)=0 |
special write method for creation of digital signatures (abstract) | |
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 OFBool | containsExtendedCharacters (const OFBool checkAllStrings=OFFalse) |
check if this object contains non-ASCII characters | |
virtual OFBool | isAffectedBySpecificCharacterSet () const |
check if this object is affected by SpecificCharacterSet | |
virtual OFBool | isEmpty (const OFBool normalize=OFTrue) |
check if this object is empty | |
virtual OFCondition | clear ()=0 |
clear (remove) attribute value | |
virtual OFCondition | verify (const OFBool autocorrect=OFFalse)=0 |
check the currently stored element value | |
virtual DcmObject * | nextInContainer (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. | |
virtual OFCondition | loadAllDataIntoMemory ()=0 |
this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory. | |
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 | |
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 | 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. | |
Protected Attributes | |
OFCondition | errorFlag |
error flag for this object. | |
Private Attributes | |
DcmTag | Tag |
the DICOM attribute tag and VR for this object | |
Uint32 | Length |
the length of this attribute as read from stream, may be undefined length | |
E_TransferState | fTransferState |
transfer state during read and write operations | |
Uint32 | fTransferredBytes |
number of bytes already read/written during transfer | |
Classes | |
class | PrintHelper |
helper class to print a DcmObject to an ostream using operator<< More... |
As a rule of thumb, everything that is either a dataset or that can be identified with a DICOM attribute tag is derived from class DcmObject.
Definition at line 179 of file dcobject.h.
DcmObject::DcmObject | ( | const DcmTag & | tag, | |
const Uint32 | len = 0 | |||
) |
constructor.
Create new object from given tag and length.
tag | DICOM tag for the new element | |
len | value length for the new element |
DcmObject::DcmObject | ( | const DcmObject & | obj | ) |
copy constructor
obj | item to be copied |
virtual DcmObject* DcmObject::clone | ( | ) | const [pure virtual] |
clone method
Implemented in DcmByteString, DcmCharString, DcmDataset, DcmDirectoryRecord, DcmFileFormat, DcmItem, DcmMetaInfo, DcmOverlayData, DcmPixelData, DcmPixelSequence, DcmPixelItem, DcmSequenceOfItems, DcmApplicationEntity, DcmAgeString, DcmAttributeTag, DcmCodeString, DcmDate, DcmDecimalString, DcmDateTime, DcmFloatingPointDouble, DcmFloatingPointSingle, DcmIntegerString, DcmLongString, DcmLongText, DcmOtherByteOtherWord, DcmOtherFloat, DcmPersonName, DcmPolymorphOBOW, DcmShortString, DcmSignedLong, DcmSignedShort, DcmShortText, DcmTime, DcmUniqueIdentifier, DcmUnsignedLong, DcmUnsignedLongOffset, DcmUnsignedShort, and DcmUnlimitedText.
copy assignment operator
obj | object to be copied |
virtual OFCondition DcmObject::copyFrom | ( | const DcmObject & | rhs | ) | [pure 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 |
Implemented in DcmByteString, DcmCharString, DcmDataset, DcmDirectoryRecord, DcmElement, DcmFileFormat, DcmItem, DcmMetaInfo, DcmOverlayData, DcmPixelData, DcmPixelSequence, DcmPixelItem, DcmSequenceOfItems, DcmApplicationEntity, DcmAgeString, DcmAttributeTag, DcmCodeString, DcmDate, DcmDecimalString, DcmDateTime, DcmFloatingPointDouble, DcmFloatingPointSingle, DcmIntegerString, DcmLongString, DcmLongText, DcmOtherByteOtherWord, DcmOtherFloat, DcmPersonName, DcmPolymorphOBOW, DcmShortString, DcmSignedLong, DcmSignedShort, DcmShortText, DcmTime, DcmUniqueIdentifier, DcmUnsignedLong, DcmUnsignedLongOffset, DcmUnsignedShort, and DcmUnlimitedText.
virtual DcmEVR DcmObject::ident | ( | ) | const [pure virtual] |
return identifier for this class.
Every class derived from this class returns a unique value of type enum DcmEVR for this call. This is used as a "poor man's RTTI" to correctly identify instances derived from this class even on compilers not supporting RTTI.
Implemented in DcmByteString, DcmDataset, DcmDirectoryRecord, DcmFileFormat, DcmItem, DcmMetaInfo, DcmOverlayData, DcmPixelData, DcmPixelSequence, DcmPixelItem, DcmSequenceOfItems, DcmApplicationEntity, DcmAgeString, DcmAttributeTag, DcmCodeString, DcmDate, DcmDecimalString, DcmDateTime, DcmFloatingPointDouble, DcmFloatingPointSingle, DcmIntegerString, DcmLongString, DcmLongText, DcmOtherByteOtherWord, DcmOtherFloat, DcmPersonName, DcmShortString, DcmSignedLong, DcmSignedShort, DcmShortText, DcmTime, DcmUniqueIdentifier, DcmUnsignedLong, DcmUnsignedLongOffset, DcmUnsignedShort, and DcmUnlimitedText.
Referenced by DcmOverlayData::copyFrom().
DcmEVR DcmObject::getVR | ( | ) | const [inline] |
return the value representation assigned to this object.
If object was read from a stream, this method returns the VR that was defined in the stream for this object. It is, therefore, possible that the VR does not match the one defined in the data dictionary for the tag assigned to this object.
Definition at line 238 of file dcobject.h.
References DcmTag::getEVR(), and Tag.
OFBool DcmObject::isaString | ( | ) | const [inline] |
check if this element is a string type, based on the VR.
Since the check is based on the VR and not on the class, the result of this method is not a guarantee that the object can be safely casted to one of the string-VR subclasses.
Definition at line 246 of file dcobject.h.
References DcmTag::getVR(), DcmVR::isaString(), and Tag.
virtual OFBool DcmObject::isLeaf | ( | ) | const [pure virtual] |
check if this element is a leaf node in a dataset tree.
All subclasses of DcmElement except for DcmSequenceOfItems are leaf nodes, while DcmSequenceOfItems, DcmItem, DcmDataset etc. are not.
Implemented in DcmElement, DcmItem, and DcmSequenceOfItems.
virtual void DcmObject::print | ( | STD_NAMESPACE ostream & | out, | |
const size_t | flags = 0 , |
|||
const int | level = 0 , |
|||
const char * | pixelFileName = NULL , |
|||
size_t * | pixelCounter = NULL | |||
) | [pure virtual] |
print object to a stream
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 (used in certain sub-classes of this class) | |
pixelCounter | not used (used in certain sub-classes of this class) |
Implemented in DcmByteString, DcmDataset, DcmDirectoryRecord, DcmFileFormat, DcmItem, DcmMetaInfo, DcmPixelData, DcmPixelSequence, DcmPixelItem, DcmSequenceOfItems, DcmAttributeTag, DcmFloatingPointDouble, DcmFloatingPointSingle, DcmOtherByteOtherWord, DcmSignedLong, DcmSignedShort, DcmUniqueIdentifier, DcmUnsignedLong, and DcmUnsignedShort.
E_TransferState DcmObject::transferState | ( | ) | const [inline] |
return the current transfer (read/write) state of this object.
Definition at line 272 of file dcobject.h.
References fTransferState.
virtual void DcmObject::transferInit | ( | void | ) | [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 in DcmElement, DcmItem, DcmMetaInfo, DcmPixelData, DcmSequenceOfItems, and DcmPolymorphOBOW.
virtual void DcmObject::transferEnd | ( | void | ) | [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 in DcmItem, DcmMetaInfo, DcmPixelData, DcmSequenceOfItems, and DcmPolymorphOBOW.
Uint16 DcmObject::getGTag | ( | ) | const [inline] |
return the group number of the attribute tag for this object
Definition at line 287 of file dcobject.h.
References DcmTag::getGTag(), and Tag.
Uint16 DcmObject::getETag | ( | ) | const [inline] |
return the element number of the attribute tag for this object
Definition at line 292 of file dcobject.h.
References DcmTag::getETag(), and Tag.
const DcmTag& DcmObject::getTag | ( | ) | const [inline] |
return const reference to the attribute tag for this object
Definition at line 297 of file dcobject.h.
References Tag.
void DcmObject::setGTag | ( | Uint16 | gtag | ) | [inline] |
assign group tag (but not element tag) of the attribute tag for this object.
This is sometimes useful when creating repeating group elements.
gtag | new attribute group tag |
Definition at line 303 of file dcobject.h.
References DcmTagKey::setGroup(), and Tag.
virtual OFCondition DcmObject::setVR | ( | DcmEVR | ) | [inline, virtual] |
assign a new Value Representation (VR) to this object.
This operation is only supported for very few subclasses derived from this class, in particular for classes handling pixel data which may either be of OB or OW value representation.
vr | value representation |
Reimplemented in DcmPixelData, and DcmOtherByteOtherWord.
Definition at line 312 of file dcobject.h.
virtual unsigned long DcmObject::getVM | ( | ) | [pure virtual] |
return value multiplicity of the current object
Implemented in DcmByteString, DcmItem, DcmSequenceOfItems, DcmAttributeTag, DcmFloatingPointDouble, DcmFloatingPointSingle, DcmLongText, DcmOtherByteOtherWord, DcmOtherFloat, DcmSignedLong, DcmSignedShort, DcmShortText, DcmUnsignedLong, DcmUnsignedShort, and DcmUnlimitedText.
virtual Uint32 DcmObject::calcElementLength | ( | const E_TransferSyntax | xfer, | |
const E_EncodingType | enctype | |||
) | [pure virtual] |
calculate the length of this DICOM element when encoded with the given transfer syntax and the given encoding type for sequences.
For elements, the length includes the length of the tag, length field, VR field and the value itself, for items and sequences it returns the length of the complete item or sequence including delimitation tags if applicable. Never returns undefined length.
xfer | transfer syntax for length calculation | |
enctype | sequence encoding type for length calculation |
Implemented in DcmDataset, DcmElement, DcmFileFormat, DcmItem, DcmMetaInfo, DcmPixelData, DcmPixelSequence, and DcmSequenceOfItems.
virtual Uint32 DcmObject::getLength | ( | const E_TransferSyntax | xfer = EXS_LittleEndianImplicit , |
|
const E_EncodingType | enctype = EET_UndefinedLength | |||
) | [pure virtual] |
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.
Never returns undefined length.
xfer | transfer syntax for length calculation | |
enctype | sequence encoding type for length calculation |
Implemented in DcmByteString, DcmElement, DcmItem, DcmPixelData, and DcmSequenceOfItems.
virtual OFBool DcmObject::canWriteXfer | ( | const E_TransferSyntax | newXfer, | |
const E_TransferSyntax | oldXfer | |||
) | [pure virtual] |
check if this DICOM object can be encoded in the given transfer syntax.
newXfer | transfer syntax in which the DICOM object is to be encoded | |
oldXfer | transfer syntax in which the DICOM object was read or created. |
Implemented in DcmDataset, DcmElement, DcmFileFormat, DcmItem, DcmPixelData, DcmPixelSequence, DcmSequenceOfItems, and DcmOtherByteOtherWord.
virtual OFCondition DcmObject::read | ( | DcmInputStream & | inStream, | |
const E_TransferSyntax | ixfer, | |||
const E_GrpLenEncoding | glenc = EGL_noChange , |
|||
const Uint32 | maxReadLength = DCM_MaxReadLength | |||
) | [pure virtual] |
read object from a stream.
inStream | DICOM input stream | |
ixfer | transfer syntax to use when parsing | |
glenc | handling of group length parameters | |
maxReadLength | attribute values larger than this value are skipped while parsing and read later upon first access if the stream type supports this. |
Implemented in DcmDataset, DcmDirectoryRecord, DcmElement, DcmFileFormat, DcmItem, DcmMetaInfo, DcmPixelData, DcmPixelSequence, DcmSequenceOfItems, and DcmPolymorphOBOW.
virtual OFCondition DcmObject::write | ( | DcmOutputStream & | outStream, | |
const E_TransferSyntax | oxfer, | |||
const E_EncodingType | enctype, | |||
DcmWriteCache * | wcache | |||
) | [pure virtual] |
write object to a stream (abstract)
outStream | DICOM output stream | |
oxfer | output transfer syntax | |
enctype | encoding types (undefined or explicit length) | |
wcache | pointer to write cache object, may be NULL |
Implemented in DcmByteString, DcmDataset, DcmElement, DcmFileFormat, DcmItem, DcmMetaInfo, DcmPixelData, DcmPixelSequence, DcmSequenceOfItems, DcmOtherByteOtherWord, and DcmPolymorphOBOW.
virtual OFCondition DcmObject::writeXML | ( | STD_NAMESPACE ostream & | out, | |
const size_t | flags = 0 | |||
) | [virtual] |
write object in XML format to a stream
out | output stream to which the XML document is written | |
flags | optional flag used to customize the output (see DCMTypes::XF_xxx) |
Reimplemented in DcmDataset, DcmDirectoryRecord, DcmElement, DcmFileFormat, DcmItem, DcmMetaInfo, DcmPixelData, DcmPixelItem, DcmSequenceOfItems, DcmDecimalString, and DcmOtherByteOtherWord.
virtual OFCondition DcmObject::writeSignatureFormat | ( | DcmOutputStream & | outStream, | |
const E_TransferSyntax | oxfer, | |||
const E_EncodingType | enctype, | |||
DcmWriteCache * | wcache | |||
) | [pure virtual] |
special write method for creation of digital signatures (abstract)
outStream | DICOM output stream | |
oxfer | output transfer syntax | |
enctype | encoding types (undefined or explicit length) | |
wcache | pointer to write cache object, may be NULL |
Implemented in DcmByteString, DcmDataset, DcmElement, DcmItem, DcmPixelData, DcmPixelSequence, DcmPixelItem, DcmSequenceOfItems, DcmOtherByteOtherWord, and DcmPolymorphOBOW.
virtual OFBool DcmObject::isSignable | ( | ) | const [virtual] |
returns true if the current object may be included in a digital signature
Reimplemented in DcmSequenceOfItems.
virtual OFBool DcmObject::containsUnknownVR | ( | ) | const [virtual] |
returns true if the object contains an element with Unknown VR at any nesting level
Reimplemented in DcmItem, and DcmSequenceOfItems.
virtual OFBool DcmObject::containsExtendedCharacters | ( | const OFBool | checkAllStrings = OFFalse |
) | [virtual] |
check if this object contains non-ASCII characters
checkAllStrings | not used in this class |
Reimplemented in DcmByteString, DcmCharString, DcmItem, and DcmSequenceOfItems.
virtual OFBool DcmObject::isAffectedBySpecificCharacterSet | ( | ) | const [virtual] |
check if this object is affected by SpecificCharacterSet
Reimplemented in DcmByteString, DcmCharString, DcmItem, and DcmSequenceOfItems.
virtual OFBool DcmObject::isEmpty | ( | const OFBool | normalize = OFTrue |
) | [virtual] |
check if this object is empty
normalize | normalize value before checking (ignore non-significant characters) |
Reimplemented in DcmByteString, DcmItem, and DcmSequenceOfItems.
virtual OFCondition DcmObject::clear | ( | ) | [pure virtual] |
clear (remove) attribute value
Implemented in DcmByteString, DcmDataset, DcmElement, DcmFileFormat, DcmItem, DcmSequenceOfItems, and DcmUnsignedLongOffset.
virtual OFCondition DcmObject::verify | ( | const OFBool | autocorrect = OFFalse |
) | [pure virtual] |
check the currently stored element value
autocorrect | correct value length if OFTrue |
Implemented in DcmByteString, DcmDirectoryRecord, DcmItem, DcmSequenceOfItems, DcmAttributeTag, DcmFloatingPointDouble, DcmFloatingPointSingle, DcmOtherByteOtherWord, DcmSignedLong, DcmSignedShort, DcmUnsignedLong, DcmUnsignedLongOffset, and DcmUnsignedShort.
this method is only used in container classes derived from this class, that is, DcmItem and DcmSequenceOfItems.
It returns a pointer to the next object in the list AFTER the given object. If the caller passes NULL, a pointer to the first object in the list is returned. If the given object is not found, the given object is the last one in the list or the list is empty, NULL is returned.
obj | pointer to one object in the container; we are looking for the next entry after this one. NULL if looking for the first entry. |
Reimplemented in DcmItem, and DcmSequenceOfItems.
virtual OFCondition DcmObject::nextObject | ( | DcmStack & | stack, | |
const OFBool | intoSub | |||
) | [virtual] |
this method enables a stack based, depth-first traversal of a complete hierarchical DICOM dataset (that is, classes derived from DcmItem or DcmSequenceOfItems).
With each call of this method, the next object in the tree is located and marked on the stack.
stack | "cursor" for current position in the dataset. The stack will contain a pointer to each dataset, sequence, item and element from the main dataset down to the current element, and is updated upon each call to this method. An empty stack is equivalent to a stack containing a pointer to this object only. | |
intoSub | if true, the nextObject method will perform a hierarchical search through the dataset (depth-first), if false, only the current container object will be traversed (e.g., all elements of an item or all items of a sequence). |
Reimplemented in DcmItem, and DcmSequenceOfItems.
virtual OFCondition DcmObject::search | ( | const DcmTagKey & | xtag, | |
DcmStack & | resultStack, | |||
E_SearchMode | mode = ESM_fromHere , |
|||
OFBool | searchIntoSub = OFTrue | |||
) | [virtual] |
a complex, stack-based, hierarchical search method.
It allows for a search for a DICOM object with a given attribute within a given container, hierarchically, from a starting position identified through a cursor stack.
xtag | the DICOM attribute tag we are searching for | |
resultStack | Depending on the search mode (see below), this parameter either serves as an input and output parameter, or as an output parameter only (the latter being the default). When used as an input parameter, the cursor stack defines the start position for the search within a hierarchical DICOM dataset. Upon successful return, the stack contains the position of the element found, in the form of a pointer to each dataset, sequence, item and element from the main dataset down to the found element. | |
mode | search mode, controls how the search stack is handled. In the default mode, ESM_fromHere, the stack is ignored on input, and the search starts in the object for which this method is called. In the other modes, the stack is used both as an input and an output parameter and defines the starting point for the search. | |
searchIntoSub | if true, the search will be performed hierarchically descending into the sequences and items of the dataset. If false, only the current container (sequence or item) will be traversed. |
Reimplemented in DcmDirectoryRecord, DcmItem, and DcmSequenceOfItems.
virtual OFCondition DcmObject::loadAllDataIntoMemory | ( | ) | [pure virtual] |
this method loads all attribute values maintained by this object and all sub-objects (in case of a container such as DcmDataset) into memory.
After a call to this method, the file from which a dataset was read may safely be deleted or replaced. For large files, this method may obviously allocate large amounts of memory.
Implemented in DcmElement, DcmItem, DcmPixelData, and DcmSequenceOfItems.
Uint32 DcmObject::getLengthField | ( | ) | const [inline] |
return the current value of the Length field (which is different from the functionality of the public getLength method).
Only needed for internal purposes and for checker tools that verify values against the length field.
Definition at line 504 of file dcobject.h.
References Length.
Referenced by DcmElement::getLength(), and DcmElement::valueLoaded().
void DcmObject::printNestingLevel | ( | STD_NAMESPACE ostream & | out, | |
const size_t | flags, | |||
const int | level | |||
) | [protected] |
print line indentation, e.g.
a couple of spaces for each nesting level. Depending on the value of 'flags' other visualizations are also possible.
out | output stream | |
flags | used to customize the output (see DCMTypes::PF_xxx) | |
level | current level of nested items. Used for indentation. |
void DcmObject::printInfoLineStart | ( | STD_NAMESPACE ostream & | out, | |
const size_t | flags, | |||
const int | level, | |||
DcmTag * | tag = NULL | |||
) | [protected] |
print beginning of the info line.
The default output is tag and value representation, though other visualizations are possible depending on the value of 'flags'.
out | output stream | |
flags | used to customize the output (see DCMTypes::PF_xxx) | |
level | current level of nested items. Used for indentation. | |
tag | optional tag used to print the data element information |
void DcmObject::printInfoLineEnd | ( | STD_NAMESPACE ostream & | out, | |
const size_t | flags, | |||
const unsigned long | printedLength = 0xffffffff , |
|||
DcmTag * | tag = NULL | |||
) | [protected] |
print end of the info line.
The default output is length, value multiplicity and tag name, though other visualizations are possible depending on the value of 'flags'.
out | output stream | |
flags | used to customize the output (see DCMTypes::PF_xxx) | |
printedLength | number of characters printed after line start. Used for padding purposes. | |
tag | optional tag used to print the data element information |
virtual void DcmObject::printInfoLine | ( | STD_NAMESPACE ostream & | out, | |
const size_t | flags, | |||
const int | level = 0 , |
|||
const char * | info = NULL , |
|||
DcmTag * | tag = NULL , |
|||
const OFBool | isInfo = OFTrue | |||
) | [protected, virtual] |
print given text with element information.
Calls printInfoLineStart() and printInfoLineEnd() to frame the 'info' text.
out | output stream | |
flags | used to customize the output (see DCMTypes::PF_xxx) | |
level | current level of nested items. Used for indentation. | |
info | text to be printed | |
tag | optional tag used to print the data element information | |
isInfo | optional flag indicating whether this text is really given for informational purposes only. Used to choose the correct output color. |
static OFCondition DcmObject::writeTag | ( | DcmOutputStream & | outStream, | |
const DcmTag & | tag, | |||
const E_TransferSyntax | oxfer | |||
) | [static, protected] |
static helper function that writes a given attribute tag to a binary output stream using the byte order indicated by the transfer syntax.
outStream | output stream | |
tag | tag to write to the stream | |
oxfer | transfer syntax defining the byte order |
virtual OFCondition DcmObject::writeTagAndLength | ( | DcmOutputStream & | outStream, | |
const E_TransferSyntax | oxfer, | |||
Uint32 & | writtenBytes | |||
) | const [protected, virtual] |
write tag, VR and length field to the given output stream
outStream | output stream | |
oxfer | transfer syntax for writing | |
writtenBytes | number of bytes written to stream returned in this parameter |
Reimplemented in DcmPixelItem.
virtual Uint32 DcmObject::getTagAndLengthSize | ( | const E_TransferSyntax | oxfer | ) | const [protected, virtual] |
return the number of bytes needed to serialize the tag, VR and length information of the current object using the given transfer syntax.
oxfer | The transfer syntax used for encoding |
const char* DcmObject::getTagName | ( | ) | [inline, protected] |
return the DICOM attribute tag name for this object.
If not known yet, will be looked up in the dictionary and cached. Therefore, method is not const.
Definition at line 596 of file dcobject.h.
References DcmTag::getTagName(), and Tag.
void DcmObject::setTagVR | ( | DcmEVR | vr | ) | [inline, protected] |
set the VR for this attribute
vr | new VR for this attribute. |
Definition at line 601 of file dcobject.h.
References DcmTag::setVR(), and Tag.
E_TransferState DcmObject::getTransferState | ( | ) | const [inline, protected] |
return the current transfer state of this object during serialization/deserialization
Definition at line 606 of file dcobject.h.
References fTransferState.
void DcmObject::setTransferState | ( | E_TransferState | newState | ) | [inline, protected] |
set the current transfer state of this object during serialization/deserialization
newState | new transfer state of this object |
Definition at line 611 of file dcobject.h.
References fTransferState.
Uint32 DcmObject::getTransferredBytes | ( | ) | const [inline, protected] |
return the number of transferred bytes for this object during serialization/deserialization
Definition at line 616 of file dcobject.h.
References fTransferredBytes.
void DcmObject::setTransferredBytes | ( | Uint32 | val | ) | [inline, protected] |
set the number of transferred bytes for this object during serialization/deserialization
val | number of transferred bytes |
Definition at line 621 of file dcobject.h.
References fTransferredBytes.
void DcmObject::incTransferredBytes | ( | Uint32 | val | ) | [inline, protected] |
add to the number of transferred bytes for this object during serialization/deserialization
val | number of additional transferred bytes to add to existing value |
Definition at line 626 of file dcobject.h.
References fTransferredBytes.
void DcmObject::setLengthField | ( | Uint32 | val | ) | [inline, protected] |
set the current value of the Length field
val | new value of the Length field |
Definition at line 631 of file dcobject.h.
References Length.