OFFIS DCMTK  Version 3.6.0
Public Member Functions | Protected Member Functions | Private Attributes | Friends | List of all members
DcmDirectoryRecord Class Reference

a class representing a directory record dataset in a DICOMDIR. More...

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

Public Member Functions

 DcmDirectoryRecord ()
 default constructor
 
 DcmDirectoryRecord (const DcmTag &tag, const Uint32 len)
 constructor
 
 DcmDirectoryRecord (const E_DirRecType recordType, const char *referencedFileID, const char *sourceFileName)
 constructor
 
 DcmDirectoryRecord (const char *recordTypeName, const char *referencedFileID, const char *sourceFileName)
 constructor
 
 DcmDirectoryRecord (const DcmDirectoryRecord &oldDirRec)
 copy constructor
 
DcmDirectoryRecordoperator= (const DcmDirectoryRecord &obj)
 assignment operator
 
virtual ~DcmDirectoryRecord ()
 destructor
 
virtual DcmObjectclone () const
 clone method
 
virtual OFCondition copyFrom (const DcmObject &rhs)
 Virtual object copying.
 
virtual DcmEVR ident () const
 return identifier for this class.
 
OFCondition error () const
 returns current status flag
 
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 all elements of the item to a stream
 
virtual OFCondition read (DcmInputStream &inStream, const E_TransferSyntax xfer, const E_GrpLenEncoding glenc=EGL_noChange, const Uint32 maxReadLength=DCM_MaxReadLength)
 This function reads the information of all attributes which are captured in the input stream and captures this information in elementList.
 
virtual OFCondition writeXML (STD_NAMESPACE ostream &out, const size_t flags=0)
 write object in XML format
 
virtual OFCondition verify (const OFBool autocorrect=OFFalse)
 check the currently stored element value
 
virtual OFCondition search (const DcmTagKey &xtag, DcmStack &resultStack, E_SearchMode mode=ESM_fromHere, OFBool searchIntoSub=OFTrue)
 a complex, stack-based, hierarchical search method.
 
virtual E_DirRecType getRecordType ()
 get record type of this directory record
 
virtual DcmDirectoryRecordgetReferencedMRDR ()
 if this directory record references an MRDR (multi-reference directory record), return pointer to the MRDR referenced by this object.
 
virtual OFCondition assignToMRDR (DcmDirectoryRecord *mrdr)
 create a reference from this record to an MRDR
 
virtual OFCondition assignToSOPFile (const char *referencedFileID, const char *sourceFileName)
 open a DICOM file and make this directory record into adirectory record for that DICOM file.
 
virtual unsigned long cardSub ()
 return number of directory records that are child record of this one
 
virtual OFCondition insertSub (DcmDirectoryRecord *dirRec, unsigned long where=DCM_EndOfListIndex, OFBool before=OFFalse)
 insert a child directory record
 
virtual OFCondition insertSubAtCurrentPos (DcmDirectoryRecord *dirRec, OFBool before=OFFalse)
 insert new directory child record at the current position.
 
virtual DcmDirectoryRecordgetSub (const unsigned long num)
 access child directory record.
 
virtual DcmDirectoryRecordnextSub (const DcmDirectoryRecord *dirRec)
 get next directory child record starting at a given record
 
virtual DcmDirectoryRecordremoveSub (const unsigned long num)
 remove child directory record.
 
virtual DcmDirectoryRecordremoveSub (DcmDirectoryRecord *dirRec)
 remove child directory record.
 
virtual OFCondition deleteSubAndPurgeFile (const unsigned long num)
 remove child directory record and delete file referenced by that record, if any
 
virtual OFCondition deleteSubAndPurgeFile (DcmDirectoryRecord *dirRec)
 remove child directory record and delete file referenced by that record, if any
 
virtual OFCondition clearSub ()
 revert the list of child directory records to default constructed (empty) state
 
virtual void setRecordsOriginFile (const char *fname)
 store the filename from which this directory record was read from
 
