DSRCodingSchemeIdentificationList Class Reference

Class that maps Coding Scheme Designators to an external coding system registration, or to a private or local coding scheme. More...

Inheritance diagram for DSRCodingSchemeIdentificationList:

DSRTypes List of all members.

Public Member Functions

 DSRCodingSchemeIdentificationList ()
 constructor (default)
 ~DSRCodingSchemeIdentificationList ()
 destructor
void clear ()
 clear the list
OFBool empty () const
 check whether list is empty
size_t getNumberOfItems () const
 get number of items stored in the list
OFCondition read (DcmItem &dataset, OFConsole *logStream)
 read list of items from the coding scheme identification sequence
OFCondition write (DcmItem &dataset, OFConsole *logStream) const
 write list of items to the coding scheme identification sequence.
OFCondition readXML (const DSRXMLDocument &doc, DSRXMLCursor cursor, const size_t flags)
 read list of items from XML document
OFCondition writeXML (ostream &stream, const size_t flags=0) const
 write current list in XML format
OFCondition addPrivateDcmtkCodingScheme ()
 add private OFFIS DCMTK coding scheme entry to the list.
OFCondition addItem (const OFString &codingSchemeDesignator)
 add the specified coding scheme to the list.
OFCondition removeItem ()
 remove the current item from the list.
OFCondition removeItem (const OFString &codingSchemeDesignator)
 remove the specified item from the list.
OFCondition gotoItem (const OFString &codingSchemeDesignator)
 select the specified item as the current one
OFCondition gotoFirstItem ()
 select the first item in the list
OFCondition gotoNextItem ()
 select the next item in the list
const OFString & getCodingSchemeDesignator (OFString &stringValue) const
 get the coding scheme designator of the currently selected item.
const OFString & getCodingSchemeRegistry (OFString &stringValue) const
 get the coding scheme registry of the currently selected item
const OFString & getCodingSchemeUID (OFString &stringValue) const
 get the coding scheme UID of the currently selected item
const OFString & getCodingSchemeExternalID (OFString &stringValue) const
 get the coding scheme external ID of the currently selected item
const OFString & getCodingSchemeName (OFString &stringValue) const
 get the coding scheme name of the currently selected item
const OFString & getCodingSchemeVersion (OFString &stringValue) const
 get the coding scheme version of the currently selected item
const OFString & getResponsibleOrganization (OFString &stringValue) const
 get the responsible organization of the currently selected item
OFCondition setCodingSchemeRegistry (const OFString &value)
 set the coding scheme registry of the currently selected entry.
OFCondition setCodingSchemeUID (const OFString &value)
 set the coding scheme UID of the currently selected entry.
OFCondition setCodingSchemeExternalID (const OFString &value)
 set the coding scheme external ID of the currently selected entry.
OFCondition setCodingSchemeName (const OFString &value)
 set the coding scheme name of the currently selected entry.
OFCondition setCodingSchemeVersion (const OFString &value)
 set the coding scheme version of the currently selected entry.
OFCondition setResponsibleOrganization (const OFString &value)
 set the responsible organization of the currently selected entry.
OFBool containsExtendedCharacters ()
 check if this object contains non-ASCII characters in one of the strings affected by SpecificCharacterSet in DICOM

Protected Member Functions

OFCondition addItem (const OFString &codingSchemeDesignator, ItemStruct *&item, OFConsole *logStream=NULL)
 add the specified coding scheme to the list (if not existent)
ItemStruct * getCurrentItem () const
 get pointer to currently selected item structure (if any)

Private Member Functions

 OFListIterator (ItemStruct *) Iterator
 internal cursor to current (selected) list item
 DSRCodingSchemeIdentificationList (const DSRCodingSchemeIdentificationList &)
DSRCodingSchemeIdentificationList & operator= (const DSRCodingSchemeIdentificationList &)

Private Attributes

OFList< ItemStruct * > ItemList
 list of items

Classes

struct  ItemStruct
 Internal structure defining the list items. More...

Detailed Description

Class that maps Coding Scheme Designators to an external coding system registration, or to a private or local coding scheme.

Implementation of Coding Scheme Identification Sequence.

Definition at line 54 of file dsrcsidl.h.

Member Function Documentation

OFCondition DSRCodingSchemeIdentificationList::addItem (  const OFString &  codingSchemeDesignator,
ItemStruct *&  item,
OFConsole *  logStream = NULL
)  [protected]
 

add the specified coding scheme to the list (if not existent)

Parameters:
codingSchemeDesignator coding scheme designator of the item to be added
item reference to item pointer (result variable)
logStream pointer to error/warning output stream (output disabled if NULL)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::addItem (  const OFString &  codingSchemeDesignator  ) 
 

add the specified coding scheme to the list.

Internally, the item is inserted into the list of coding scheme designators if not already contained in the list. In any case the specified item is selected as the current one. See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
codingSchemeDesignator coding scheme designator of the item to be added. Designators beginning with "99" and the designator "L" are defined to be private or local coding schemes.
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::addPrivateDcmtkCodingScheme (   ) 
 

add private OFFIS DCMTK coding scheme entry to the list.

