Interface IEntity

Interface describing an entity that can provide behaviors to a ISimulation.

Inherited Members

IParameterSetCollection.GetParameterSet()

IParameterSetCollection.TryGetParameterSet(out P)

IParameterSetCollection.ParameterSets

IParameterSet.SetParameter(string, P)

IParameterSet.TrySetParameter(string, P)

IParameterSet.GetProperty(string)

IParameterSet.TryGetProperty(string, out P)

IParameterSet.CreateParameterSetter(string)

IParameterSet.CreatePropertyGetter(string)

ICloneable<IEntity>.Clone()

Namespace: SpiceSharp.Entities

Assembly: SpiceSharp.dll

Syntax

public interface IEntity : IParameterSetCollection, IParameterSet, ICloneable<IEntity>

Properties

LinkParameters

Gets a value indicating whether behaviors need to be linked to the original entity. If this is true, then changing parameter values on the entity will be reflected in any behaviors that this entity creates. If false, then parameters are cloned as behaviors request it.

Declaration

bool LinkParameters { get; }

Property Value

Type	Description
bool	`true` if [link parameters]; otherwise, `false`.

Name

Gets the name of the entity.

Declaration

string Name { get; }

Property Value

Type	Description
string	The name.

Methods

CreateBehaviors(ISimulation)

Creates the behaviors and stores them in the specified container.

Declaration

void CreateBehaviors(ISimulation simulation)

Parameters

Type	Name	Description
ISimulation	simulation	The simulation.

Exceptions

Type	Condition
ArgumentNullException	Thrown if `simulation` is `null`.
ArgumentException	Thrown if the simulation does not use an IComplexSimulationState.
TypeNotFoundException	Thrown if a required behavior or parameter set could not be found.
AmbiguousTypeException	Thrown if a behavior or parameter set could not be resolved unambiguously.