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
DcmProfileMap Class Reference

this helper class maintains a map of association negotiation profile keys. More...

Public Member Functions

 DcmProfileMap ()
 constructor
 
 ~DcmProfileMap ()
 destructor
 
 DcmProfileMap (const DcmProfileMap &arg)
 copy constructor, creates deep copy
 
DcmProfileMapoperator= (const DcmProfileMap &arg)
 copy constructor, creates deep copy
 
OFMap< OFString,
DcmProfileEntry * >
::const_iterator 
begin ()
 const iterator pointing to start of profile map More...
 
OFMap< OFString,
DcmProfileEntry * >
::const_iterator 
end ()
 const iterator pointing to end of profile map (behind last profile entry) More...
 
const DcmProfileEntrygetProfile (const OFString &name)
 return profile entry from profile map by its name More...
 
void clear ()
 Resets DcmProfileMap and frees any allocated memory.
 
OFCondition add (const char *key, const char *presentationContextKey, const char *roleSelectionKey, const char *extendedNegotiationKey)
 add new entry to list within map. More...
 
OFBool isKnownKey (const char *key) const
 checks if the key is known More...
 
const char * getPresentationContextKey (const char *key) const
 returns the presentation context key for the given profile More...
 
const char * getRoleSelectionKey (const char *key) const
 returns the role selection key for the given profile More...
 
const char * getExtendedNegotiationKey (const char *key) const
 returns the extended negotiation key for the given profile More...
 

Private Attributes

OFMap< OFString,
DcmProfileEntry * > 
map_
 map of profiles
 

Detailed Description

this helper class maintains a map of association negotiation profile keys.

Not intended for use by the end user.

Member Function Documentation

OFCondition DcmProfileMap::add ( const char *  key,
const char *  presentationContextKey,
const char *  roleSelectionKey,
const char *  extendedNegotiationKey 
)

add new entry to list within map.

Parameters
keymap key, must not exist in map
presentationContextKeysymbolic identifier of the presentation context list, must not be NULL
roleSelectionKeysymbolic identifier of the role selection list, may be NULL
extendedNegotiationKeysymbolic identifier of the extended negotiation list, may be NULL
Returns
EC_Normal if successful, an error code otherwise
OFMap<OFString, DcmProfileEntry*>::const_iterator DcmProfileMap::begin ( )

const iterator pointing to start of profile map

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

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

Returns
iterator to end of profile map
const char* DcmProfileMap::getExtendedNegotiationKey ( const char *  key) const

returns the extended negotiation key for the given profile

Parameters
keykey name, must not be NULL
Returns
extended negotiation key, NULL if not found or empty
const char* DcmProfileMap::getPresentationContextKey ( const char *  key) const

returns the presentation context key for the given profile

Parameters
keykey name, must not be NULL
Returns
presentation context key, NULL if not found
const DcmProfileEntry* DcmProfileMap::getProfile ( const OFString name)

return profile entry from profile map by its name

Parameters
nameThe name of the profile, empty if unknown
Returns
the profile
const char* DcmProfileMap::getRoleSelectionKey ( const char *  key) const

returns the role selection key for the given profile

Parameters
keykey name, must not be NULL
Returns
role selection key, NULL if not found or empty
OFBool DcmProfileMap::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

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