Class EntitiesBehavior

A behavior that allows access to the entity behaviors inside the parallel component.

Inheritance
object
ParameterSet
ParameterSetCollection
Behavior
EntitiesBehavior
Implements
Inherited Members
Namespace: SpiceSharp.Components.ParallelComponents
Assembly: SpiceSharp.dll
Syntax
public class EntitiesBehavior : Behavior, IEntitiesBehavior, IBehavior, IParameterSetCollection, IExportPropertySet<IBehaviorContainerCollection>, IParameterSet

Constructors

EntitiesBehavior(ParallelBindingContext)

Initializes a new instance of the EntitiesBehavior.

Declaration
public EntitiesBehavior(ParallelBindingContext context)
Parameters
Type Name Description
ParallelBindingContext context

The context.

Properties

LocalBehaviors

Gets the local simulation behaviors.

Declaration
[ParameterName("behaviors")]
[ParameterInfo("The behaviors inside the parallel component.")]
public IBehaviorContainerCollection LocalBehaviors { get; }
Property Value
Type Description
IBehaviorContainerCollection

The local behaviors.

Methods

GetState<S>()

Gets a simulation state from a potentially local simulation.

Declaration
public S GetState<S>() where S : ISimulationState
Returns
Type Description
S

The simulation state.
Type Parameters
Name Description
S

The simulation state type.

TryGetState<S>(out S)

Tries to get a simulation state from a potentially local simulation.

Declaration
public bool TryGetState<S>(out S state) where S : ISimulationState
Parameters
Type Name Description
S state

The simulation state.
Returns
Type Description
bool

Returns true if the state was found; otherwise, false.
Type Parameters
Name Description
S

The simulation state type.

Implements

Extension Methods