virtual const char * getRecordsOriginFile ()
 get the filename from which this directory record was read from, NULL íf not set
 
Uint32 getFileOffset () const
 get the offset in file of this directory record
 
- Public Member Functions inherited from DcmItem
 DcmItem ()
 default constructor
 
 DcmItem (const DcmTag &tag, const Uint32 len=0)
 constructor.
 
 DcmItem (const DcmItem &old)
 copy constructor
 
DcmItemoperator= (const DcmItem &obj)
 assignment operator.
 
virtual ~DcmItem ()
 destructor
 
virtual unsigned long getVM ()
 get value multiplicity
 
virtual unsigned long card () const
 get cardinality of this item
 
virtual OFBool isLeaf () const
 check if this element is a leaf node in a dataset tree.
 
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 Uint32 getLength (const E_TransferSyntax xfer=EXS_LittleEndianImplicit, const E_EncodingType enctype=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.
 
virtual void transferInit ()
 initialize the transfer state of this object.
 
virtual void transferEnd ()
 finalize 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 write (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 write object to a stream
 
virtual OFCondition writeSignatureFormat (DcmOutputStream &outStream, const E_TransferSyntax oxfer, const E_EncodingType enctype, DcmWriteCache *wcache)
 special write method for creation of digital signatures
 
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 at any nesting level
 
virtual OFBool isAffectedBySpecificCharacterSet () const
 check if this object is affected by SpecificCharacterSet at any nesting level.
 
virtual OFCondition insert (DcmElement *elem, OFBool replaceOld=OFFalse, OFBool checkInsertOrder=OFFalse)
 insert a new element into the list of elements maintained by this item.
 
virtual DcmElementgetElement (const unsigned long num)
 access an element from the item.
 
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 DcmObjectnextInContainer (const DcmObject *obj)
 this method is only used in container classes, that is, DcmItem and DcmSequenceOfItems.
 
virtual DcmElementremove (const unsigned long num)
 remove element from list.
 
virtual DcmElementremove (DcmObject *elem)
 remove element from list.
 
virtual DcmElementremove (const DcmTagKey &tag)
 remove element from list.
 
virtual OFBool isEmpty (const OFBool normalize=OFTrue)
 check if this item is empty
 
virtual OFCondition clear ()
 clear (remove) attribute value
 
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 computeGroupLengthAndPadding (const E_GrpLenEncoding glenc, const E_PaddingEncoding padenc=EPD_noChange, const E_TransferSyntax xfer=EXS_Unknown, const E_EncodingType enctype=EET_ExplicitLength, const Uint32 padlen=0, const Uint32 subPadlen=0, Uint32 instanceLength=0)
 This function takes care of group length and padding elements in the current element list according to what is specified in glenc and padenc.
 
OFBool tagExists (const DcmTagKey &key, OFBool searchIntoSub=OFFalse)
 check if an element with the given attribute tag exists in the dataset
 
OFBool tagExistsWithValue (const DcmTagKey &key, OFBool searchIntoSub=OFFalse)
 check if an element with the given attribute tag exists in the dataset and has a non-empty value (i.e., length > 0)
 
OFCondition findAndGetElement (const DcmTagKey &tagKey, DcmElement *&element, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse)
 find element and get a pointer to it (or copy it).
 
OFCondition findAndGetElements (const DcmTagKey &tagKey, DcmStack &resultStack)
 find all elements matching a particular tag and return references to them on a stack.
 
OFCondition findAndGetString (const DcmTagKey &tagKey, const char *&value, const OFBool searchIntoSub=OFFalse)
 find element and get value as a reference to a C string.
 
OFCondition findAndGetOFString (const DcmTagKey &tagKey, OFString &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a C++ string (only one component).
 
OFCondition findAndGetOFStringArray (const DcmTagKey &tagKey, OFString &value, const OFBool searchIntoSub=OFFalse)
 find element and get value as a C++ string (all components).
 
OFCondition findAndGetUint8 (const DcmTagKey &tagKey, Uint8 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as an unsigned 8-bit integer.
 
OFCondition findAndGetUint8Array (const DcmTagKey &tagKey, const Uint8 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of unsigned 8-bit integers.
 
OFCondition findAndGetUint16 (const DcmTagKey &tagKey, Uint16 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as an unsigned 16-bit integer.
 
OFCondition findAndGetUint16Array (const DcmTagKey &tagKey, const Uint16 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of unsigned 16-bit integers.
 
OFCondition findAndGetSint16 (const DcmTagKey &tagKey, Sint16 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a signed 16-bit integer.
 
OFCondition findAndGetSint16Array (const DcmTagKey &tagKey, const Sint16 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of signed 16-bit integers.
 
OFCondition findAndGetUint32 (const DcmTagKey &tagKey, Uint32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as an unsigned 32-bit integer.
 
OFCondition findAndGetUint32Array (const DcmTagKey &tagKey, const Uint32 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of unsigned 32-bit integers.
 
OFCondition findAndGetSint32 (const DcmTagKey &tagKey, Sint32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a signed 32-bit integer.
 
OFCondition findAndGetSint32Array (const DcmTagKey &tagKey, const Sint32 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of signed 32-bit integers.
 
OFCondition findAndGetLongInt (const DcmTagKey &tagKey, long int &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a (signed) long integer.
 
OFCondition findAndGetFloat32 (const DcmTagKey &tagKey, Float32 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a 32-bit floating point.
 
OFCondition findAndGetFloat32Array (const DcmTagKey &tagKey, const Float32 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of 32-bit floating point values.
 
OFCondition findAndGetFloat64 (const DcmTagKey &tagKey, Float64 &value, const unsigned long pos=0, const OFBool searchIntoSub=OFFalse)
 find element and get value as a 64-bit floating point.
 
OFCondition findAndGetFloat64Array (const DcmTagKey &tagKey, const Float64 *&value, unsigned long *count=NULL, const OFBool searchIntoSub=OFFalse)
 find element and get value as an array of 64-bit floating point values.
 
OFCondition findAndGetSequence (const DcmTagKey &seqTagKey, DcmSequenceOfItems *&sequence, const OFBool searchIntoSub=OFFalse, const OFBool createCopy=OFFalse)
 looks up and returns a given sequence.
 
OFCondition findAndGetSequenceItem (const DcmTagKey &seqTagKey, DcmItem *&item, const signed long itemNum=0, const OFBool createCopy=OFFalse)
 looks up and returns a given sequence item, if it exists.
 
OFCondition findOrCreateSequenceItem (const DcmTag &seqTag, DcmItem *&item, const signed long itemNum=0)
 looks up the given sequence in the current dataset and returns the given item.
 
OFCondition findAndInsertCopyOfElement (const DcmTagKey &tagKey, DcmItem *destItem, const OFBool replaceOld=OFTrue)
 find element, create a copy and insert it into the given destination dataset.
 
OFCondition findAndDeleteElement (const DcmTagKey &tagKey, const OFBool allOccurrences=OFFalse, const OFBool searchIntoSub=OFFalse)
 find element, remove it from the dataset and free the associated memory.
 
OFCondition findAndDeleteSequenceItem (const DcmTagKey &seqTagKey, const signed long itemNum)
 looks up the given sequence in the current dataset and deletes the given item.
 
OFCondition putAndInsertString (const DcmTag &tag, const char *value, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertOFStringArray (const DcmTag &tag, const OFString &value, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint8Array (const DcmTag &tag, const Uint8 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint16 (const DcmTag &tag, const Uint16 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint16Array (const DcmTag &tag, const Uint16 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertSint16 (const DcmTag &tag, const Sint16 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertSint16Array (const DcmTag &tag, const Sint16 *value, const unsigned long count, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertUint32 (const DcmTag &tag, const Uint32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertSint32 (const DcmTag &tag, const Sint32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertFloat32 (const DcmTag &tag, const Float32 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition putAndInsertFloat64 (const DcmTag &tag, const Float64 value, const unsigned long pos=0, const OFBool replaceOld=OFTrue)
 create a new element, put specified value to it and insert the element into the dataset/item.
 
OFCondition insertEmptyElement (const DcmTag &tag, const OFBool replaceOld=OFTrue)
 create a new element (with no value) and insert it into the dataset/item.
 
OFCondition insertSequenceItem (const DcmTag &seqTag, DcmItem *item, const signed long itemNum=-2)
 looks up the given sequence in the current dataset and inserts the given item.
 
- 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.
 
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
 
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

E_DirRecType recordNameToType (const char *recordTypeName)
 
char * buildFileName (const char *origName, char *destName)
 
OFCondition checkHierarchy (const E_DirRecType upperRecord, const E_DirRecType lowerRecord)
 
OFCondition setRecordType (E_DirRecType newType)
 
E_DirRecType lookForRecordType ()
 
OFCondition setReferencedFileID (const char *referencedFileID)
 
const char * lookForReferencedFileID ()
 
DcmDirectoryRecordlookForReferencedMRDR ()
 
const char * getReferencedFileName ()
 
OFCondition setRecordInUseFlag (const Uint16 newFlag)
 
Uint16 lookForRecordInUseFlag ()
 
Uint32 setFileOffset (Uint32 position)
 
OFCondition setNumberOfReferences (Uint32 newRefNum)
 
Uint32 lookForNumberOfReferences ()
 
Uint32 increaseRefNum ()
 
Uint32 decreaseRefNum ()
 
OFCondition fillElementsAndReadSOP (const char *referencedFileID, const char *sourceFileName)
 
OFCondition masterInsertSub (DcmDirectoryRecord *dirRec, const unsigned long where=DCM_EndOfListIndex)
 
OFCondition purgeReferencedFile ()
 
- Protected Member Functions inherited from DcmItem
OFCondition readTagAndLength (DcmInputStream &inStream, const E_TransferSyntax xfer, DcmTag &tag, Uint32 &length, Uint32 &bytesRead)
 This function reads tag and length information from inStream and returns this information to the caller.
 
OFCondition readSubElement (DcmInputStream &inStream, DcmTag &newTag, const Uint32 newLength, const E_TransferSyntax xfer, const E_GrpLenEncoding glenc, const Uint32 maxReadLength=DCM_MaxReadLength)
 This function creates a new DcmElement object on the basis of the newTag and newLength information which was passed, inserts this new element into elementList, reads the actual data value which belongs to this element (attribute) from the inStream and also assigns this information to the object which was created at the beginning.
 
E_TransferSyntax checkTransferSyntax (DcmInputStream &inStream)
 This function reads the first 6 bytes from the input stream and determines the transfer syntax which was used to code the information in the stream.
 
void checkAndUpdateVR (DcmItem &item, DcmTag &tag)
 check whether the given tag requires some special handling regarding the VR (i.e.
 
- 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
 

Private Attributes

char * recordsOriginFile
 string in which the filename (path) of the file from which this directory record was read is kept
 
DcmSequenceOfItemslowerLevelList
 list of child directory records, kept in a sequence of items
 
E_DirRecType DirRecordType
 directory record type of this record
 
DcmDirectoryRecordreferencedMRDR
 pointer to multi-referenced directory record (MRDR) if this record refers to one, NULL otherwise
 
Uint32 numberOfReferences
 number of other directory records referring to this one; used for MRDR records
 
Uint32 offsetInFile
 byte offset at which the start of this directory record resides in the file from which it was read
 

Friends

class DcmDicomDir
 

Additional Inherited Members

- 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.
 
- Protected Attributes inherited from DcmItem
DcmListelementList
 the list of elements maintained by this object
 
OFBool lastElementComplete
 flag used during suspended I/O.
 
offile_off_t fStartPosition
 used during reading.
 

Detailed Description

a class representing a directory record dataset in a DICOMDIR.

Definition at line 136 of file dcdirrec.h.

Constructor & Destructor Documentation

DcmDirectoryRecord::DcmDirectoryRecord ( const DcmTag tag,
const Uint32  len 
)

constructor

Parameters
tagattribute tag
lenlength of the attribute value
DcmDirectoryRecord::DcmDirectoryRecord ( const E_DirRecType  recordType,
const char *  referencedFileID,
const char *  sourceFileName 
)

constructor

Parameters
recordTyperecord type
referencedFileIDreferenced file ID in DICOM format
sourceFileNamepath to referenced file in operating system specific format
DcmDirectoryRecord::DcmDirectoryRecord ( const char *  recordTypeName,
const char *  referencedFileID,
const char *  sourceFileName 
)

constructor

Parameters
recordTypeNamerecord type as string
referencedFileIDreferenced file ID in DICOM format
sourceFileNamepath to referenced file in operating system specific format
DcmDirectoryRecord::DcmDirectoryRecord ( const DcmDirectoryRecord oldDirRec)

copy constructor

Parameters
oldDirRecelement to be copied

Member Function Documentation

virtual OFCondition DcmDirectoryRecord::assignToMRDR ( DcmDirectoryRecord mrdr)
virtual

create a reference from this record to an MRDR

Parameters
mrdrpointer to MRDR
Returns
EC_Normal upon success, an error code otherwise
virtual OFCondition DcmDirectoryRecord::assignToSOPFile ( const char *  referencedFileID,
const char *  sourceFileName 
)
virtual

open a DICOM file and make this directory record into adirectory record for that DICOM file.

The most relevant record keys (SOP Class UID, SOP instance UID, Transfer Syntax UID) are inserted into the directory record.

Parameters
referencedFileIDreferenced file ID in DICOM format
sourceFileNamepath to file in operating system specific format
Returns
EC_Normal upon success, an error code otherwise
virtual DcmObject* DcmDirectoryRecord::clone ( ) const
inlinevirtual

clone method

Returns
deep copy of this object

Reimplemented from DcmItem.

Definition at line 186 of file dcdirrec.h.

References DcmDirectoryRecord().

virtual OFCondition DcmDirectoryRecord::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 DcmItem.

virtual OFCondition DcmDirectoryRecord::deleteSubAndPurgeFile ( const unsigned long  num)
virtual

remove child directory record and delete file referenced by that record, if any

Parameters
numindex number of element, must be < cardSub()
Returns
status, EC_Normal upon success, an error code otherwise
virtual OFCondition DcmDirectoryRecord::deleteSubAndPurgeFile ( DcmDirectoryRecord dirRec)
virtual

remove child directory record and delete file referenced by that record, if any

Parameters
dirRecpointer to element to be removed from list
Returns
status, EC_Normal upon success, an error code otherwise
virtual DcmDirectoryRecord* DcmDirectoryRecord::getReferencedMRDR ( )
virtual

if this directory record references an MRDR (multi-reference directory record), return pointer to the MRDR referenced by this object.

Returns
pointer to MRDR referenced by this object or NULL of no MRDR referenced
virtual DcmDirectoryRecord* DcmDirectoryRecord::getSub ( const unsigned long  num)
virtual

access child directory record.

Returns a pointer to the object maintained as a child, not a copy.

Parameters
numindex, must be < cardSub()
Returns
pointer to child directory record or NULL if not found
virtual DcmEVR DcmDirectoryRecord::ident ( ) const
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.

Returns
type identifier of this class

Reimplemented from DcmItem.

virtual OFCondition DcmDirectoryRecord::insertSub ( DcmDirectoryRecord dirRec,
unsigned long  where = DCM_EndOfListIndex,
OFBool  before = OFFalse 
)
virtual

insert a child directory record

Parameters
dirRecdirectory record to be inserted. Must be allocated on heap, ownership is transferred to this object
whereindex where to insert object
beforeflag indicating whether to insert the record before or after the element identified by where
Returns
EC_Normal upon success, an error code otherwise
virtual OFCondition DcmDirectoryRecord::insertSubAtCurrentPos ( DcmDirectoryRecord dirRec,
OFBool  before = OFFalse 
)
virtual

insert new directory child record at the current position.

The current position is stored internally in the 'lowerLevelList' member variable.

Parameters
dirRecnew child record to be inserted
beforeflag indicating whether to insert the record before (OFFalse) or after (OFTrue) the current position
Returns
status, EC_Normal upon success, an error code otherwise
virtual DcmDirectoryRecord* DcmDirectoryRecord::nextSub ( const DcmDirectoryRecord dirRec)
virtual

get next directory child record starting at a given record

Parameters
dirRecrecord to start from (goto first record if NULL)
Returns
pointer to next record if successful, NULL otherwise
DcmDirectoryRecord& DcmDirectoryRecord::operator= ( const DcmDirectoryRecord obj)

assignment operator

Parameters
objthe directory record to be copied
virtual void DcmDirectoryRecord::print ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0,
const int  level = 0,
const char *  pixelFileName = NULL,
size_t *  pixelCounter = NULL 
)
virtual

print all elements of the item to a stream

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

Reimplemented from DcmItem.

virtual OFCondition DcmDirectoryRecord::read ( DcmInputStream inStream,
const E_TransferSyntax  xfer,
const E_GrpLenEncoding  glenc = EGL_noChange,
const Uint32  maxReadLength = DCM_MaxReadLength 
)
virtual

This function reads the information of all attributes which are captured in the input stream and captures this information in elementList.

Each attribute is represented as an element in this list. If not all information for an attribute could be read from the stream, the function returns EC_StreamNotifyClient.

Parameters
inStreamThe stream which contains the information.
xferThe 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 DcmItem.

virtual DcmDirectoryRecord* DcmDirectoryRecord::removeSub ( const unsigned long  num)
virtual

remove child directory record.

If found, the record is not deleted but returned to the caller who is responsible for further management of the DcmDirectoryRecord object.

Parameters
numindex number of element, must be < cardSub()
Returns
pointer to DcmDirectoryRecord if found, NULL otherwise
virtual DcmDirectoryRecord* DcmDirectoryRecord::removeSub ( DcmDirectoryRecord dirRec)
virtual

remove child directory record.

If found, the record is not deleted but returned to the caller who is responsible for further management of the DcmDirectoryRecord object.

Parameters
dirRecpointer to element to be removed from list
Returns
pointer to element if found, NULL otherwise
virtual OFCondition DcmDirectoryRecord::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.

Parameters
xtagthe DICOM attribute tag we are searching for
resultStackDepending 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.
modesearch 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.
searchIntoSubif 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.
Returns
EC_Normal if found, EC_TagNotFound if not found, an error code is something went wrong.

Reimplemented from DcmItem.

virtual void DcmDirectoryRecord::setRecordsOriginFile ( const char *  fname)
virtual

store the filename from which this directory record was read from

Parameters
fnamefilename, must not be NULL
virtual OFCondition DcmDirectoryRecord::verify ( const OFBool  autocorrect = OFFalse)
virtual

check the currently stored element value

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

Reimplemented from DcmItem.

virtual OFCondition DcmDirectoryRecord::writeXML ( STD_NAMESPACE ostream &  out,
const size_t  flags = 0 
)
virtual

write object in XML format

Parameters
outoutput stream to which the XML document is written
flagsoptional flag used to customize the output (see DCMTypes::XF_xxx)
Returns
status, EC_Normal if successful, an error code otherwise

Reimplemented from DcmItem.


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