CustusX  2023.01.05-dev+develop.0da12
An IGT application
Public Member Functions | Public Attributes | List of all members
cx::DoubleRange Struct Reference
CustusX System » Resource Layer » Core » Utilities

Utility class for describing a bounded numeric range. More...

#include <cxDoubleRange.h>

Public Member Functions

 DoubleRange ()
 
 DoubleRange (double min, double max, double step)
 
double min () const
 minimum value More...
 
double max () const
 maximum value More...
 
double step () const
 smallest reasonable increment More...
 
double resolution () const
 number of steps in range (1 step means 1 resolution). More...
 
double range () const
 max - min More...
 
double constrainValue (double val)
 

Public Attributes

double mMin
 
double mMax
 
double mStep
 

Detailed Description

Utility class for describing a bounded numeric range.

Definition at line 32 of file cxDoubleRange.h.

Constructor & Destructor Documentation

cx::DoubleRange::DoubleRange ( )
inline

Definition at line 34 of file cxDoubleRange.h.

cx::DoubleRange::DoubleRange ( double  min,
double  max,
double  step 
)
inline

Definition at line 38 of file cxDoubleRange.h.

Member Function Documentation

double cx::DoubleRange::constrainValue ( double  val)
inline

Constrain the input to the range |min,max|

Definition at line 68 of file cxDoubleRange.h.

double cx::DoubleRange::max ( ) const
inline

maximum value

Definition at line 49 of file cxDoubleRange.h.

double cx::DoubleRange::min ( ) const
inline

minimum value

Definition at line 45 of file cxDoubleRange.h.

double cx::DoubleRange::range ( ) const
inline

max - min

Definition at line 61 of file cxDoubleRange.h.

double cx::DoubleRange::resolution ( ) const
inline

number of steps in range (1 step means 1 resolution).

Definition at line 57 of file cxDoubleRange.h.

double cx::DoubleRange::step ( ) const
inline

smallest reasonable increment

Definition at line 53 of file cxDoubleRange.h.

Member Data Documentation

double cx::DoubleRange::mMax

Definition at line 43 of file cxDoubleRange.h.

double cx::DoubleRange::mMin

Definition at line 42 of file cxDoubleRange.h.

double cx::DoubleRange::mStep

Definition at line 44 of file cxDoubleRange.h.

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