trait BaseTypedSystemApi extends SystemBuilderApi with BaseTypedSystemDsl
- Alphabetic
- By Inheritance
- BaseTypedSystemApi
- BaseTypedSystemDsl
- SystemBuilderApi
- ExceptionHandlingExt
- TrellisApi
- SignalsApi
- ContactsDsl
- ComponentsApi
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
implicit
class
ContactExtractor
[T] extends AnyRef
Extractor of contacts' data from result.
Extractor of contacts' data from result.
- Definition Classes
- SignalsApi
-
implicit
class
RichSignalList
extends AnyRef
- Definition Classes
- SignalsApi
-
case class
SubsystemDirectSignal
[T](subsystemName: String, signal: SignalsApi.Signal[T]) extends SubsystemDirectSignal0 with Product with Serializable
An encapsulation of the signal that targets a subsystem's internal contact.
An encapsulation of the signal that targets a subsystem's internal contact.
- Definition Classes
- SignalsApi
-
sealed
trait
SubsystemDirectSignal0
extends AnyRef
- Definition Classes
- SignalsApi
-
case class
SubsystemDirectSignalDist
(subsystemName: String, signal: SignalsApi.SignalDist) extends SubsystemDirectSignal0 with Product with Serializable
- Definition Classes
- SignalsApi
-
implicit
class
StaticSystemWithUnhandledExceptionHandler
extends AnyRef
- Definition Classes
- ExceptionHandlingExt
-
trait
OuterInterfaceBuilder
extends AnyRef
An interface of some object that can collect information about outer interface of a system.
An interface of some object that can collect information about outer interface of a system. Not only it create contact instances, but it usually transforms and collect them.
- Definition Classes
- SystemBuilderApi
-
trait
SystemBuilder
extends OuterInterfaceBuilder with WithStaticSystem
DSL for constructing systems.
DSL for constructing systems.
This builder supports step-by-step creation of contact system. At the end one must convert it to StaticSystem.
The builder supports the notion of extensions (much like akka actor system extensions). When we need to store additional information during system construction, we may request an extention instance from the builder. The builder creates the singleton instance if it is not available yet and returns it.
The builder is used in BaseTypedSystem as a DSL for system's construction.
- Definition Classes
- SystemBuilderApi
-
class
SystemBuilderC
extends SystemBuilder
- Definition Classes
- SystemBuilderApi
-
trait
SystemBuilderExtension
extends AnyRef
An extension that adds some additional state to SystemBuilder.
An extension that adds some additional state to SystemBuilder. It also has an opportunity to adjust the generated StaticSystem via hook #postProcess
- Definition Classes
- SystemBuilderApi
-
final
class
SystemBuilderExtensionId
[T <: SystemBuilderExtension] extends AnyRef
ExtensionId for a system builder.
ExtensionId for a system builder. Every extension can be installed only once on the same SystemBuilder. An instance of the extension is created by the extend method.
- Definition Classes
- SystemBuilderApi
-
implicit
class
RichSimpleSignalProcessor
extends AnyRef
- Definition Classes
- TrellisApi
-
implicit
class
RichTotalTrellisProducer
extends AnyRef
- Definition Classes
- TrellisApi
- abstract class AbstractTypedSystem extends AnyRef
-
abstract
class
BaseTypedSystem
extends WithStaticSystem
A very convenient way to define a StaticSystem is by implementing BaseTypedSystem.
A very convenient way to define a StaticSystem is by implementing BaseTypedSystem.
Why is it so? We define both the outer world interface (inputs and outputs) and implementation (in defineSystem). Both are declared altogether, in the same class.
However there is another way for system's construction, which provides better decomposition. It is described in comment to TypedSystemConstructor
-
type
Component = components.Component
- Definition Classes
- ComponentsApi
-
type
ComponentWithInternalStructure = components.ComponentWithInternalStructure
- Definition Classes
- ComponentsApi
-
type
Contact[T] = components.Contact[T]
- Definition Classes
- ComponentsApi
-
type
Context = Map[Contact[_], _]
The context for system is a map from state handles to values.
The context for system is a map from state handles to values.
- Definition Classes
- TrellisApi
-
type
FlatMapLink[-T1, +T2] = components.FlatMapLink[T1, T2]
- Definition Classes
- ComponentsApi
-
type
Link[T1, T2, -TL1 >: T1, +TL2 <: T2] = components.Link[T1, T2, TL1, TL2]
- Definition Classes
- ComponentsApi
-
type
LinkInfo[-T1, +T2] = components.LinkInfo[T1, T2]
- Definition Classes
- ComponentsApi
-
type
Named = components.Named
- Definition Classes
- ComponentsApi
-
type
NopLink[-T1, +T2 >: T1] = components.NopLink[T1, T2]
- Definition Classes
- ComponentsApi
-
type
RedMapLink[-T1, +T2] = components.RedMapLink[T1, T2]
- Definition Classes
- ComponentsApi
-
type
Signal[T] = components.Signal[T]
- Definition Classes
- ComponentsApi
-
type
SignalCollection[+T] = Iterable[T]
- Definition Classes
- ComponentsApi
-
type
SignalDist = components.SignalDist
- Definition Classes
- ComponentsApi
-
type
SimpleSignalProcessor = (Signal[_]) ⇒ SignalCollection[Signal[_]]
The simplest signal processor.
The simplest signal processor. Corresponds to FlatMap.
- Definition Classes
- TrellisApi
-
type
StateHandle[T] = components.StateHandle[T]
- Definition Classes
- ComponentsApi
-
type
StateZipLink[S, -T1, +T2 >: T1] = components.StateZipLink[S, T1, T2]
- Definition Classes
- ComponentsApi
-
type
StatefulFlatMapLink[S, -T1, +T2] = components.StatefulFlatMapLink[S, T1, T2]
- Definition Classes
- ComponentsApi
-
type
StaticSystem = components.StaticSystem
- Definition Classes
- ComponentsApi
-
type
StaticSystemExtensionId[+T] = components.StaticSystemExtensionId[T]
- Definition Classes
- ComponentsApi
-
type
TotalTrellisProducer = (Context, Signal[_]) ⇒ TrellisElement
A function that takes a single signal on input and returns the last trellis element.
A function that takes a single signal on input and returns the last trellis element. This producer does not store managed state in it.
- Definition Classes
- TrellisApi
-
type
TrellisElement = (Context, SignalCollection[Signal[_]])
A snapshot of a running system at some discrete time moment.
A snapshot of a running system at some discrete time moment.
- Definition Classes
- TrellisApi
-
type
TrellisProducer = (TrellisElement) ⇒ TrellisElement
A function that makes single step (or a few steps) over time.
A function that makes single step (or a few steps) over time.
- Definition Classes
- TrellisApi
-
type
UnhandledProcessingExceptionHandler = (Throwable, String, Signal[_], Context) ⇒ Context
The type of a handler that will handle exceptions during signal processing.
The type of a handler that will handle exceptions during signal processing. If the exception is recoverable, then the handler should provide a new Context for further processing. If not recoverable - throw some exception (or rethrow the original one).
- Definition Classes
- ExceptionHandlingExt
-
type
WithStaticSystem = components.WithStaticSystem
- Definition Classes
- ComponentsApi
-
trait
SystemImplementation
[T] extends AnyRef
Implements a system of type T.
Implements a system of type T. Uses external SystemBuilder instance to define internal System's structure.
- Definition Classes
- BaseTypedSystemDsl
-
case class
TypedSystem
[T](outer: T, staticSystem: BaseTypedSystemDsl.StaticSystem) extends WithStaticSystem with Product with Serializable
- Definition Classes
- BaseTypedSystemDsl
-
trait
TypedSystemConstructor
[T] extends (T) ⇒ StaticSystem
Another way for system's construction is to define inputs and outputs in a separate class/trait and then enumerate them in system builder: sb.inputs(in1, in2, in3) and sb.outputs(out1, out2)
Another way for system's construction is to define inputs and outputs in a separate class/trait and then enumerate them in system builder: sb.inputs(in1, in2, in3) and sb.outputs(out1, out2)
class MySystemsInterface { val in1 = new Contact[String]("in1") val in2 = new Contact[String]("in2") val out1 = new Contact[String]("out1") }
implicit object MySystemImplementation extends TypedSystemConstructor[T] { def apply(outer:T):StaticSystem = {
} }
- Definition Classes
- BaseTypedSystemDsl
Value Members
-
object
SubsystemDirectSignal0
- Definition Classes
- SignalsApi
-
object
SubsystemSpecialAnswerContact
extends Contact[SubsystemDirectSignal0]
This contact is used to process answers of internal system.
This contact is used to process answers of internal system.
- Definition Classes
- SignalsApi
-
object
SubsystemSpecialContact
extends Contact[SubsystemDirectSignal0]
This contact is used to process signals of internal system.
This contact is used to process signals of internal system.
In asynchronous execution the resulting signal should come at the same level of "call stack". However as far as we usually get the signal asynchronously it is processed at top level. So in order to run it in inside the subsystem, we package asynchronous result into Signal(SubsystemSpecialContact, SubsystemDirectSignal( name, actual resulting signal))
- Definition Classes
- SignalsApi
-
implicit
object
UnhandledExceptionHandlerExtensionId
extends StaticSystemExtensionId[UnhandledProcessingExceptionHandler]
- Definition Classes
- ExceptionHandlingExt
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
Contact: components.Contact.type
- Definition Classes
- ComponentsApi
-
val
FlatMapLink: components.FlatMapLink.type
- Definition Classes
- ComponentsApi
-
val
Link: components.Link.type
- Definition Classes
- ComponentsApi
-
val
NopLink: components.NopLink.type
- Definition Classes
- ComponentsApi
-
val
RedMapLink: components.RedMapLink.type
- Definition Classes
- ComponentsApi
-
val
Signal: components.Signal.type
- Definition Classes
- ComponentsApi
-
val
SignalCollection: Iterable.type
- Definition Classes
- ComponentsApi
-
val
SignalDist: components.SignalDist.type
- Definition Classes
- ComponentsApi
-
val
StateHandle: components.StateHandle.type
- Definition Classes
- ComponentsApi
-
val
StateZipLink: components.StateZipLink.type
- Definition Classes
- ComponentsApi
-
val
StatefulFlatMapLink: components.StatefulFlatMapLink.type
- Definition Classes
- ComponentsApi
-
val
StaticSystem: components.StaticSystem.type
- Definition Classes
- ComponentsApi
-
val
WithStaticSystem: components.WithStaticSystem.type
- Definition Classes
- ComponentsApi
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
contact[T](name: String): components.Contact[T]
Create a contact with the given name.
Create a contact with the given name.
- Definition Classes
- ContactsDsl
-
def
createTypedSystem[T](name: String)(implicit outerBuilder: (OuterInterfaceBuilder) ⇒ T, systemImplementation: SystemImplementation[T]): TypedSystem[T]
- Definition Classes
- BaseTypedSystemDsl
-
val
defaultUnhandledExceptionHandler: UnhandledProcessingExceptionHandler
- Definition Classes
- ExceptionHandlingExt
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
extension[T <: SystemBuilderExtension](implicit sb: SystemBuilder, extensionInstance: SystemBuilderExtensionId[T]): T
Usage: extension[LabellingExt].methodInExtension
Usage: extension[LabellingExt].methodInExtension
- Definition Classes
- SystemBuilderApi
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
implicit
def
implicitExtendBasicSystemBuilder[T <: SystemBuilderExtension](sb: SystemBuilder)(implicit extensionInstanceId: SystemBuilderExtensionId[T]): T
Automatic usage of extensions when an implicit extension id is present in the scope.
Automatic usage of extensions when an implicit extension id is present in the scope.
- Definition Classes
- SystemBuilderApi
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
implicit
def
pairToSignal[T](p: (Contact[T], T)): Signal[T]
One may use notation (contact -> data) to represent a signal
One may use notation (contact -> data) to represent a signal
- Definition Classes
- SignalsApi
-
val
rethrowUnhandledExceptionHandler: UnhandledProcessingExceptionHandler
- Definition Classes
- ExceptionHandlingExt
-
def
setSystemName(name: String)(implicit sb: SystemBuilder): Unit
- Definition Classes
- SystemBuilderApi
-
def
state[T](name: String, s0: T)(implicit sb: SystemBuilder): StateHandle[T]
- Definition Classes
- SystemBuilderApi
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
systemBuilderTyped(name: String)(_inputs: Contact[_]*)(_outputs: Contact[_]*): SystemBuilder
A system builder with inputs and outputs given in advance.
A system builder with inputs and outputs given in advance.
- Definition Classes
- BaseTypedSystemDsl
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )