data-models/org.cryptotrader.data.library.model.currency/PerformanceRating

PerformanceRating

enum PerformanceRating : Enum<PerformanceRating>

Simple tri-state indicator of price movement for a currency/instrument.

Values:

UP: new value is greater than old value
DOWN: new value is less than old value
NEUTRAL: values are equal (or delta considered negligible by caller)

Utility methods help derive the rating from two values or from a delta.

Entries

Types

object Companion

Properties

val entries: EnumEntries<PerformanceRating>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val name: String

val ordinal: Int

val rating: String

Functions

fun valueOf(value: String): PerformanceRating

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<PerformanceRating>

Returns an array containing the constants of this enum type, in the order they're declared.