Interface IBindingContext
A template for a context that can be used to bind entity behaviors to a simulation.
Namespace: SpiceSharp.Entities
Assembly: SpiceSharp.dll
Syntax
public interface IBindingContextProperties
Behaviors
Gets the previously created behaviors.
Declaration
IBehaviorContainer Behaviors { get; }Property Value
| Type | Description |
|---|---|
| IBehaviorContainer | The previously created behaviors. |
Methods
GetParameterSet<P>()
Gets the parameter set of the specified type.
Declaration
P GetParameterSet<P>() where P : IParameterSet, ICloneable<P>Returns
| Type | Description |
|---|---|
| P | The parameter set. |
Type Parameters
| Name | Description |
|---|---|
| P | The parameter set type. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the parameter set could not be found. |
GetSimulationParameterSet<P>()
Gets a simulation parameter set.
Declaration
P GetSimulationParameterSet<P>() where P : IParameterSet, ICloneable<P>Returns
| Type | Description |
|---|---|
| P | The parameter set. |
Type Parameters
| Name | Description |
|---|---|
| P | The type of parameter set. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the parameter set was not found. |
GetState<S>()
Gets a simulation state.
Declaration
S GetState<S>() where S : ISimulationStateReturns
| Type | Description |
|---|---|
| S | The simulation state. |
Type Parameters
| Name | Description |
|---|---|
| S | The type of simulation state. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentException | Thrown if the state is not defined on the simulation. |
TryGetParameterSet<P>(out P)
Tries to get the parameter set of the specified type.
Declaration
bool TryGetParameterSet<P>(out P value) where P : IParameterSet, ICloneable<P>Parameters
| Type | Name | Description |
|---|---|---|
| P | value | The parameter set. |
Returns
| Type | Description |
|---|---|
| bool |
|
Type Parameters
| Name | Description |
|---|---|
| P | The parameter set type. |
TryGetSimulationParameterSet<P>(out P)
Tries to get a simulation parameter set.
Declaration
bool TryGetSimulationParameterSet<P>(out P parameters) where P : IParameterSet, ICloneable<P>Parameters
| Type | Name | Description |
|---|---|---|
| P | parameters | The parameter set. |
Returns
| Type | Description |
|---|---|
| bool |
|
Type Parameters
| Name | Description |
|---|---|
| P | The parameter set type. |
TryGetState<S>(out S)
Tries to get a simulation state.
Declaration
bool TryGetState<S>(out S state) where S : ISimulationStateParameters
| Type | Name | Description |
|---|---|---|
| S | state | The simulation state. |
Returns
| Type | Description |
|---|---|
| bool |
|
Type Parameters
| Name | Description |
|---|---|
| S | The type of simulation state. |