OpenSim::Measurement Class Reference

A class implementing a measurement (the distance between one or more pairs of markers, used to scale a model). More...

#include <Measurement.h>

Inheritance diagram for OpenSim::Measurement:

List of all members.

Public Member Functions
	Measurement ()
	Default constructor.
	Measurement (const Measurement &aMeasurement)
	Copy constructor.
virtual	~Measurement ()
	Destructor.
virtual Object *	copy () const
	Copy this measurement and return a pointer to the copy.
Measurement &	operator= (const Measurement &aMeasurement)
	Assignment operator.
void	copyData (const Measurement &aMeasurement)
	Copy data members from one Measurement to another.
BodyScaleSet &	getBodyScaleSet ()
MarkerPairSet &	getMarkerPairSet ()
int	getNumMarkerPairs () const
const MarkerPair &	getMarkerPair (int aIndex) const
bool	getApply () const
void	setApply (bool aApply)
void	applyScaleFactor (double aFactor, ScaleSet &aScaleSet)
	Apply a scale factor to a scale set, according to the elements of the Measurement's _bodyScaleSet.
Static Public Member Functions
static void	registerTypes ()
	Register the types used by Measurement.
Protected Attributes
PropertyObj	_markerPairSetProp
MarkerPairSet &	_markerPairSet
PropertyObj	_bodyScaleSetProp
BodyScaleSet &	_bodyScaleSet
PropertyBool	_applyProp
bool &	_apply

---

Detailed Description

A class implementing a measurement (the distance between one or more pairs of markers, used to scale a model).

Author:

Peter Loan

Version:

1.0

---

Constructor & Destructor Documentation

Measurement::Measurement

(

)

Default constructor.

Measurement::Measurement

(

const Measurement &

aMeasurement

)

Copy constructor.

Parameters:

aMeasurement

Measurement to be copied.

Measurement::~Measurement

(

)

[virtual]

Destructor.

---

Member Function Documentation

void Measurement::applyScaleFactor	(	double	aFactor,
		ScaleSet &	aScaleSet
	)

Apply a scale factor to a scale set, according to the elements of the Measurement's _bodyScaleSet.

Parameters:

	aFactor	the scale factor to apply
	aScaleSet	the set of scale factors to modify

Object * Measurement::copy

(

)

const [virtual]

Copy this measurement and return a pointer to the copy.

The copy constructor for this class is used.

Returns:

Pointer to a copy of this Measurement.

Reimplemented from OpenSim::Object.

void Measurement::copyData

(

const Measurement &

aMeasurement

)

Copy data members from one Measurement to another.

Parameters:

aMeasurement

Measurement to be copied.

bool OpenSim::Measurement::getApply

(

)

const [inline]

BodyScaleSet& OpenSim::Measurement::getBodyScaleSet

(

)

[inline]

const MarkerPair& OpenSim::Measurement::getMarkerPair

(

int

aIndex

)

const [inline]

MarkerPairSet& OpenSim::Measurement::getMarkerPairSet

(

)

[inline]

int OpenSim::Measurement::getNumMarkerPairs

(

)

const [inline]

Measurement & Measurement::operator=

(

const Measurement &

aMeasurement

)

Assignment operator.

Returns:

Reference to this object.

Reimplemented from OpenSim::Object.

void Measurement::registerTypes

(

)

[static]

Register the types used by Measurement.

void OpenSim::Measurement::setApply

(

bool

aApply

)

[inline]

---

Member Data Documentation

bool& OpenSim::Measurement::_apply [protected]

PropertyBool OpenSim::Measurement::_applyProp [protected]

BodyScaleSet& OpenSim::Measurement::_bodyScaleSet [protected]

PropertyObj OpenSim::Measurement::_bodyScaleSetProp [protected]

MarkerPairSet& OpenSim::Measurement::_markerPairSet [protected]

PropertyObj OpenSim::Measurement::_markerPairSetProp [protected]

---

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

• OpenSim/Tools/Measurement.h
• OpenSim/Tools/Measurement.cpp