Medical Imaging Interaction Toolkit  2023.04.99-859410e3
Medical Imaging Interaction Toolkit
berry::IParameterValueConverter Struct Referenceabstract

#include <berryIParameterValueConverter.h>

Public Member Functions

virtual ~IParameterValueConverter ()
virtual Object::Pointer ConvertToObject (const QString &parameterValue)=0
virtual QString ConvertToString (const Object::Pointer &parameterValue)=0

Detailed Description

Supports conversion between objects and strings for command parameter values. Extenders must produce strings that identify objects (of a specific command parameter type) as well as consume the strings to locate and return the objects they identify.

This class offers multiple handlers of a command a consistent way of converting string parameter values into the objects that the handlers would prefer to deal with. This class also gives clients a way to serialize object parameters as strings so that entire parameterized commands can be serialized, stored and later deserialized and executed.

This class will typically be extended so the subclass can be referenced from the converter attribute of the commandParameterType elemement of the org.blueberry.ui.commands extension-point. Objects implementing this interface may also be passed directly to ParameterType#Define by clients.

See also

Definition at line 50 of file berryIParameterValueConverter.h.

Constructor & Destructor Documentation

◆ ~IParameterValueConverter()

virtual berry::IParameterValueConverter::~IParameterValueConverter ( )

Member Function Documentation

◆ ConvertToObject()

virtual Object::Pointer berry::IParameterValueConverter::ConvertToObject ( const QString &  parameterValue)
pure virtual

Converts a string encoded command parameter value into the parameter value object.

parameterValuea command parameter value string describing an object; may be null
the object described by the command parameter value string; may be null
ParameterValueConversionExceptionif an object cannot be produced from the parameterValue string

◆ ConvertToString()

virtual QString berry::IParameterValueConverter::ConvertToString ( const Object::Pointer parameterValue)
pure virtual

Converts a command parameter value object into a string that encodes a reference to the object or serialization of the object.

parameterValuean object to convert into an identifying string; may be null
a string describing the provided object; may be null
ParameterValueConversionExceptionif a string reference or serialization cannot be provided for the parameterValue

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