# Mass

Artifact: [androidx.health.connect:connect-client](https://developer.android.com/jetpack/androidx/releases/health-connect) [View Source](https://cs.android.com/search?q=file:androidx/health/connect/client/units/Mass.kt+class:androidx.health.connect.client.units.Mass) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

*** ** * ** ***


```
class Mass : Comparable<Mass>
```

<br />

*** ** * ** ***

Represents a unit of mass. Supported units:

- grams - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#grams(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).grams()`

- kilograms - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#kilograms(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).kilograms()`

- milligrams - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#milligrams(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).milligrams()`

- micrograms - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#micrograms(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).micrograms()`

- ounces - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#ounces(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).ounces()`

- pounds - see `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#pounds(kotlin.Double)`, `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/package-summary#(kotlin.Double).pounds()`

## Summary

| ### Public companion functions |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#grams(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in grams. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#kilograms(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in kilograms. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#micrograms(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in micrograms. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#milligrams(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in milligrams. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#ounces(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in ounces. |
| `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#pounds(kotlin.Double)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html)` Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in pounds. |

| ### Public functions |
|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#compareTo(androidx.health.connect.client.units.Mass)(other: https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass)` |
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#hashCode()()` |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#toString()()` |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#inGrams()` Returns the mass in grams. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#inKilograms()` Returns the mass in kilograms. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#inMicrograms()` Returns the mass in micrograms. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#inMilligrams()` Returns the mass in milligrams. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#inOunces()` Returns the mass in ounces. |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-double/index.html` | `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass#inPounds()` Returns the mass in pounds. |

## Public companion functions

### grams

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun grams(value: Double): Mass
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in grams.

### kilograms

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun kilograms(value: Double): Mass
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in kilograms.

### micrograms

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun micrograms(value: Double): Mass
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in micrograms.

### milligrams

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun milligrams(value: Double): Mass
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in milligrams.

### ounces

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun ounces(value: Double): Mass
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in ounces.

### pounds

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
fun pounds(value: Double): Mass
```

Creates `https://developer.android.com/reference/kotlin/androidx/health/connect/client/units/Mass` with the specified value in pounds.

## Public functions

### compareTo

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
open operator fun compareTo(other: Mass): Int
```

### equals

```
open operator fun equals(other: Any?): Boolean
```

### hashCode

```
open fun hashCode(): Int
```

### toString

```
open fun toString(): String
```

## Public properties

### inGrams

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inGrams: Double
```

Returns the mass in grams.

### inKilograms

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inKilograms: Double
```

Returns the mass in kilograms.

### inMicrograms

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inMicrograms: Double
```

Returns the mass in micrograms.

### inMilligrams

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inMilligrams: Double
```

Returns the mass in milligrams.

### inOunces

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inOunces: Double
```

Returns the mass in ounces.

### inPounds

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/health-connect#1.1.0)

```
val inPounds: Double
```

Returns the mass in pounds.