Embabel Agent Documentation/com.embabel.agent.core/Blackboard

Blackboard

interface Blackboard : Bindable, MayHaveLastResult

A Blackboard is how an AgentProcess maintains context. Blackboard operations are threadsafe.

Inheritors

OperationContext

TransformationActionContext

SupplierActionContext

AbstractAgentProcess

InMemoryBlackboard

FakeOperationContext

Properties

abstract val blackboardId: String

Unique identifier of this blackboard. Blackboard doesn't extend StableIdentified to avoid conflict with implementations that are otherwise identified

abstract val objects: List<Any>

Entries in the order they were added. The default instance of any type is the last one Objects are immutable and may not be removed.

Functions

open fun addAll(objects: List<Any>)

abstract fun addObject(value: Any): Bindable

Add to entries without binding to a variable name. Implementations must respect the order in which entities were added. This is equivalent to using the default binding name as the key. For example, if you add a Dog to the blackboard without a key, it will be bound to the default binding name "it" and will be the last entry in the list of objects. Equivalent:

abstract fun bind(key: String, value: Any): Bindable

open fun bindAll(bindings: Map<String, Any>)

open fun <T> count(clazz: Class<T>): Int

inline fun <T> Blackboard.count(): Int

Count entries of the given type

expressionEvaluationModel

abstract fun expressionEvaluationModel(): Map<String, Any>

Expose the model data for use in prompts Prefer more strongly typed usage patterns

abstract operator fun get(name: String): Any?

Return the value of a variable, if it is set by name. Does not limit return via type information.

abstract fun getCondition(key: String): Boolean?

abstract fun <V : Any> getOrPut(name: String, creator: () -> V): V

Threadsafe get or put

open fun getValue(variable: String = IoBinding.DEFAULT_BINDING, type: String, dataDictionary: DataDictionary): Any?

Resolve the value of a variable, if it is set. Resolve superclasses For example, getValue("it", "Animal") will match a Dog if Dog extends Animal

open fun hasValue(variable: String = IoBinding.DEFAULT_BINDING, type: String, dataDictionary: DataDictionary): Boolean

Indicates whether this blackboard contains a variable.

open fun <T> last(clazz: Class<T>): T?

Last entry of the given type, if there is one

inline fun <T> Blackboard.last(): T?

Last entry of the given type, if there is one

open override fun lastResult(): Any?

Last result, of any type, if there is one.

open fun <T> objectsOfType(clazz: Class<T>): List<T>

Return all objects of the given type

inline fun <T> Blackboard.objectsOfType(): List<T>

Return all entries of a specific type

abstract operator fun plusAssign(pair: <Error class: unknown class><String, Any>)

abstract operator fun plusAssign(value: Any)

open operator fun plusAssign(bindings: Map<String, Any>)

abstract operator fun set(key: String, value: Any)

Bind a value to a name

abstract fun setCondition(key: String, value: Boolean): Blackboard

Explicitly set the condition value Used in planning.

abstract fun spawn(): Blackboard

Spawn an independent child blackboard based on the content of this