Ocean::Tracking::PoseProjectionSet::ErrorObject Class Reference

This class implements a error object. More...

#include <PoseProjection.h>

Public Member Functions
	ErrorObject (const unsigned int index, const Scalar error)
	Creates a new error object.
unsigned int	index () const
	Returns the index of this object.
Scalar	error () const
	Returns the error of this object.
bool	operator< (const ErrorObject &object) const
	Returns whether the left object has a lesser error value than the right one.

Private Attributes
unsigned int	objectIndex
	Object index.
Scalar	objectError
	Object error.

Detailed Description

This class implements a error object.

Constructor & Destructor Documentation

ErrorObject()

Ocean::Tracking::PoseProjectionSet::ErrorObject::ErrorObject ( const unsigned int  index, const Scalar  error  )

inline

Creates a new error object.

Parameters

index	Index of the element
error	Error of the element

Member Function Documentation

error()

Scalar Ocean::Tracking::PoseProjectionSet::ErrorObject::error ( ) const

inline

Returns the error of this object.

Returns

Object error

index()

unsigned int Ocean::Tracking::PoseProjectionSet::ErrorObject::index ( ) const

inline

Returns the index of this object.

Returns

Object index

operator<()

bool Ocean::Tracking::PoseProjectionSet::ErrorObject::operator< ( const ErrorObject &  object ) const

inline

Returns whether the left object has a lesser error value than the right one.

Parameters

object

Right error object to compare

Returns

True, if so

Field Documentation

objectError

Scalar Ocean::Tracking::PoseProjectionSet::ErrorObject::objectError

private

Object error.

objectIndex

unsigned int Ocean::Tracking::PoseProjectionSet::ErrorObject::objectIndex

private

Object index.

---

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

• PoseProjection.h