DSRSOPInstanceReferenceList::SeriesStruct

DSRSOPInstanceReferenceList::SeriesStruct Struct Reference

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

List of all members.

Public Member Functions

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

Public Attributes

const OFString SeriesUID
 series instance UID (VR=UI, VM=1)
OFString RetrieveAETitle
 optional: retrieve application entity title (VR=AE, VM=1-n)
OFString StorageMediaFileSetID
 optional: storage media file set ID (VR=SH, VM=1)
OFString StorageMediaFileSetUID
 optional: storage media file set UID (VR=UI, VM=1)
OFList< InstanceStruct * > InstanceList
 list of referenced instances

Detailed Description

Internal structure defining the series list items.

Definition at line 83 of file dsrsoprf.h.

Constructor & Destructor Documentation

DSRSOPInstanceReferenceList::SeriesStruct::SeriesStruct (  const OFString &  seriesUID  ) 
 

constructor

Parameters:
seriesUID series instance UID

Member Function Documentation

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

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

Finally, the specified item is selected as the current one.

Parameters:
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::SeriesStruct::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::SeriesStruct::getNumberOfInstances (   )  const
 

get number of instance stored in the list of instances

Returns:
number of instances

OFCondition DSRSOPInstanceReferenceList::SeriesStruct::gotoFirstItem (   ) 
 

select the first item in the list.

That means the first instance in the current series.

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

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

set cursor to the specified instance (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::SeriesStruct::gotoNextItem (   ) 
 

select the next item in the list.

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

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

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

read instance level attributes 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::SeriesStruct::readXML (  const DSRXMLDocument &  doc,
DSRXMLCursor  cursor
) 
 

read 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

OFCondition DSRSOPInstanceReferenceList::SeriesStruct::removeItem (   ) 
 

remove the current item from the list of instances.

After sucessful removal the cursor is set to the next valid position.

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

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

write 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::SeriesStruct::writeXML (  ostream &  stream,
const size_t  flags = 0
)  const
 

write 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