kreuzberg
API
Generated with
kreuzberg/kreuzberg/Model

Model

kreuzberg.Model
See theModel companion object
final class Model[T] extends Subscribeable[T], Identified

A Model is something which holds a value and can be subscribed to. In contrast to channels, models carry a current value and are subscribed by components. They are allowed to be singletons. They are identified using their ID. There is only one model of the same id allowed within an Engine.

Attributes

Companion
object
Graph
Supertypes
trait Identified
trait Subscribeable[T]
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def dependencies: Seq[Identifier]

Attributes

Definition Classes
override def equals(obj: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters

that

the object to compare against this object for equality.

Attributes

Returns

true if the receiver object is equivalent to the argument; false otherwise.

Definition Classes
Any
override def hashCode(): Int

Calculates a hash code value for the object.

Calculates a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Attributes

Returns

the hash code value for this object.

Definition Classes
Any
override def initial: T

Attributes

Definition Classes
def set(value: T): Unit

Set a value from an Handler.

Set a value from an Handler.

Attributes

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def update(f: T => T): Unit

Update a model from handler.

Update a model from handler.

Attributes

Inherited methods

def comment: String

Comment, which will probably built into into a tree. Can be disabled by returning ""

Comment, which will probably built into into a tree. Can be disabled by returning ""

Attributes

Inherited from:
Identified
def map[U](fn: T => U): Subscribeable[U]

Map a subscribable value to something else.

Map a subscribable value to something else.

Attributes

Inherited from:
Subscribeable
def read(): T

Read the current value.

Read the current value.

Attributes

Inherited from:
Subscribeable
def subscribe()(using sc: SimpleContext): T

Subscribe to this Value, to be used in SimpleComponentBase

Subscribe to this Value, to be used in SimpleComponentBase

Attributes

Inherited from:
Subscribeable

Concrete fields

val id: Identifier

Id of this thing.

Id of this thing.

Attributes

Generated with