CustusX  22.04-rc5
An IGT application
cx::DoublePairProperty Class Reference

Implementation of DoublePairPropertyBase. More...

#include <cxDoublePairProperty.h>

Inheritance diagram for cx::DoublePairProperty:
cx::DoublePairPropertyBase cx::Property

Signals

void valueWasSet ()
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 

Public Member Functions

void setInternal2Display (double factor)
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QString getUid () const
 
virtual bool setValue (const Eigen::Vector2d &value)
 set the data value. More...
 
virtual Eigen::Vector2d getValue () const
 get the data value. More...
 
virtual QString getHelp () const
 return a descriptive help string for the data, used for example as a tool tip. More...
 
virtual DoubleRange getValueRange () const
 
virtual void setValueRange (DoubleRange range)
 range of value. Use if data is constrained to a set. More...
 
virtual int getValueDecimals () const
 number of relevant decimals in value More...
 
virtual double convertInternal2Display (double internal)
 conversion from internal value to display value (for example between 0..1 and percent) More...
 
virtual double convertDisplay2Internal (double display)
 conversion from internal value to display value More...
 
- Public Member Functions inherited from cx::DoublePairPropertyBase
virtual ~DoublePairPropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant value)
 
- Public Member Functions inherited from cx::Property
 Property ()
 
virtual ~Property ()
 
virtual bool getEnabled () const
 Get the enabled/disabled state of the Property. More...
 
virtual bool getAdvanced () const
 Get the advanced flag of the adapter. More...
 
virtual QString getGroup () const
 Flag the adapter as part of a group. More...
 

Static Public Member Functions

static DoublePairPropertyPtr initialize (const QString &uid, QString name, QString help, DoubleRange range, int decimals, QDomNode root=QDomNode())
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

Additional Inherited Members

- Public Slots inherited from cx::Property
virtual bool setEnabled (bool enabled)
 Set the enabled/disabled state of the Property. More...
 
virtual bool setAdvanced (bool advanced)
 Set the advanced flag of the adapter. More...
 
virtual bool setGroup (QString name)
 Flag the adapter as part of a group. More...
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Implementation of DoublePairPropertyBase.

Represents one option of the double type. The data are stored within a xml document.

The option node has this layout:

        <option id="Processor" value="3.14"/>
Date
Juli 31, 2014
Author
Ole Vegard Solberg, SINTEF

Definition at line 40 of file cxDoublePairProperty.h.

Member Function Documentation

virtual double cx::DoublePairProperty::convertDisplay2Internal ( double  display)
inlinevirtual

conversion from internal value to display value

Reimplemented from cx::DoublePairPropertyBase.

Definition at line 65 of file cxDoublePairProperty.h.

virtual double cx::DoublePairProperty::convertInternal2Display ( double  internal)
inlinevirtual

conversion from internal value to display value (for example between 0..1 and percent)

Reimplemented from cx::DoublePairPropertyBase.

Definition at line 61 of file cxDoublePairProperty.h.

QString cx::DoublePairProperty::getDisplayName ( ) const
virtual

name of data entity. Used for display to user.

Implements cx::DoublePairPropertyBase.

Definition at line 46 of file cxDoublePairProperty.cpp.

QString cx::DoublePairProperty::getHelp ( ) const
virtual

return a descriptive help string for the data, used for example as a tool tip.

Reimplemented from cx::DoublePairPropertyBase.

Definition at line 56 of file cxDoublePairProperty.cpp.

QString cx::DoublePairProperty::getUid ( ) const
virtual

Implements cx::Property.

Definition at line 51 of file cxDoublePairProperty.cpp.

Eigen::Vector2d cx::DoublePairProperty::getValue ( ) const
virtual

get the data value.

Implements cx::DoublePairPropertyBase.

Definition at line 61 of file cxDoublePairProperty.cpp.

int cx::DoublePairProperty::getValueDecimals ( ) const
virtual

number of relevant decimals in value

Reimplemented from cx::DoublePairPropertyBase.

Definition at line 89 of file cxDoublePairProperty.cpp.

DoubleRange cx::DoublePairProperty::getValueRange ( ) const
virtual

Reimplemented from cx::DoublePairPropertyBase.

Definition at line 78 of file cxDoublePairProperty.cpp.

DoublePairPropertyPtr cx::DoublePairProperty::initialize ( const QString &  uid,
QString  name,
QString  help,
DoubleRange  range,
int  decimals,
QDomNode  root = QDomNode() 
)
static

Make sure one given option exists witin root. If not present, fill inn the input defaults.

Definition at line 22 of file cxDoublePairProperty.cpp.

void cx::DoublePairProperty::setInternal2Display ( double  factor)

Definition at line 41 of file cxDoublePairProperty.cpp.

bool cx::DoublePairProperty::setValue ( const Eigen::Vector2d &  value)
virtual

set the data value.

Implements cx::DoublePairPropertyBase.

Definition at line 66 of file cxDoublePairProperty.cpp.

void cx::DoublePairProperty::setValueRange ( DoubleRange  range)
virtual

range of value. Use if data is constrained to a set.

Implements cx::DoublePairPropertyBase.

Definition at line 83 of file cxDoublePairProperty.cpp.

void cx::DoublePairProperty::valueWasSet ( )
signal

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