iCub-main
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
iCub::iKin::iKinLimbVersion Class Reference

A class for defining the versions of the iCub limbs. More...

#include <iKinFwd.h>

Public Member Functions

 iKinLimbVersion ()
 Default Constructor.
 
 iKinLimbVersion (const std::string &version)
 Constructor.
 
 iKinLimbVersion (const unsigned long int v_major, const unsigned long int v_minor)
 Constructor.
 
 iKinLimbVersion (const iKinLimbVersion &v)
 Copy Constructor.
 
unsigned long int get_major () const
 Return the major version.
 
unsigned long int get_minor () const
 Return the minor version.
 
std::string get_version () const
 Return the version string.
 
iKinLimbVersionoperator= (const iKinLimbVersion &v)
 Overloaded assignment operator.
 
bool operator< (const iKinLimbVersion &v) const
 Overloaded < operator.
 
bool operator<= (const iKinLimbVersion &v) const
 Overloaded <= operator.
 
bool operator== (const iKinLimbVersion &v) const
 Overloaded == operator.
 
bool operator!= (const iKinLimbVersion &v) const
 Overloaded != operator.
 
bool operator>= (const iKinLimbVersion &v) const
 Overloaded >=</=> operator.
 
bool operator> (const iKinLimbVersion &v) const
 Overloaded > operator.
 
iKinLimbVersion operator- (const iKinLimbVersion &v) const
 Overloaded - operator.
 

Protected Attributes

unsigned long int v_major
 
unsigned long int v_minor
 

Detailed Description

A class for defining the versions of the iCub limbs.

Definition at line 1044 of file iKinFwd.h.

Constructor & Destructor Documentation

◆ iKinLimbVersion() [1/4]

iKinLimbVersion::iKinLimbVersion ( )

Default Constructor.

Definition at line 1546 of file iKinFwd.cpp.

◆ iKinLimbVersion() [2/4]

iKinLimbVersion::iKinLimbVersion ( const std::string &  version)

Constructor.

Parameters
versionis a string for specifying different kinematics, e.g., "1.23".

Definition at line 1552 of file iKinFwd.cpp.

◆ iKinLimbVersion() [3/4]

iKinLimbVersion::iKinLimbVersion ( const unsigned long int  v_major,
const unsigned long int  v_minor 
)

Constructor.

Parameters
v_majorthe major version.
v_minorthe mninor version.

Definition at line 1569 of file iKinFwd.cpp.

◆ iKinLimbVersion() [4/4]

iKinLimbVersion::iKinLimbVersion ( const iKinLimbVersion v)

Copy Constructor.

Definition at line 1578 of file iKinFwd.cpp.

Member Function Documentation

◆ get_major()

unsigned long int iKinLimbVersion::get_major ( ) const

Return the major version.

Returns
the major version.

Definition at line 1586 of file iKinFwd.cpp.

◆ get_minor()

unsigned long int iKinLimbVersion::get_minor ( ) const

Return the minor version.

Returns
the minor version.

Definition at line 1593 of file iKinFwd.cpp.

◆ get_version()

string iKinLimbVersion::get_version ( ) const

Return the version string.

Returns
the version string.

Definition at line 1600 of file iKinFwd.cpp.

◆ operator!=()

bool iKinLimbVersion::operator!= ( const iKinLimbVersion v) const

Overloaded != operator.

Parameters
vthe version to compare with.
Returns
true iff != v.

Definition at line 1644 of file iKinFwd.cpp.

◆ operator-()

iKinLimbVersion iKinLimbVersion::operator- ( const iKinLimbVersion v) const

Overloaded - operator.

Parameters
vthe version to compare with.
Returns
the distance from v.

Definition at line 1665 of file iKinFwd.cpp.

◆ operator<()

bool iKinLimbVersion::operator< ( const iKinLimbVersion v) const

Overloaded < operator.

Parameters
vthe version to compare with.
Returns
true iff < v.

Definition at line 1618 of file iKinFwd.cpp.

◆ operator<=()

bool iKinLimbVersion::operator<= ( const iKinLimbVersion v) const

Overloaded <= operator.

Parameters
vthe version to compare with.
Returns
true iff <= v.

Definition at line 1651 of file iKinFwd.cpp.

◆ operator=()

iKinLimbVersion & iKinLimbVersion::operator= ( const iKinLimbVersion v)

Overloaded assignment operator.

Parameters
vthe version to be assigned.
Returns
.

Definition at line 1609 of file iKinFwd.cpp.

◆ operator==()

bool iKinLimbVersion::operator== ( const iKinLimbVersion v) const

Overloaded == operator.

Parameters
vthe version to compare with.
Returns
true iff == v.

Definition at line 1637 of file iKinFwd.cpp.

◆ operator>()

bool iKinLimbVersion::operator> ( const iKinLimbVersion v) const

Overloaded > operator.

Parameters
vthe version to compare with.
Returns
true iff > v.

Definition at line 1630 of file iKinFwd.cpp.

◆ operator>=()

bool iKinLimbVersion::operator>= ( const iKinLimbVersion v) const

Overloaded >=</=> operator.

Parameters
vthe version to compare with.
Returns
true iff >= v.

Definition at line 1658 of file iKinFwd.cpp.

Member Data Documentation

◆ v_major

unsigned long int iCub::iKin::iKinLimbVersion::v_major
protected

Definition at line 1047 of file iKinFwd.h.

◆ v_minor

unsigned long int iCub::iKin::iKinLimbVersion::v_minor
protected

Definition at line 1048 of file iKinFwd.h.


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