Medical Imaging Interaction Toolkit  2024.06.00
Medical Imaging Interaction Toolkit
berry::HandleObjectManager Class Reference

#include <berryHandleObjectManager.h>

Inheritance diagram for berry::HandleObjectManager:

Protected Types

typedef QSet< SmartPointer< HandleObject > > HandleObjectsSet
 
typedef QHash< QString, SmartPointer< HandleObject > > HandleObjectsByIdMap
 

Protected Member Functions

void CheckId (const QString &id) const
 
QSet< QString > GetDefinedHandleObjectIds () const
 

Protected Attributes

HandleObjectsSet definedHandleObjects
 
HandleObjectsByIdMap handleObjectsById
 

Detailed Description

A manager of HandleObject instances. This has some common behaviour which is shared between all such managers.

Clients may extend.

Definition at line 37 of file berryHandleObjectManager.h.

Member Typedef Documentation

◆ HandleObjectsByIdMap

Definition at line 43 of file berryHandleObjectManager.h.

◆ HandleObjectsSet

Member Function Documentation

◆ CheckId()

void berry::HandleObjectManager::CheckId ( const QString &  id) const
protected

Verifies that the identifier is valid. Exceptions will be thrown if the identifier is invalid in some way.

Parameters
idThe identifier to validate; may be anything.

◆ GetDefinedHandleObjectIds()

QSet<QString> berry::HandleObjectManager::GetDefinedHandleObjectIds ( ) const
protected

Returns the set of identifiers for those handle objects that are defined.

Returns
The set of defined handle object identifiers; this value may be empty, but it is never null.

Member Data Documentation

◆ definedHandleObjects

HandleObjectsSet berry::HandleObjectManager::definedHandleObjects
protected

The set of handle objects that are defined. This value may be empty, but it is never null.

Definition at line 49 of file berryHandleObjectManager.h.

◆ handleObjectsById

HandleObjectsByIdMap berry::HandleObjectManager::handleObjectsById
protected

The map of identifiers (String) to handle objects ( HandleObject). This collection may be empty, but it is never null.

Definition at line 56 of file berryHandleObjectManager.h.


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