Show / Hide Table of Contents

Interface IEntitiesBehavior

A description of a behavior that allows access to any local behaviors.

Inherited Members
IBehavior.Name
IParameterSetCollection.GetParameterSet<P>()
IParameterSetCollection.TryGetParameterSet<P>(out P)
IParameterSetCollection.ParameterSets
IParameterSet.SetParameter<P>(string, P)
IParameterSet.TrySetParameter<P>(string, P)
IParameterSet.GetProperty<P>(string)
IParameterSet.TryGetProperty<P>(string, out P)
IParameterSet.CreateParameterSetter<P>(string)
IParameterSet.CreatePropertyGetter<P>(string)
Namespace: SpiceSharp.Components.Common
Assembly: SpiceSharp.dll
Syntax
public interface IEntitiesBehavior : IBehavior, IParameterSetCollection, IParameterSet

Properties

LocalBehaviors

Gets the local simulation behaviors.

Declaration
IBehaviorContainerCollection LocalBehaviors { get; }
Property Value
Type Description
IBehaviorContainerCollection

The local behaviors.

Methods

GetState<S>()

Gets a simulation state from a potentially local simulation.

Declaration
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
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.

Extension Methods

Utility.ThrowIfNull<T>(T, string)
Documentation.ParameterValues<T>(IParameterSet, bool)
Documentation.Parameters(IParameterSet)
Documentation.ParameterValues<T>(IParameterSetCollection, bool)
Documentation.Parameters(IParameterSetCollection)

See Also

IBehavior
In this article
Back to top Generated by DocFX