Medical Imaging Interaction Toolkit  2016.11.0
Medical Imaging Interaction Toolkit
Public Member Functions | List of all members
berry::Parameterization Class Reference

#include <berryParameterization.h>

Public Member Functions

 Parameterization (const SmartPointer< const IParameter > parameter, const QString &value)
 
 Parameterization (const Parameterization &p)
 
Parameterization & operator= (const Parameterization &p)
 
bool operator== (const Parameterization &parameterization) const
 
 operator bool () const
 
SmartPointer< const IParameter > GetParameter () const
 
QString GetValue () const
 
QString GetValueName () const
 
uint HashCode () const
 

Detailed Description

A parameter with a specific value. This is usually a part of a ParameterizedCommand, which is used to refer to a command with a collection of parameterizations.

Since
3.1

Definition at line 40 of file berryParameterization.h.

Constructor & Destructor Documentation

berry::Parameterization::Parameterization ( const SmartPointer< const IParameter >  parameter,
const QString &  value 
)

Constructs a new instance of Parameterization.

Parameters
parameterThe parameter that is being parameterized; must not be null.
valueThe value for the parameter; may be null.

Definition at line 28 of file berryParameterization.cpp.

berry::Parameterization::Parameterization ( const Parameterization &  p)

Copy constructor

Definition at line 38 of file berryParameterization.cpp.

Member Function Documentation

SmartPointer< const IParameter > berry::Parameterization::GetParameter ( ) const

Returns the parameter that is being parameterized.

Returns
The parameter; never null.

Definition at line 77 of file berryParameterization.cpp.

Referenced by berry::ParameterizedCommand::GetName(), berry::ParameterizedCommand::GetParameterMap(), and berry::ParameterizedCommand::Serialize().

QString berry::Parameterization::GetValue ( ) const

Returns the value for the parameter in this parameterization.

Returns
The value; may be null.

Definition at line 82 of file berryParameterization.cpp.

Referenced by berry::ParameterizedCommand::GetParameterMap(), and berry::ParameterizedCommand::Serialize().

QString berry::Parameterization::GetValueName ( ) const

Returns the human-readable name for the current value, if any. If the name cannot be found, then it simply returns the value. It also ensures that any null values are converted into an empty string.

Returns
The human-readable name of the value; never null.
Exceptions
ParameterValuesExceptionIf the parameter needed to be initialized, but couldn't be.

Definition at line 87 of file berryParameterization.cpp.

Referenced by berry::ParameterizedCommand::GetName().

uint berry::Parameterization::HashCode ( ) const

Definition at line 106 of file berryParameterization.cpp.

References qHash().

berry::Parameterization::operator bool ( ) const

Definition at line 72 of file berryParameterization.cpp.

Parameterization & berry::Parameterization::operator= ( const Parameterization &  p)

Definition at line 44 of file berryParameterization.cpp.

bool berry::Parameterization::operator== ( const Parameterization &  parameterization) const

Definition at line 53 of file berryParameterization.cpp.

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