SimTK::ProjectResults Class Reference

Results for advanced users of project() methods. More...

Public Types
enum	Status {   Invalid = -1,   Succeeded = 0,   FailedToAchieveAccuracy = 1,   FailedToConverge = 2 }

Public Member Functions
	ProjectResults ()
ProjectResults &	clear ()
	Restore this object to its default-constructed state, with the return status set to Invalid. More...
bool	isValid () const
Status	getExitStatus () const
bool	getAnyChangeMade () const
int	getNumIterations () const
Real	getNormOnEntrance () const
Real	getNormOnExit () const
int	getWorstErrorOnEntrance () const
bool	getProjectionLimitExceeded () const
ProjectResults &	setExitStatus (Status status)
ProjectResults &	setAnyChangeMade (bool changeMade)
ProjectResults &	setProjectionLimitExceeded (bool limitExceeded)
ProjectResults &	setNumIterations (int numIterations)
ProjectResults &	setNormOnEntrance (Real norm, int worstError)
ProjectResults &	setNormOnExit (Real norm)

Detailed Description

Results for advanced users of project() methods.

Member Enumeration Documentation

Status

enum SimTK::ProjectResults::Status

Enumerator
Invalid	This object has not been filled in yet and holds no results.
Succeeded	The project() was successful either because no projection was necessary or projection was able to achieve the required accuracy.
FailedToAchieveAccuracy	Projection converged but was unable to achieve the required accuracy.
FailedToConverge	The Newton iterations were diverging. This is especially common when the LocalOnly option is set since project() will quit at the first sign of divergence in that case. This is also the return if a projection limit has been set and the initial norm is larger.

Constructor & Destructor Documentation

ProjectResults()

SimTK::ProjectResults::ProjectResults ( )

inline

Member Function Documentation

clear()

ProjectResults& SimTK::ProjectResults::clear ( )

inline

Restore this object to its default-constructed state, with the return status set to Invalid.

isValid()

bool SimTK::ProjectResults::isValid ( ) const

inline

getExitStatus()

Status SimTK::ProjectResults::getExitStatus ( ) const

inline

getAnyChangeMade()

bool SimTK::ProjectResults::getAnyChangeMade ( ) const

inline

getNumIterations()

int SimTK::ProjectResults::getNumIterations ( ) const

inline

getNormOnEntrance()

Real SimTK::ProjectResults::getNormOnEntrance ( ) const

inline

getNormOnExit()

Real SimTK::ProjectResults::getNormOnExit ( ) const

inline

getWorstErrorOnEntrance()

int SimTK::ProjectResults::getWorstErrorOnEntrance ( ) const

inline

getProjectionLimitExceeded()

bool SimTK::ProjectResults::getProjectionLimitExceeded ( ) const

inline

setExitStatus()

ProjectResults& SimTK::ProjectResults::setExitStatus ( Status  status )

inline

setAnyChangeMade()

ProjectResults& SimTK::ProjectResults::setAnyChangeMade ( bool  changeMade )

inline

setProjectionLimitExceeded()

ProjectResults& SimTK::ProjectResults::setProjectionLimitExceeded ( bool  limitExceeded )

inline

setNumIterations()

ProjectResults& SimTK::ProjectResults::setNumIterations ( int  numIterations )

inline

setNormOnEntrance()

ProjectResults& SimTK::ProjectResults::setNormOnEntrance ( Real  norm, int  worstError  )

inline

setNormOnExit()

ProjectResults& SimTK::ProjectResults::setNormOnExit ( Real  norm )

inline

---

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

• System.h