Simbody  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Types | Public Member Functions | List of all members
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

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

SimTK::ProjectResults::ProjectResults ( )
inline

Member Function Documentation

ProjectResults& SimTK::ProjectResults::clear ( )
inline

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

bool SimTK::ProjectResults::isValid ( ) const
inline
Status SimTK::ProjectResults::getExitStatus ( ) const
inline
bool SimTK::ProjectResults::getAnyChangeMade ( ) const
inline
int SimTK::ProjectResults::getNumIterations ( ) const
inline
Real SimTK::ProjectResults::getNormOnEntrance ( ) const
inline
Real SimTK::ProjectResults::getNormOnExit ( ) const
inline
int SimTK::ProjectResults::getWorstErrorOnEntrance ( ) const
inline
bool SimTK::ProjectResults::getProjectionLimitExceeded ( ) const
inline
ProjectResults& SimTK::ProjectResults::setExitStatus ( Status  status)
inline
ProjectResults& SimTK::ProjectResults::setAnyChangeMade ( bool  changeMade)
inline
ProjectResults& SimTK::ProjectResults::setProjectionLimitExceeded ( bool  limitExceeded)
inline
ProjectResults& SimTK::ProjectResults::setNumIterations ( int  numIterations)
inline
ProjectResults& SimTK::ProjectResults::setNormOnEntrance ( Real  norm,
int  worstError 
)
inline
ProjectResults& SimTK::ProjectResults::setNormOnExit ( Real  norm)
inline
The documentation for this class was generated from the following file: