SurgSim::Physics::Mass Class Reference

`#include <SurgSim/Physics/Mass.h>`

## Public Member Functions

| Mass (double mass=0.0)
| Constructor. More...
void | setMass (double mass)
| Sets the mass. More...
double | getMass () const
| Gets the mass. More...
bool | operator== (const Mass &m) const
| Comparison operator (equality) More...
bool | operator!= (const Mass &m) const
| Comparison operator (inequality) More...

## Protected Attributes

double | m_mass
| Mass (in kg) More...

## Constructor & Destructor Documentation

## Mass()

SurgSim::Physics::Mass::Mass | ( | double | mass = `0.0` | ) |

inline explicit

Constructor.

Parameters

  mass | The mass (in Kg) default value is 0

## Member Function Documentation

## getMass()

double SurgSim::Physics::Mass::getMass | ( |  | ) | const

inline

Gets the mass.

Returns
  The mass stored (in Kg)

## operator!=()

bool SurgSim::Physics::Mass::operator!= | ( | const Mass & | m | ) | const

inline

Comparison operator (inequality)

Parameters

  m | Mass to compare it to

Returns
  False if the 2 Mass contains the same information, True otherwise

## operator==()

bool SurgSim::Physics::Mass::operator== | ( | const Mass & | m | ) | const

inline

Comparison operator (equality)

Parameters

  m | Mass to compare it to

Returns
  True if the 2 Mass contains the same information, false otherwise

## setMass()

void SurgSim::Physics::Mass::setMass | ( | double | mass | ) |

inline

Sets the mass.

Parameters

  mass | The mass to be stored (in Kg)

## Member Data Documentation

## m_mass

double SurgSim::Physics::Mass::m_mass

protected

Mass (in kg)

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

- SurgSim/Physics/Mass.h