CustusX  18.04
An IGT application
cx::DoublePairPropertyBase Class Referenceabstract

Abstract interface for interaction with internal data structure: A pair of doubles. More...

#include <cxDoublePairPropertyBase.h>

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

Public Member Functions

virtual ~DoublePairPropertyBase ()
 
virtual QString getDisplayName () const =0
 name of data entity. Used for display to user. More...
 
virtual bool setValue (const Eigen::Vector2d &value)=0
 set the data value. More...
 
virtual Eigen::Vector2d getValue () const =0
 get the data value. More...
 
virtual void setValueRange (DoubleRange range)=0
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant value)
 
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 double convertInternal2Display (double internal)
 range of value More...
 
virtual double convertDisplay2Internal (double display)
 conversion from internal value to display value More...
 
virtual int getValueDecimals () const
 number of relevant decimals in value More...
 
- Public Member Functions inherited from cx::Property
 Property ()
 
virtual ~Property ()
 
virtual QString getUid () const =0
 
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...
 

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...
 
- Signals inherited from cx::Property
void changed ()
 emit when the underlying data value is changed: The user interface will be updated. More...
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Detailed Description

Abstract interface for interaction with internal data structure: A pair of doubles.

Date
Juli 31, 2014
Author
Ole Vegard Solberg, SINTEF

Definition at line 33 of file cxDoublePairPropertyBase.h.

Constructor & Destructor Documentation

virtual cx::DoublePairPropertyBase::~DoublePairPropertyBase ( )
inlinevirtual

Definition at line 37 of file cxDoublePairPropertyBase.h.

Member Function Documentation

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

conversion from internal value to display value

Reimplemented in cx::DoublePairProperty.

Definition at line 76 of file cxDoublePairPropertyBase.h.

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

range of value

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

Reimplemented in cx::DoublePairProperty.

Definition at line 72 of file cxDoublePairPropertyBase.h.

virtual QString cx::DoublePairPropertyBase::getDisplayName ( ) const
pure virtual

name of data entity. Used for display to user.

Implements cx::Property.

Implemented in cx::DoubleSpanSliderAdapterNull, and cx::DoublePairProperty.

virtual QString cx::DoublePairPropertyBase::getHelp ( ) const
inlinevirtual

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

Reimplemented in cx::DoublePairProperty.

Definition at line 64 of file cxDoublePairPropertyBase.h.

virtual Eigen::Vector2d cx::DoublePairPropertyBase::getValue ( ) const
pure virtual

get the data value.

Implemented in cx::DoubleSpanSliderAdapterNull, and cx::DoublePairProperty.

virtual QVariant cx::DoublePairPropertyBase::getValueAsVariant ( ) const
inlinevirtual

Implements cx::Property.

Definition at line 50 of file cxDoublePairPropertyBase.h.

virtual int cx::DoublePairPropertyBase::getValueDecimals ( ) const
inlinevirtual

number of relevant decimals in value

Reimplemented in cx::DoublePairProperty.

Definition at line 80 of file cxDoublePairPropertyBase.h.

virtual DoubleRange cx::DoublePairPropertyBase::getValueRange ( ) const
inlinevirtual

Reimplemented in cx::DoublePairProperty.

Definition at line 68 of file cxDoublePairPropertyBase.h.

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

set the data value.

Implemented in cx::DoubleSpanSliderAdapterNull, and cx::DoublePairProperty.

virtual void cx::DoublePairPropertyBase::setValueFromVariant ( QVariant  value)
inlinevirtual

Implements cx::Property.

Definition at line 56 of file cxDoublePairPropertyBase.h.

virtual void cx::DoublePairPropertyBase::setValueRange ( DoubleRange  range)
pure virtual

Implemented in cx::DoublePairProperty.


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