Please note that any information previously stored under the defined coding scheme designator "99_OFFIS_DCMTK" is replaced!

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

OFBool DSRCodingSchemeIdentificationList::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

OFBool DSRCodingSchemeIdentificationList::empty (   )  const
 

check whether list is empty

Returns:
OFTrue if list is empty, OFFalse otherwise

const OFString& DSRCodingSchemeIdentificationList::getCodingSchemeDesignator (  OFString &  stringValue  )  const
 

get the coding scheme designator of the currently selected item.

Designators beginning with "99" and the designator "L" are defined to be private or local coding schemes.

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

const OFString& DSRCodingSchemeIdentificationList::getCodingSchemeExternalID (  OFString &  stringValue  )  const
 

get the coding scheme external ID of the currently selected item

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

const OFString& DSRCodingSchemeIdentificationList::getCodingSchemeName (  OFString &  stringValue  )  const
 

get the coding scheme name of the currently selected item

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

const OFString& DSRCodingSchemeIdentificationList::getCodingSchemeRegistry (  OFString &  stringValue  )  const
 

get the coding scheme registry of the currently selected item

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

const OFString& DSRCodingSchemeIdentificationList::getCodingSchemeUID (  OFString &  stringValue  )  const
 

get the coding scheme UID of the currently selected item

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

const OFString& DSRCodingSchemeIdentificationList::getCodingSchemeVersion (  OFString &  stringValue  )  const
 

get the coding scheme version of the currently selected item

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

ItemStruct* DSRCodingSchemeIdentificationList::getCurrentItem (   )  const [protected]
 

get pointer to currently selected item structure (if any)

Returns:
pointer to the item structure if successful, NULL otherwise

size_t DSRCodingSchemeIdentificationList::getNumberOfItems (   )  const
 

get number of items stored in the list

Returns:
number of items

const OFString& DSRCodingSchemeIdentificationList::getResponsibleOrganization (  OFString &  stringValue  )  const
 

get the responsible organization of the currently selected item

Parameters:
stringValue reference to string variable in which the result is stored
Returns:
reference to the resulting string (might be empty)

OFCondition DSRCodingSchemeIdentificationList::gotoFirstItem (   ) 
 

select the first item in the list

Returns:
status, EC_Normal if successful, an error code otherwise. (e.g. if the list is empty)

OFCondition DSRCodingSchemeIdentificationList::gotoItem (  const OFString &  codingSchemeDesignator  ) 
 

select the specified item as the current one

Parameters:
codingSchemeDesignator coding scheme designator of the item to be selected
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::gotoNextItem (   ) 
 

select the next item in the list

Returns:
status, EC_Normal if successful, an error code otherwise. (e.g. if the end of the list has been reached)

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

read list of items from the coding scheme identification sequence

Parameters:
dataset DICOM dataset from which the data 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 DSRCodingSchemeIdentificationList::readXML (  const DSRXMLDocument &  doc,
DSRXMLCursor  cursor,
const size_t  flags
) 
 

read list of items from XML document

Parameters:
doc document containing the XML file content
cursor cursor pointing to the starting node
flags optional flag used to customize the reading process (see DSRTypes::XF_xxx)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::removeItem (  const OFString &  codingSchemeDesignator  ) 
 

remove the specified item from the list.

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

Parameters:
codingSchemeDesignator coding scheme designator of the item to be removed
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::removeItem (   ) 
 

remove the current item from the list.

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

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

OFCondition DSRCodingSchemeIdentificationList::setCodingSchemeExternalID (  const OFString &  value  ) 
 

set the coding scheme external ID of the currently selected entry.

See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
value string value to be set (use empty string to omit optional attribute)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::setCodingSchemeName (  const OFString &  value  ) 
 

set the coding scheme name of the currently selected entry.

See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
value string value to be set (use empty string to omit optional attribute)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::setCodingSchemeRegistry (  const OFString &  value  ) 
 

set the coding scheme registry of the currently selected entry.

See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
value string value to be set (use empty string to omit optional attribute)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::setCodingSchemeUID (  const OFString &  value  ) 
 

set the coding scheme UID of the currently selected entry.

See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
value string value to be set (use empty string to omit optional attribute)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::setCodingSchemeVersion (  const OFString &  value  ) 
 

set the coding scheme version of the currently selected entry.

See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
value string value to be set (use empty string to omit optional attribute)
Returns:
status, EC_Normal if successful, an error code otherwise

OFCondition DSRCodingSchemeIdentificationList::setResponsibleOrganization (  const OFString &  value  ) 
 

set the responsible organization of the currently selected entry.

See definition of 'ItemStruct' above for VR, VM and Type.

Parameters:
value string value to be set (use empty string to omit optional attribute)
Returns:
status, EC_Normal if successful, an error code otherwise

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

write list of items to the coding scheme identification sequence.

Does nothing if list is empty.

Parameters:
dataset DICOM dataset to which the data 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 DSRCodingSchemeIdentificationList::writeXML (  ostream &  stream,
const size_t  flags = 0
)  const
 

write current list in XML format

Parameters:
stream output stream to which the XML data 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 class was generated from the following file:

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