csw
API
Generated with
csw/csw/csw.alarm/csw.alarm.models/AlarmHealth

AlarmHealth

csw.alarm.models.AlarmHealth
See theAlarmHealth companion class
object AlarmHealth extends Enum[AlarmHealth]

Attributes

Companion
class
Graph
Supertypes
trait Sum
trait Mirror
trait Enum[AlarmHealth]
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Classlikes

case object Bad extends AlarmHealth

Represents health of an alarm/component/subsystem/system if at-least one alarm is either Disconnected, Indeterminate or Critical

Represents health of an alarm/component/subsystem/system if at-least one alarm is either Disconnected, Indeterminate or Critical

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class AlarmHealth
trait Lowercase
trait EnumEntry
class Object
trait Matchable
class Any
Show all
Self type
Bad.type
case object Good extends AlarmHealth

Represents health of an alarm/component/subsystem/system if all alarms are either Okay or Warning

Represents health of an alarm/component/subsystem/system if all alarms are either Okay or Warning

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class AlarmHealth
trait Lowercase
trait EnumEntry
class Object
trait Matchable
class Any
Show all
Self type
Good.type
case object Ill extends AlarmHealth

Represents health of an alarm/component/subsystem/system if at-least one alarm is Major

Represents health of an alarm/component/subsystem/system if at-least one alarm is Major

Attributes

Supertypes
trait Singleton
trait Product
trait Mirror
trait Serializable
trait Product
trait Equals
class AlarmHealth
trait Lowercase
trait EnumEntry
class Object
trait Matchable
class Any
Show all
Self type
Ill.type

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def values: IndexedSeq[AlarmHealth]

Returns a collection of AlarmHealth e.g Good, Ill or Bad

Returns a collection of AlarmHealth e.g Good, Ill or Bad

Attributes

Inherited methods

def extraNamesToValuesMap: Map[String, AlarmHealth]

Additional list of names which can be mapped to values, for example to allow mapping of legacy values.

Additional list of names which can be mapped to values, for example to allow mapping of legacy values.

Attributes

Returns

a Map of names to Values

Inherited from:
Enum
inline def findValues: IndexedSeq[AlarmHealth]

Returns a Seq of A objects that the macro was able to find.

Returns a Seq of A objects that the macro was able to find.

You will want to use this in some way to implement your values method. In fact, if you aren't using this method... why are you even bothering with this lib?

Attributes

Inherited from:
EnumCompat (hidden)
def indexOf(member: AlarmHealth): Int

Returns the index number of the member passed in the values picked up by this enum

Returns the index number of the member passed in the values picked up by this enum

Value parameters

member

the member you want to check the index of

Attributes

Returns

the index of the first element of values that is equal (as determined by ==) to member, or -1, if none exists.

Inherited from:
Enum
def withName(name: String): AlarmHealth

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A

Like Enumeration 's withName, this method will throw if the name does not match any of the values' .entryName values.

Attributes

Inherited from:
Enum
def withNameEither(name: String): Either[NoSuchMember[AlarmHealth], AlarmHealth]

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values.

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values.

Attributes

Inherited from:
Enum
def withNameInsensitive(name: String): AlarmHealth

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A, disregarding case

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A, disregarding case

Like Enumeration 's withName, this method will throw if the name does not match any of the values' .entryName values.

Attributes

Inherited from:
Enum
def withNameInsensitiveEither(name: String): Either[NoSuchMember[AlarmHealth], AlarmHealth]

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values, disregarding case.

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values, disregarding case.

Attributes

Inherited from:
Enum
def withNameInsensitiveOption(name: String): Option[AlarmHealth]

Optionally returns an A for a given name, disregarding case

Optionally returns an A for a given name, disregarding case

Attributes

Inherited from:
Enum
def withNameLowercaseOnly(name: String): AlarmHealth

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A transformed to lower case

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A transformed to lower case

Like Enumeration 's withName, this method will throw if the name does not match any of the values' .entryName values.

Attributes

Inherited from:
Enum
def withNameLowercaseOnlyEither(name: String): Either[NoSuchMember[AlarmHealth], AlarmHealth]

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values, disregarding case.

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values, disregarding case.

Attributes

Inherited from:
Enum
def withNameLowercaseOnlyOption(name: String): Option[AlarmHealth]

Optionally returns an A for a given name assuming the value is lower case

Optionally returns an A for a given name assuming the value is lower case

Attributes

Inherited from:
Enum
def withNameOption(name: String): Option[AlarmHealth]

Optionally returns an A for a given name.

Optionally returns an A for a given name.

Attributes

Inherited from:
Enum
def withNameUppercaseOnly(name: String): AlarmHealth

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A transformed to upper case

Tries to get an A by the supplied name. The name corresponds to the .name of the case objects implementing A transformed to upper case

Like Enumeration 's withName, this method will throw if the name does not match any of the values' .entryName values.

Attributes

Inherited from:
Enum
def withNameUppercaseOnlyEither(name: String): Either[NoSuchMember[AlarmHealth], AlarmHealth]

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values, disregarding case.

Returns an [[Right[A]] ] for a given name, or a [[Left[NoSuchMember]] ] if the name does not match any of the values' .entryName values, disregarding case.

Attributes

Inherited from:
Enum
def withNameUppercaseOnlyOption(name: String): Option[AlarmHealth]

Optionally returns an A for a given name assuming the value is upper case

Optionally returns an A for a given name assuming the value is upper case

Attributes

Inherited from:
Enum

Inherited fields

final lazy val lowerCaseNamesToValuesMap: Map[String, AlarmHealth]

Map of A object names in lower case to A s for case-insensitive comparison

Map of A object names in lower case to A s for case-insensitive comparison

Attributes

Inherited from:
Enum
lazy val namesToValuesMap: Map[String, AlarmHealth]

Map of A object names to A s

Map of A object names to A s

Attributes

Inherited from:
Enum
final lazy val upperCaseNameValuesToMap: Map[String, AlarmHealth]

Map of A object names in upper case to A s for case-insensitive comparison

Map of A object names in upper case to A s for case-insensitive comparison

Attributes

Inherited from:
Enum
final lazy val valuesToIndex: Map[AlarmHealth, Int]

Map of A to their index in the values sequence.

Map of A to their index in the values sequence.

A performance optimisation so that indexOf can be found in constant time.

Attributes

Inherited from:
Enum
Generated with