Class ProportionalInteraction

Inheritance

System.Object

WorldLayerInteraction<System.Single>

ProportionalInteraction

PlantPopulationConsumedCapacityInteraction

Implements

IWorldLayerInteraction

IWorldLayerRelationship

Inherited Members

WorldLayerInteraction<Single>.Verify(List<LocString>)

WorldLayerInteraction<Single>.DescribeParameterized(WorldArea)

WorldLayerInteraction<Single>.GetDependencyIndexByLayerName(String)

WorldLayerInteraction<Single>.ValueOf(String, Single[])

WorldLayerInteraction<Single>.PostWorldgenValueOf(String, Single[])

WorldLayerInteraction<Single>.ToString()

WorldLayerInteraction<Single>.RequiresNeighborhood

WorldLayerInteraction<Single>.Dependencies

WorldLayerInteraction<Single>.PostWorldgenDependencies

WorldLayerInteraction<Single>.OutputLayer

Namespace: Eco.Simulation.WorldLayers.LayerInteractions

Assembly: Eco.Simulation.dll

Syntax

public class ProportionalInteraction : WorldLayerInteraction<float>, IWorldLayerInteraction, IWorldLayerRelationship

Constructors

ProportionalInteraction()

Declaration

public ProportionalInteraction()

Properties

ActiveOnWorldGen

Declaration

public bool ActiveOnWorldGen { get; set; }

Property Value

Type	Description
System.Boolean

DependencyLayerNames

Declaration

public override string[] DependencyLayerNames { get; }

Property Value

Type	Description
System.String[]

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.DependencyLayerNames

DescribeGeneral

Declaration

public override string DescribeGeneral { get; }

Property Value

Type	Description
System.String

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.DescribeGeneral

InputLayerName

Declaration

public string InputLayerName { get; set; }

Property Value

Type	Description
System.String

OutputLayerName

Declaration

public override string OutputLayerName { get; }

Property Value

Type	Description
System.String

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.OutputLayerName

ProportionAtInitialization

Declaration

public float ProportionAtInitialization { get; set; }

Property Value

Type	Description
System.Single

ProportionEachTick

Declaration

public float ProportionEachTick { get; set; }

Property Value

Type	Description
System.Single

TargetLayerName

Declaration

public string TargetLayerName { get; set; }

Property Value

Type	Description
System.String

WorldInitDependencyLayerNames

Declaration

public override string[] WorldInitDependencyLayerNames { get; }

Property Value

Type	Description
System.String[]

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.WorldInitDependencyLayerNames

Methods

Apply(Single, Single[], WorldLayerNeighborInfo[])

Declaration

public override float Apply(float currentValue, float[] dependencyValues, WorldLayerNeighborInfo[] neighborValues)

Parameters

Type	Name	Description
System.Single	currentValue
System.Single[]	dependencyValues
WorldLayerNeighborInfo[]	neighborValues

Returns

Type	Description
System.Single

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.Apply(System.Single, System.Single[], Eco.Simulation.WorldLayers.WorldLayerNeighborInfo[])

DescribeAggregated(IEnumerable<Single>)

Declaration

protected override string DescribeAggregated(IEnumerable<float> intermediateDescriptions)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Single>	intermediateDescriptions

Returns

Type	Description
System.String

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.DescribeAggregated(System.Collections.Generic.IEnumerable<System.Single>)

DescribeSpecific(Single, Single[], WorldLayerNeighborInfo[])

Declaration

protected override float DescribeSpecific(float currentValue, float[] dependencyValues, WorldLayerNeighborInfo[] neighborValues)

Parameters

Type	Name	Description
System.Single	currentValue
System.Single[]	dependencyValues
WorldLayerNeighborInfo[]	neighborValues

Returns

Type	Description
System.Single

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.DescribeSpecific(System.Single, System.Single[], Eco.Simulation.WorldLayers.WorldLayerNeighborInfo[])

GetValue(Single[])

Returns value which will be used for proportion calculation.

Declaration

protected virtual float GetValue(float[] dependencyValues)

Parameters

Type	Name	Description
System.Single[]	dependencyValues

Returns

Type	Description
System.Single

PostWorldgen(Single, Single[], WorldLayerNeighborInfo[])

Declaration

public override float PostWorldgen(float currentValue, float[] dependencyValues, WorldLayerNeighborInfo[] neighborValues)

Parameters

Type	Name	Description
System.Single	currentValue
System.Single[]	dependencyValues
WorldLayerNeighborInfo[]	neighborValues

Returns

Type	Description
System.Single

Overrides

Eco.Simulation.WorldLayers.WorldLayerInteraction<System.Single>.PostWorldgen(System.Single, System.Single[], Eco.Simulation.WorldLayers.WorldLayerNeighborInfo[])

Implements

IWorldLayerInteraction

IWorldLayerRelationship