CustusX  2021.04.21-dev+develop.337f9
An IGT application
cx::DoublePropertyToolOffset Class Reference

Interface to the tool offset of a tool. More...

#include <cxDataInterface.h>

Inheritance diagram for cx::DoublePropertyToolOffset:
cx::DoublePropertyBase cx::Property

Public Member Functions

 DoublePropertyToolOffset (ToolPtr tool)
 
virtual ~DoublePropertyToolOffset ()
 
virtual QString getDisplayName () const
 name of data entity. Used for display to user. More...
 
virtual QString getHelp () const
 return a descriptive help string for the data, used for example as a tool tip. More...
 
virtual double getValue () const
 get the data value. More...
 
virtual bool setValue (double val)
 set the data value. More...
 
virtual void connectValueSignals (bool on)
 
DoubleRange getValueRange () const
 
void setTool (ToolPtr tool)
 
- Public Member Functions inherited from cx::DoublePropertyBase
 DoublePropertyBase ()
 
virtual ~DoublePropertyBase ()
 
virtual QVariant getValueAsVariant () const
 
virtual void setValueFromVariant (QVariant val)
 
virtual QString getUid () const
 
virtual void setGuiRepresentation (GuiRepresentation type)
 
virtual GuiRepresentation getGuiRepresentation ()
 
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 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 boost::shared_ptr< DoublePropertyToolOffsetcreate (ToolPtr tool)
 
- Static Public Member Functions inherited from cx::Property
static PropertyPtr findProperty (std::vector< PropertyPtr > properties, QString id)
 

Protected Attributes

ToolPtr mTool
 
- Protected Attributes inherited from cx::DoublePropertyBase
GuiRepresentation mGuiRepresentation
 
- Protected Attributes inherited from cx::Property
bool mEnabled
 
bool mAdvanced
 
QString mGroup
 

Additional Inherited Members

- Public Types inherited from cx::DoublePropertyBase
enum  GuiRepresentation { grSPINBOX, grSLIDER, grDIAL }
 
- 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...
 

Detailed Description

Interface to the tool offset of a tool.

Definition at line 63 of file cxDataInterface.h.

Constructor & Destructor Documentation

cx::DoublePropertyToolOffset::DoublePropertyToolOffset ( ToolPtr  tool)

Definition at line 59 of file cxDataInterface.cpp.

virtual cx::DoublePropertyToolOffset::~DoublePropertyToolOffset ( )
inlinevirtual

Definition at line 73 of file cxDataInterface.h.

Member Function Documentation

virtual void cx::DoublePropertyToolOffset::connectValueSignals ( bool  on)
inlinevirtual

Definition at line 81 of file cxDataInterface.h.

static boost::shared_ptr<DoublePropertyToolOffset> cx::DoublePropertyToolOffset::create ( ToolPtr  tool)
inlinestatic

Definition at line 67 of file cxDataInterface.h.

virtual QString cx::DoublePropertyToolOffset::getDisplayName ( ) const
inlinevirtual

name of data entity. Used for display to user.

Implements cx::DoublePropertyBase.

Definition at line 74 of file cxDataInterface.h.

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

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

Reimplemented from cx::DoublePropertyBase.

Definition at line 75 of file cxDataInterface.h.

double cx::DoublePropertyToolOffset::getValue ( ) const
virtual

get the data value.

Implements cx::DoublePropertyBase.

Definition at line 75 of file cxDataInterface.cpp.

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

Reimplemented from cx::DoublePropertyBase.

Definition at line 86 of file cxDataInterface.cpp.

void cx::DoublePropertyToolOffset::setTool ( ToolPtr  tool)

Definition at line 65 of file cxDataInterface.cpp.

bool cx::DoublePropertyToolOffset::setValue ( double  value)
virtual

set the data value.

Implements cx::DoublePropertyBase.

Definition at line 80 of file cxDataInterface.cpp.

Member Data Documentation

ToolPtr cx::DoublePropertyToolOffset::mTool
protected

Definition at line 87 of file cxDataInterface.h.


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