Randomness v2.7.5/com.fwdekker.randomness.decimal/DecimalScheme

DecimalScheme

data class DecimalScheme( var myName: String = DEFAULT_NAME, var minValue: Double = DEFAULT_MIN_VALUE, var maxValue: Double = DEFAULT_MAX_VALUE, var decimalCount: Int = DEFAULT_DECIMAL_COUNT, var showTrailingZeroes: Boolean = DEFAULT_SHOW_TRAILING_ZEROES, var groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, var decimalSeparator: String = DEFAULT_DECIMAL_SEPARATOR, var prefix: String = DEFAULT_PREFIX, var suffix: String = DEFAULT_SUFFIX) : Scheme<DecimalScheme>

Contains settings for generating random decimals.

See also

com.fwdekker.randomness.decimal.DecimalInsertAction

com.fwdekker.randomness.decimal.DecimalSettings

Constructors

fun DecimalScheme( myName: String = DEFAULT_NAME, minValue: Double = DEFAULT_MIN_VALUE, maxValue: Double = DEFAULT_MAX_VALUE, decimalCount: Int = DEFAULT_DECIMAL_COUNT, showTrailingZeroes: Boolean = DEFAULT_SHOW_TRAILING_ZEROES, groupingSeparator: String = DEFAULT_GROUPING_SEPARATOR, decimalSeparator: String = DEFAULT_DECIMAL_SEPARATOR, prefix: String = DEFAULT_PREFIX, suffix: String = DEFAULT_SUFFIX)

Types

object Companion

Holds constants.

Functions

open override fun copyAs(name: String): DecimalScheme

Returns a copy of this scheme that has the given name.

open override fun copyFrom(other: DecimalScheme)

Shallowly copies the state of other into this.

@NotNull

@Nls

open fun getDisplayName(): @NotNull @Nls String

open override fun getName(): String

Same as myName.

safeSetDecimalSeparator

fun safeSetDecimalSeparator(decimalSeparator: String?)

Sets the decimal separator safely to ensure that exactly one character is set.

safeSetGroupingSeparator

fun safeSetGroupingSeparator(groupingSeparator: String?)

Sets the grouping separator safely to ensure that exactly one character is set.

Properties

var decimalCount: Int

The number of decimals to display.

decimalSeparator

var decimalSeparator: String

The character that should separate decimals.

groupingSeparator

var groupingSeparator: String

The character that should separate groups.

var maxValue: Double

The maximum value to be generated, inclusive.

var minValue: Double

The minimum value to be generated, inclusive.

open override var myName: String

The name of the scheme.

var prefix: String

The string to prepend to the generated value.

showTrailingZeroes

var showTrailingZeroes: Boolean

Whether to include trailing zeroes in the decimals.

var suffix: String

The string to append to the generated value.

Sources