CoordinateSetter.SetStatus (Artisynth API documentation)

java.lang.Object
- artisynth.core.mechmodels.CoordinateSetter.SetStatus

Enclosing class:

CoordinateSetter
```
public static class CoordinateSetter.SetStatus
extends java.lang.Object
```
Return status for set requests undertaken by the coordinate setter.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`converged()` Returns `true` if the loop solver converged, or if none of the requested coordinates are embedded in a kinematic loop and all coordinates could therefore be set freely.
`java.util.List<JointCoordinateHandle>`	`getCoordinates()` Returns the coordinates that were requested to be set, as a list of `JointCoordinateHandle`s.
`boolean`	`isDependent(JointCoordinateHandle handle)` Queries whether a specific requested coordinate was determined to be dependent.
`boolean`	`isFree(JointCoordinateHandle handle)` Queries whether a specific requested coordinate was determined to be free.
`boolean`	`isLimited(JointCoordinateHandle handle)` Queries whether setting a specific requested coordinate was restricted because of coordinate limits.
`int`	`numCoordinates()` Returns the number of coordinates that were requested to be set.
`int`	`numDependent()` Returns the number of requested coordinates that were determined to be dependent.
`int`	`numFree()` Returns the number of requested coordinates that were determined to be free.
`int`	`numIterations()` Total number of interations required by the loop solver.
`int`	`numLimited()` Returns the number of requested coordinates whose setting was restricted because of coordinate limits.
`java.lang.String`	`toString()` Returns a short string the partially describes this status.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - numIterations
```
public int numIterations()
```
    Total number of interations required by the loop solver. If none of the set coordinates are embedded in a kinematic loop, the loop solver will not be needed and this metmyJointhod will return 0.
    
    Returns:
    
    loop solver iteration count
  - converged
```
public boolean converged()
```
    Returns true if the loop solver converged, or if none of the requested coordinates are embedded in a kinematic loop and all coordinates could therefore be set freely.
    
    Returns:
    
    true if the loop solver converged or was not needed
  - numCoordinates
```
public int numCoordinates()
```
    Returns the number of coordinates that were requested to be set.
    
    Returns:
    
    number of coordinate requested to be set
  - getCoordinates
```
public java.util.List<JointCoordinateHandle> getCoordinates()
```
    Returns the coordinates that were requested to be set, as a list of JointCoordinateHandles.
    
    Returns:
    
    list of coordinates requested to be set
  - numDependent
```
public int numDependent()
```
    Returns the number of requested coordinates that were determined to be dependent. Dependent coordinates will only occur if some of the requested coordinates are embedded in a kinematic loop.
    
    Returns:
    
    number of dependent coordinates
  - isDependent
```
public boolean isDependent(JointCoordinateHandle handle)
```
    Queries whether a specific requested coordinate was determined to be dependent. A coordinate may be dependent only if it is embedded in a kinematic loop. The method returns false if the coordinate is not one of the requested coordinates.
    Dependent coordinates will not generally be located near their requested values, since this kinematic system does not have sufficient degrees of freedom to provide this.
    
    Parameters:
    
    handle - handle to the coordinate
    
    Returns:
    
    true if the coordinate was one of the requested coordinates and was determined to be dependent
  - numLimited
```
public int numLimited()
```
    Returns the number of requested coordinates whose setting was restricted because of coordinate limits. This is the total number of coordinates for which isLimited(JointCoordinateHandle) returns true.
    
    Returns:
    
    number of requested coordinates restricted by coordinate limits
  - isLimited
```
public boolean isLimited(JointCoordinateHandle handle)
```
    Queries whether setting a specific requested coordinate was restricted because of coordinate limits. This may only occur for independent coordinates which are embedded within a kinematic loop and for which attempting to set the requested value caused one or more dependent coordinates to hit a limit. The method returns false if the coordinate is not one of the requested coordinates.
    Even if converged() returns true, coordinates that are limit restricted will not generally be located near their requested values.
    
    Parameters:
    
    handle - handle to the coordinate
    
    Returns:
    
    true if the coordinate was one of the requested coordinates, and setting it was restricted because of dependent coordinate limits
  - numFree
```
public int numFree()
```
    Returns the number of requested coordinates that were determined to be free. This is the total number of coordinates for which isFree(JointCoordinateHandle) returns true.
    
    Returns:
    
    number of free coordinates
  - isFree
```
public boolean isFree(JointCoordinateHandle handle)
```
    Queries whether a specific requested coordinate was determined to be free. A coordinate is free if it is independent and setting it to its requested value did not cause a dependent coordinate to hit a joint limit, i.e., if isDependent(JointCoordinateHandle) and isLimited(JointCoordinateHandle) both return false.
    If converged() returns true, then free coordinates should be located at (or very near to) their requested values.
    
    Parameters:
    
    handle - handle to the coordinate
    
    Returns:
    
    true if the coordinate was one of the requested coordinates and was determined to be free
  - toString
```
public java.lang.String toString()
```
    Returns a short string the partially describes this status.
    
    Overrides:
    
    toString in class java.lang.Object

Class CoordinateSetter.SetStatus

Method Summary

Methods inherited from class java.lang.Object

Method Detail

numIterations

converged

numCoordinates

getCoordinates

numDependent

isDependent

numLimited

isLimited

numFree

isFree

toString