Class Parameters
Base parameters for a SpiceSharp.Components.ParallelComponents.
Implements
Inherited Members
Namespace: SpiceSharp.Components.ParallelComponents
Assembly: SpiceSharp.dll
Syntax
public class Parameters : ParameterSet, ICloneable<Parameters>, IImportParameterSet<IEntityCollection>, IExportPropertySet<IEntityCollection>, IExportPropertySet<Dictionary<Type, IWorkDistributor>>, IImportParameterSet<KeyValuePair<Type, IWorkDistributor>>, IParameterSetProperties
Entities
Gets or sets the entities that should be run in parallel.
Declaration
[ParameterName("entities")]
[ParameterInfo("The entities that can be run in parallel.")]
public IEntityCollection Entities { get; set; }Property Value
| Type | Description |
|---|---|
| IEntityCollection | The entities. |
WorkDistributors
Gets the work distributors.
Declaration
[ParameterName("workdistributors")]
[ParameterInfo("Workload distributors by the behavior type.")]
public Dictionary<Type, IWorkDistributor> WorkDistributors { get; }Property Value
| Type | Description |
|---|---|
| Dictionary<Type, IWorkDistributor> | The work distributors. |
Methods
Clone()
Clones the instance.
Declaration
public Parameters Clone()Returns
| Type | Description |
|---|---|
| Parameters | The cloned instance. |
SetWorkDistributor(KeyValuePair<Type, IWorkDistributor>)
Sets the work distributor for a specified type.
Declaration
[ParameterName("workdistributor")]
[ParameterInfo("Sets a workload distributor.")]
public void SetWorkDistributor(KeyValuePair<Type, IWorkDistributor> pair)Parameters
| Type | Name | Description |
|---|---|---|
| KeyValuePair<Type, IWorkDistributor> | pair | The key-value pair. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | Thrown if |