#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 36 of file berryParameterization.h.

Constructor & Destructor Documentation

◆ Parameterization() [1/2]

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

Constructs a new instance of Parameterization.

Parameters

parameter	The parameter that is being parameterized; must not be `null`.
value	The value for the parameter; may be `null`.

Definition at line 24 of file berryParameterization.cpp.

◆ Parameterization() [2/2]

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

Copy constructor

Definition at line 34 of file berryParameterization.cpp.

Member Function Documentation

◆ GetParameter()

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

Returns the parameter that is being parameterized.

Returns: The parameter; never null.

Definition at line 73 of file berryParameterization.cpp.

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

◆ GetValue()

QString berry::Parameterization::GetValue ( ) const

Returns the value for the parameter in this parameterization.

Returns: The value; may be null.

Definition at line 78 of file berryParameterization.cpp.

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

◆ GetValueName()

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

ParameterValuesException If the parameter needed to be initialized, but couldn't be.

Definition at line 83 of file berryParameterization.cpp.

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

◆ HashCode()

uint berry::Parameterization::HashCode ( ) const

Definition at line 102 of file berryParameterization.cpp.

References qHash().

◆ operator bool()

berry::Parameterization::operator bool ( ) const

Definition at line 68 of file berryParameterization.cpp.

◆ operator=()

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

Definition at line 40 of file berryParameterization.cpp.

◆ operator==()

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

Definition at line 49 of file berryParameterization.cpp.

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

Public Member Functions