RIDDL
3.3.1
API
Generated with
RIDDL/com.reactific.riddl.language/AST/State

State

com.reactific.riddl.language.AST.State
case class State(loc: At, id: Identifier, typ: TypeRef, handlers: Seq[Handler], invariants: Seq[Invariant], brief: Option[LiteralString], description: Option[Description]) extends EntityDefinition

Represents the state of an entity. The MorphAction can cause the state definition of an entity to change.

Value parameters

brief

A brief description (one sentence) for use in documentation

description

An optional description of the state.

handlers

The handler definitions that may occur when this state is active

id

The name of the state definition

invariants

Expressions of boolean logic that must always evaluate to true before and after an entity changes when this state is active.

loc

The location of the state definition

typ

A reference to a type definition that provides the range of values that the state may assume.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait RiddlValue
trait RiddlNode
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def contents: Seq[StateDefinition]

Attributes

Definition Classes
def format: String

Format the node to a string

Format the node to a string

Attributes

Inherited methods

def asVital[OPT <: OptionValue, DEF <: Definition]: VitalDefinition[OPT, DEF]

Attributes

Inherited from:
Definition
def briefValue: String

Attributes

Inherited from:
BrieflyDescribedValue
def descriptionValue: String

Attributes

Inherited from:
DescribedValue
def hasAuthors: Boolean

Attributes

Inherited from:
Definition
def hasBriefDescription: Boolean

Attributes

Inherited from:
BrieflyDescribedValue
override def hasDefinitions: Boolean

Attributes

Definition Classes
Inherited from:
Definition
def hasDescription: Boolean

Attributes

Inherited from:
DescribedValue
def hasOptions: Boolean

Attributes

Inherited from:
Definition
def hasTypes: Boolean

Attributes

Inherited from:
Definition
def identify: String

Attributes

Inherited from:
Definition
def identifyWithLoc: String

Attributes

Inherited from:
Definition
def isAppRelated: Boolean

Attributes

Inherited from:
Definition
override def isContainer: Boolean

Determine if this node is a container or not

Determine if this node is a container or not

Attributes

Definition Classes
Inherited from:
Container
override def isDefinition: Boolean

Attributes

Definition Classes
Inherited from:
Definition
override def isEmpty: Boolean

determine if this node is empty or not.

determine if this node is empty or not. Non-containers are always empty

Attributes

Definition Classes
Inherited from:
Container
def isImplicit: Boolean

Attributes

Inherited from:
Definition
def isRootContainer: Boolean

Attributes

Inherited from:
Container
def isVital: Boolean

Attributes

Inherited from:
Definition
final def nonEmpty: Boolean

Attributes

Inherited from:
RiddlNode
def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
def resolveNameTo(name: String): Option[Definition]

Attributes

Inherited from:
Definition

Concrete fields

final val kind: String
Generated with