Distance (GORM for MongoDB - 7.0.0-RC1)

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

grails.mongodb.geo.Distance

```
@groovy.transform.EqualsAndHashCode
class Distance
extends java.lang.Object
```
Represents the distance from one Point to another
Authors:
Graeme Rocher
Since:
2.0

Properties Summary

Properties
Type	Name and description
`Metric`	`metric` The metric used to calculate radians.
`double`	`value` The value representing the distance

Constructor Summary

Constructors
Constructor and description
`Distance(double value, Metric metric)` Constructs a distance for the given value and optional metric

Methods Summary

Methods
Type Params	Return Type	Name and description
	`double`	`inRadians()` Returns: The value of the distance in Radians
	`static Distance`	`valueOf(double value, Metric metric)` Create a Distance instance for the given value

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#equals(java.lang.Object), java.lang.Object#getClass(), java.lang.Object#hashCode(), java.lang.Object#notify(), java.lang.Object#notifyAll(), java.lang.Object#toString(), java.lang.Object#wait(), java.lang.Object#wait(long), java.lang.Object#wait(long, int)`

- Property Detail
  - final Metric metric
    
    The metric used to calculate radians. See Distance.inRadians
  - final double value
    
    The value representing the distance
- Constructor Detail
  - Distance(double value, Metric metric)
    
    Constructs a distance for the given value and optional metric
    Parameters:
    value - The value
    metric - The metric
- Method Detail
  - double inRadians()
    
    Returns:
    The value of the distance in Radians
  - static Distance valueOf(double value, Metric metric)
    
    Create a Distance instance for the given value
    Parameters:
    value - The value
    metric - The metric
    Returns:
    The distance

Summary:
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation