Medical Imaging Interaction Toolkit  2024.06.99-b3904305
Medical Imaging Interaction Toolkit
berry::IParameter Struct Referenceabstract

#include <berryIParameter.h>

Inheritance diagram for berry::IParameter:
Collaboration diagram for berry::IParameter:

Public Types

typedef QHash< QString, QString > ParameterValues
- 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

Public Member Functions

 berryObjectMacro (berry::IParameter)
virtual QString GetId () const =0
virtual QString GetName () const =0
virtual IParameterValuesGetValues () const =0
virtual bool IsOptional () const =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 uint HashCode () 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
virtual bool operator== (const Object *) const

Additional Inherited Members

- Static Public Member Functions inherited from berry::Object
static const char * GetStaticClassName ()
static Reflection::TypeInfo GetStaticTypeInfo ()
static QList< Reflection::TypeInfoGetStaticSuperclasses ()
- 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 inherited from berry::Object
QAtomicInt m_ReferenceCount
QMutex m_ReferenceCountLock

Detailed Description

A parameter for a command. A parameter identifies a type of information that the command might accept. For example, a "Show View" command might accept the id of a view for display. This parameter also identifies possible values, for display in the user interface.

Definition at line 33 of file berryIParameter.h.

Member Typedef Documentation

◆ ParameterValues

typedef QHash<QString, QString> berry::IParameter::ParameterValues

Definition at line 38 of file berryIParameter.h.

Member Function Documentation

◆ berryObjectMacro()

berry::IParameter::berryObjectMacro ( berry::IParameter  )

◆ GetId()

virtual QString berry::IParameter::GetId ( ) const
pure virtual

Returns the identifier for this parameter.

The identifier; never null.

◆ GetName()

virtual QString berry::IParameter::GetName ( ) const
pure virtual

Returns the human-readable name for this parameter.

The parameter name; never null.

◆ GetValues()

virtual IParameterValues* berry::IParameter::GetValues ( ) const
pure virtual

Returns the values associated with this parameter.

The values associated with this parameter. This must not be null.
ParameterValuesExceptionIf the values can't be retrieved for some reason.

◆ IsOptional()

virtual bool berry::IParameter::IsOptional ( ) const
pure virtual

Returns whether parameter is optional. Otherwise, it is required.

true if the parameter is optional; false if it is required.

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