DCMTK  Version 3.6.1 20170228
OFFIS DICOM Toolkit
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Private Attributes | List of all members
DcmTransferSyntaxMap Class Reference

this helper class maintains a map of transfer syntax lists. More...

Public Member Functions

 DcmTransferSyntaxMap ()
 constructor
 
 ~DcmTransferSyntaxMap ()
 destructor
 
 DcmTransferSyntaxMap (const DcmTransferSyntaxMap &arg)
 Copy constructor, performs deep copy.
 
DcmTransferSyntaxMapoperator= (const DcmTransferSyntaxMap &arg)
 Copy assignment operator, performs deep copy.
 
OFMap< OFString,
DcmTransferSyntaxList * >
::const_iterator 
begin ()
 const iterator pointing to start of transfer syntax map More...
 
OFMap< OFString,
DcmTransferSyntaxList * >
::const_iterator 
end ()
 const iterator pointing to end of transfer syntax map (behind last entry) More...
 
void clear ()
 Resets DcmTransferSyntaxMap and frees any allocated memory.
 
size_t size () const
 Returns number of entries in transfer syntax map. More...
 
OFCondition add (const char *key, const char *transferSyntaxUID)
 add new entry to list within map. More...
 
OFBool isKnownKey (const char *key) const
 checks if the key is known More...
 
const DcmTransferSyntaxListgetTransferSyntaxList (const char *key) const
 returns the list of transfer syntaxes identified by the given key More...
 

Private Attributes

OFMap< OFString,
DcmTransferSyntaxList * > 
map_
 map of transfer syntax lists
 

Detailed Description

this helper class maintains a map of transfer syntax lists.

Not intended for use by the end user.

Member Function Documentation

OFCondition DcmTransferSyntaxMap::add ( const char *  key,
const char *  transferSyntaxUID 
)

add new entry to list within map.

If key is new, new list is created. Otherwise transfer syntax is appended to existing list.

Parameters
keymap key
transferSyntaxUIDtransfer syntax UID
Returns
EC_Normal if successful, an error code otherwise
OFMap<OFString, DcmTransferSyntaxList*>::const_iterator DcmTransferSyntaxMap::begin ( )

const iterator pointing to start of transfer syntax map

Returns
iterator to start of profile map
OFMap<OFString, DcmTransferSyntaxList*>::const_iterator DcmTransferSyntaxMap::end ( )

const iterator pointing to end of transfer syntax map (behind last entry)

Returns
iterator to end of profile map
const DcmTransferSyntaxList* DcmTransferSyntaxMap::getTransferSyntaxList ( const char *  key) const

returns the list of transfer syntaxes identified by the given key

Parameters
keytransfer syntax list to search
Returns
pointer to transfer syntax list if found, NULL otherwise
OFBool DcmTransferSyntaxMap::isKnownKey ( const char *  key) const

checks if the key is known

Parameters
keykey name, must not be NULL
Returns
true if key is known, false otherwise
size_t DcmTransferSyntaxMap::size ( ) const

Returns number of entries in transfer syntax map.

Returns
the number of entries in transfer syntax map

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


Generated on Tue Feb 28 2017 for DCMTK Version 3.6.1 20170228 by Doxygen 1.8.8