CTK  0.1.0
The Common Toolkit is a community effort to provide support code for medical image analysis, surgical navigation, and related projects.
Public Types | Public Slots | Public Member Functions | Protected Attributes | Properties | List of all members
ctkLinearValueProxy Class Reference

Implementation of an affine value proxy. The ctkLinearValueProxy takes a coefficient and an offset, effectively implementing a value proxy such as: valueProxy = coefficient * value + offset Note: If the coefficient is null then the property value given by value = (valueProxy - offset) / coefficient can give bad results (+ or - infinity depending on the sign of valueProxy - offset). More...

#include <Libs/Core/ctkLinearValueProxy.h>

Inheritance diagram for ctkLinearValueProxy:
Inheritance graph
[legend]
Collaboration diagram for ctkLinearValueProxy:
Collaboration graph
[legend]

Public Types

typedef ctkValueProxy Superclass
 
- Public Types inherited from ctkValueProxy
typedef QObject Superclass
 

Public Slots

virtual void setCoefficient (double newCoeff)
 
virtual void setOffset (double newOffset)
 
- Public Slots inherited from ctkValueProxy
void setProxyValue (double newProxyValue)
 
void setValue (double newValue)
 

Public Member Functions

virtual double coefficient () const
 
 ctkLinearValueProxy (QObject *parent=0)
 
virtual double offset () const
 
virtual double proxyValueFromValue (double value) const
 
virtual double valueFromProxyValue (double proxyValue) const
 
virtual ~ctkLinearValueProxy ()
 
- Public Member Functions inherited from ctkValueProxy
 ctkValueProxy (QObject *parent=0)
 
virtual double proxyValue () const
 
double value () const
 
virtual ~ctkValueProxy ()
 

Protected Attributes

QScopedPointer< ctkLinearValueProxyPrivate > d_ptr
 
- Protected Attributes inherited from ctkValueProxy
QScopedPointer< ctkValueProxyPrivate > d_ptr
 

Properties

double coefficient
 
double offset
 
- Properties inherited from ctkValueProxy
double proxyValue
 
double value
 

Additional Inherited Members

- Signals inherited from ctkValueProxy
void proxyAboutToBeModified ()
 
void proxyModified ()
 
void proxyValueChanged (double)
 
void valueChanged (double)
 
- Protected Member Functions inherited from ctkValueProxy
void updateProxyValue ()
 
void updateValue ()
 

Detailed Description

Implementation of an affine value proxy. The ctkLinearValueProxy takes a coefficient and an offset, effectively implementing a value proxy such as: valueProxy = coefficient * value + offset Note: If the coefficient is null then the property value given by value = (valueProxy - offset) / coefficient can give bad results (+ or - infinity depending on the sign of valueProxy - offset).

See also
ctkValueProxy

Definition at line 40 of file ctkLinearValueProxy.h.

Member Typedef Documentation

◆ Superclass

Definition at line 47 of file ctkLinearValueProxy.h.

Constructor & Destructor Documentation

◆ ctkLinearValueProxy()

ctkLinearValueProxy::ctkLinearValueProxy ( QObject *  parent = 0)
explicit

◆ ~ctkLinearValueProxy()

virtual ctkLinearValueProxy::~ctkLinearValueProxy ( )
virtual

Member Function Documentation

◆ coefficient()

virtual double ctkLinearValueProxy::coefficient ( ) const
virtual

◆ offset()

virtual double ctkLinearValueProxy::offset ( ) const
virtual

◆ proxyValueFromValue()

virtual double ctkLinearValueProxy::proxyValueFromValue ( double  value) const
virtual

Implements ctkValueProxy.

◆ setCoefficient

virtual void ctkLinearValueProxy::setCoefficient ( double  newCoeff)
virtualslot

◆ setOffset

virtual void ctkLinearValueProxy::setOffset ( double  newOffset)
virtualslot

◆ valueFromProxyValue()

virtual double ctkLinearValueProxy::valueFromProxyValue ( double  proxyValue) const
virtual

Implements ctkValueProxy.

Member Data Documentation

◆ d_ptr

QScopedPointer<ctkLinearValueProxyPrivate> ctkLinearValueProxy::d_ptr
protected

Definition at line 63 of file ctkLinearValueProxy.h.

Property Documentation

◆ coefficient

double ctkLinearValueProxy::coefficient
readwrite

Definition at line 1 of file ctkLinearValueProxy.h.

◆ offset

double ctkLinearValueProxy::offset
readwrite

Definition at line 1 of file ctkLinearValueProxy.h.


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