Biorbd Release_1.13.0
Loading...
Searching...
No Matches
BIORBD_NAMESPACE::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.
Range DeepCopy () const
 Deep copy of the Range.
void DeepCopy (const Range &other)
 Deep copy of Range.
void setMin (double min)
 Set a new value for the minimum.
double min () const
 Return the minimum value.
void setMax (double max)
 Set a new value for the maximal.
double max () const
 Return the maximum value.

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()

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

Construct generalized coordinates range.

Parameters
minThe minimal value of the range
maxThe maximal value of the range

Definition at line 6 of file Range.cpp.

Member Function Documentation

◆ DeepCopy() [1/2]

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

Deep copy of the Range.

Returns
Deep copy of the Range

Definition at line 10 of file Range.cpp.

◆ DeepCopy() [2/2]

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

Deep copy of Range.

Parameters
otherThe Range to copy

Definition at line 16 of file Range.cpp.

◆ max()

double utils::Range::max ( ) const

Return the maximum value.

Returns
The minimum value

Definition at line 27 of file Range.cpp.

◆ min()

double utils::Range::min ( ) const

Return the minimum value.

Returns
The minimum value

Definition at line 23 of file Range.cpp.

◆ setMax()

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

Set a new value for the maximal.

Parameters
maxThe value to set to

Definition at line 25 of file Range.cpp.

◆ setMin()

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

Set a new value for the minimum.

Parameters
minThe value to set to

Definition at line 21 of file Range.cpp.

Member Data Documentation

◆ m_max

std::shared_ptr<double> BIORBD_NAMESPACE::utils::Range::m_max
protected

The maximal value allowed by the range.

Definition at line 61 of file Range.h.

◆ m_min

std::shared_ptr<double> BIORBD_NAMESPACE::utils::Range::m_min
protected

The minimal value allowed by the range.

Definition at line 60 of file Range.h.


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