All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Attributes | List of all members
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

SurgSim::Physics::Mass::Mass ( double  mass = 0.0)
inlineexplicit

Constructor.

Parameters
massThe mass (in Kg) default value is 0

Member Function Documentation

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

Gets the mass.

Returns
The mass stored (in Kg)
bool SurgSim::Physics::Mass::operator!= ( const Mass m) const
inline

Comparison operator (inequality)

Parameters
mMass to compare it to
Returns
False if the 2 Mass contains the same information, True otherwise
bool SurgSim::Physics::Mass::operator== ( const Mass m) const
inline

Comparison operator (equality)

Parameters
mMass to compare it to
Returns
True if the 2 Mass contains the same information, false otherwise
void SurgSim::Physics::Mass::setMass ( double  mass)
inline

Sets the mass.

Parameters
massThe mass to be stored (in Kg)

Member Data Documentation

double SurgSim::Physics::Mass::m_mass
protected

Mass (in kg)


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