Medical Imaging Interaction Toolkit  2021.10.99-fd647480
Medical Imaging Interaction Toolkit
berry::NamedHandleObject Class Reference

#include <berryNamedHandleObject.h>

Inheritance diagram for berry::NamedHandleObject:
Collaboration diagram for berry::NamedHandleObject:

Public Member Functions

 berryObjectMacro (NamedHandleObject)
 
virtual QString GetDescription () const
 
virtual QString GetName () const
 
- Public Member Functions inherited from berry::HandleObject
 berryObjectMacro (HandleObject)
 
bool operator== (const Object *object) const override
 
QString GetId () const
 
uint HashCode () const override
 
bool IsDefined () const
 
virtual void Undefine ()=0
 
- Public Member Functions inherited from berry::Object
virtual QString GetClassName () const
 
virtual Reflection::TypeInfo GetTypeInfo () const
 
virtual QList< Reflection::TypeInfoGetSuperclasses () const
 
virtual void Delete ()
 
QDebug Print (QDebug os, Indent Indent=0) const
 
virtual QString ToString () const
 
virtual bool operator< (const Object *) const
 
void Register () const
 
void UnRegister (bool del=true) const
 
int GetReferenceCount () const
 
void SetReferenceCount (int)
 
void AddDestroyListener (const MessageAbstractDelegate<> &delegate) const
 
void RemoveDestroyListener (const MessageAbstractDelegate<> &delegate) const
 

Protected Member Functions

 NamedHandleObject (const QString &id)
 
- Protected Member Functions inherited from berry::HandleObject
 HandleObject (const QString &id)
 
- Protected Member Functions inherited from berry::Object
 Object ()
 
virtual ~Object ()
 
virtual QDebug PrintSelf (QDebug os, Indent indent) const
 
virtual QDebug PrintHeader (QDebug os, Indent indent) const
 
virtual QDebug PrintTrailer (QDebug os, Indent indent) const
 

Protected Attributes

QString description
 
QString name
 
- Protected Attributes inherited from berry::HandleObject
bool defined
 
const QString id
 
QString str
 
- Protected Attributes inherited from berry::Object
QAtomicInt m_ReferenceCount
 
QMutex m_ReferenceCountLock
 

Additional Inherited Members

- Public Types inherited from berry::Object
typedef Object Self
 
typedef berry::SmartPointer< SelfPointer
 
typedef berry::SmartPointer< const SelfConstPointer
 
typedef berry::WeakPointer< SelfWeakPtr
 
typedef berry::WeakPointer< const SelfConstWeakPtr
 
- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
 
static Reflection::TypeInfo GetStaticTypeInfo ()
 
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
 

Detailed Description

A handle object that carries with it a name and a description. This type of handle object is quite common across the commands code base. For example, Command, Context and Scheme.

Since
3.1

Definition at line 27 of file berryNamedHandleObject.h.

Constructor & Destructor Documentation

◆ NamedHandleObject()

berry::NamedHandleObject::NamedHandleObject ( const QString &  id)
protected

Constructs a new instance of NamedHandleObject.

Parameters
idThe identifier for this handle; must not be null.

Member Function Documentation

◆ berryObjectMacro()

berry::NamedHandleObject::berryObjectMacro ( NamedHandleObject  )

◆ GetDescription()

virtual QString berry::NamedHandleObject::GetDescription ( ) const
virtual

Returns the description for this handle.

Returns
The description; may be null if there is no description.
Exceptions
NotDefinedExceptionIf the handle is not currently defined.

Reimplemented in berry::NamedHandleObjectWithState.

◆ GetName()

virtual QString berry::NamedHandleObject::GetName ( ) const
virtual

Returns the name for this handle.

Returns
The name for this handle; never null.
Exceptions
NotDefinedExceptionIf the handle is not currently defined.

Reimplemented in berry::NamedHandleObjectWithState.

Member Data Documentation

◆ description

QString berry::NamedHandleObject::description
protected

The description for this handle. This value may be null if the handle is undefined or has no description.

Definition at line 39 of file berryNamedHandleObject.h.

◆ name

QString berry::NamedHandleObject::name
protected

The name of this handle. This valud should not be null unless the handle is undefined.

Definition at line 45 of file berryNamedHandleObject.h.


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