DSRSOPInstanceReferenceList::StudyStruct

DSRSOPInstanceReferenceList::StudyStruct Struct Reference

Internal structure defining the study list items. More...

List of all members.

Public Member Functions

 StudyStruct (const OFString &studyUID)
 constructor
 ~StudyStruct ()
 destructor
size_t getNumberOfInstances () const
 get number of instance stored in the list of series
OFCondition read (DcmItem &dataset, OFConsole *logStream)
 read series and instance level from dataset
OFCondition write (DcmItem &dataset, OFConsole *logStream) const
 write study, series and instance level attributes to dataset
OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor)
 read study, series and instance level attributes from XML document
OFCondition writeXML (ostream &stream, const size_t flags=0) const
 write study, series and instance level attributes in XML format
SeriesStruct * gotoSeries (const OFString &seriesUID)
 set cursor to the specified series entry (if existent)
InstanceStruct * gotoInstance (const OFString &instanceUID)
 set cursor to the specified instance entry (if existent)
OFCondition gotoFirstItem ()
 select the first item in the list.
OFCondition gotoNextItem ()
 select the next item in the list.
OFCondition addItem (const OFString &seriesUID, const OFString &sopClassUID, const OFString &instanceUID)
 add new entry to the list of series and instances (if not already existent).
OFCondition removeItem ()
 remove the current item from the list of series and instances.
void removeIncompleteItems ()
 remove empty/incomplete items from the list.
OFBool containsExtendedCharacters ()
 check if this object contains non-ASCII characters in one of the strings affected by SpecificCharacterSet in DICOM
 OFListIterator (SeriesStruct *) Iterator
 currently selected series (cursor)

Public Attributes

const OFString StudyUID
 study instance UID (VR=UI, VM=1)
OFList< SeriesStruct * > SeriesList
 list of referenced series

Detailed Description

Internal structure defining the study list items.

Definition at line 187 of file dsrsoprf.h.

Constructor & Destructor Documentation

DSRSOPInstanceReferenceList::StudyStruct::StudyStruct (  const OFString &  studyUID  ) 
 

constructor

Parameters:
studyUID study instance UID

Member Function Documentation

OFCondition DSRSOPInstanceReferenceList::StudyStruct::addItem (  const OFString &  seriesUID,
const OFString &  sopClassUID,
const OFString &  instanceUID
) 
 

add new entry to the list of series and instances (if not already existent).

Finally, the specified items are selected as the current one.

Parameters:
seriesUID series instance UID of the entry to be added
sopClassUID SOP class UID of the entry to be added
instanceUID SOP instance UID of the entry to be added
Returns:
status, EC_Normal if successful, an error code otherwise

OFBool DSRSOPInstanceReferenceList::StudyStruct::containsExtendedCharacters (   ) 
 

check if this object contains non-ASCII characters in one of the strings affected by SpecificCharacterSet in DICOM

Returns:
true if node contains non-ASCII characters, false otherwise

size_t DSRSOPInstanceReferenceList::StudyStruct::getNumberOfInstances (   )  const
 

get number of instance stored in the list of series

Returns:
number of instances

OFCondition DSRSOPInstanceReferenceList::StudyStruct::gotoFirstItem (   ) 
 

select the first item in the list.

That means the first instance in the first series of the current study.

Returns:
status, EC_Normal if successful, an error code otherwise

InstanceStruct* DSRSOPInstanceReferenceList::StudyStruct::gotoInstance (  const OFString &  instanceUID  ) 
 

set cursor to the specified instance entry (if existent)

Parameters:
instanceUID SOP instance UID of the entry to be searched for
Returns:
pointer to the instance structure if successful, NULL otherwise

OFCondition DSRSOPInstanceReferenceList::StudyStruct::gotoNextItem (   ) 
 

select the next item in the list.

That means the next instance in the current series, or the first instance in the next series (if available).

Returns:
status, EC_Normal if successful, an error code otherwise

SeriesStruct* DSRSOPInstanceReferenceList::StudyStruct::gotoSeries (  const OFString &  seriesUID  ) 
 

set cursor to the specified series entry (if existent)

Parameters:
seriesUID series instance UID of the entry to be searched for
Returns:
pointer to the series structure if successful, NULL otherwise

OFCondition DSRSOPInstanceReferenceList::StudyStruct::read (  DcmItem &  dataset,
OFConsole *  logStream
) 
 

read series and instance level from dataset

Parameters:
dataset DICOM dataset from which the list should be read
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRSOPInstanceReferenceList::StudyStruct::readXML (  const DSRXMLDocument &  doc,
DSRXMLCursor  cursor
) 
 

read study, series and instance level attributes from XML document

Parameters:
doc document containing the XML file content
cursor cursor pointing to the starting node
Returns:
status, EC_Normal if successful, an error code otherwise

void DSRSOPInstanceReferenceList::StudyStruct::removeIncompleteItems (   ) 
 

remove empty/incomplete items from the list.

(e.g. series with no instances) Please note that this function modifies the value of 'Iterator'.

OFCondition DSRSOPInstanceReferenceList::StudyStruct::removeItem (   ) 
 

remove the current item from the list of series and instances.

After sucessful removal the cursors are set to the next valid position.

Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRSOPInstanceReferenceList::StudyStruct::write (  DcmItem &  dataset,
OFConsole *  logStream
)  const
 

write study, series and instance level attributes to dataset

Parameters:
dataset DICOM dataset to which the list should be written
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRSOPInstanceReferenceList::StudyStruct::writeXML (  ostream &  stream,
const size_t  flags = 0
)  const
 

write study, series and instance level attributes in XML format

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

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

Generated on 20 Dec 2005 for OFFIS DCMTK Version 3.5.4 by Doxygen 1.4.5