Biorbd
Public Member Functions | Protected Attributes | List of all members
biorbd::utils::Range Class Reference

Class Range. More...

#include <Range.h>

Public Member Functions

 Range (double min=-M_PI, double max=M_PI)
 Construct generalized coordinates range. More...
 
biorbd::utils::Range DeepCopy () const
 Deep copy of the Range. More...
 
void DeepCopy (const biorbd::utils::Range &other)
 Deep copy of Range. More...
 
void setMin (double min)
 Set a new value for the minimum. More...
 
double min () const
 Return the minimum value. More...
 
void setMax (double max)
 Set a new value for the maximal. More...
 
double max () const
 Return the maximum value. More...
 

Protected Attributes

std::shared_ptr< double > m_min
 The minimal value allowed by the range.
 
std::shared_ptr< double > m_max
 The maximal value allowed by the range.
 

Detailed Description

Class Range.

Definition at line 14 of file Range.h.

Constructor & Destructor Documentation

◆ Range()

biorbd::utils::Range::Range ( double  min = -M_PI,
double  max = M_PI 
)

Construct generalized coordinates range.

Definition at line 4 of file Range.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

biorbd::utils::Range biorbd::utils::Range::DeepCopy ( ) const

Deep copy of the Range.

Returns
Deep copy of the Range

Definition at line 14 of file Range.cpp.

◆ DeepCopy() [2/2]

void biorbd::utils::Range::DeepCopy ( const biorbd::utils::Range other)

Deep copy of Range.

Parameters
otherThe Range to copy

Definition at line 21 of file Range.cpp.

◆ max()

double biorbd::utils::Range::max ( ) const

Return the maximum value.

Returns
The minimum value

Definition at line 45 of file Range.cpp.

◆ min()

double biorbd::utils::Range::min ( ) const

Return the minimum value.

Returns
The minimum value

Definition at line 34 of file Range.cpp.

◆ setMax()

void biorbd::utils::Range::setMax ( double  max)

Set a new value for the maximal.

Parameters
maxThe value to set to

Definition at line 39 of file Range.cpp.

◆ setMin()

void biorbd::utils::Range::setMin ( double  min)

Set a new value for the minimum.

Parameters
minThe value to set to

Definition at line 28 of file Range.cpp.


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