Package com.amalgamasimulation.discreterate

Class ReversibleConveyor.Builder<T>

java.lang.Object

com.amalgamasimulation.discreterate.ReversibleConveyor.Builder<T>

All Implemented Interfaces:

ReversibleConveyor.MaxSpeedBuilder<T>, ReversibleConveyor.PerformanceBuilder<T>, ReversibleConveyor.PolicyBuilder<T>, ReversibleConveyor.PolylineBuilder<T>

Enclosing class:

ReversibleConveyor<T>

public static class ReversibleConveyor.Builder<T>
extends Object
implements ReversibleConveyor.PolylineBuilder<T>, ReversibleConveyor.PolicyBuilder<T>, ReversibleConveyor.MaxSpeedBuilder<T>, ReversibleConveyor.PerformanceBuilder<T>

Helper class to create a ReversibleConveyor instance. Use ReversibleConveyor.builder(FlowEnvironment) method as the starting point.

Method Summary

Modifier and Type	Method	Description
ReversibleConveyor.Builder<T>	backwardOutputFlowElement(FlowElement<T> dest)	Connects the backward output (the beginning of the conveyor in the forward direction) of this Conveyor to the input of the dest flow element.
ReversibleConveyor<T>	build()	Creates a new ReversibleConveyor instance.
ReversibleConveyor.Builder<T>	forwardOutputFlowElement(FlowElement<T> dest)	Connects the forward output of this Conveyor to the input of the dest flow element.
ReversibleConveyor.Builder<T>	initialContents(List<MaterialFragmentDescriptor<T>> initialStock)	Set the contents of this Conveyor with the initialStock.
ReversibleConveyor.Builder<T>	inputFlowWithRelativeOffset(FlowElement<T> sourceFlowElement, double relativeOffset)	Connects the sourceFlowElement (as a source of material) to this ReversibleConveyor.
ReversibleConveyor.Builder<T>	inputFlowWithRelativeOffset(List<Pair<FlowElement<T>,Double>> sourceFlowElementsByRelativeOffset)	Connects the sourceFlowElement (as a source of material) to this ReversibleConveyor.
ReversibleConveyor.Builder<T>	logicalLength(double logicalLength)	Sets the logical length of a Conveyor.
ReversibleConveyor.Builder<T>	maxSpeed(double maxSpeed)	Sets the max speed of a ReversibleConveyor instance.
ReversibleConveyor.Builder<T>	name(String name)	Sets the name of a Conveyor.
ReversibleConveyor.Builder<T>	performance(double performance)	Sets the performance (max internal flow rate) of a ReversibleConveyor instance.
ReversibleConveyor.MaxSpeedBuilder<T>	policy(Conveyor.DownstreamInflowRateShortagePolicy policy)	Sets the inflow shortage policy for a new ReversibleConveyor instance.
ReversibleConveyor.PolicyBuilder<T>	polyline(Polyline polyline)	Sets the polyline of a new ReversibleConveyor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

polyline

public ReversibleConveyor.PolicyBuilder<T> polyline(Polyline polyline)

Description copied from interface: ReversibleConveyor.PolylineBuilder

Sets the polyline of a new ReversibleConveyor

Specified by:

polyline in interface ReversibleConveyor.PolylineBuilder<T>

Parameters:

polyline - polyline

Returns:

a ReversibleConveyor.PolicyBuilder to set an inflow shortage policy

policy

public ReversibleConveyor.MaxSpeedBuilder<T> policy(Conveyor.DownstreamInflowRateShortagePolicy policy)

Description copied from interface: ReversibleConveyor.PolicyBuilder

Sets the inflow shortage policy for a new ReversibleConveyor instance.

Specified by:

policy in interface ReversibleConveyor.PolicyBuilder<T>

Parameters:

policy - inflow shortage policy

Returns:

a ReversibleConveyor.MaxSpeedBuilder to set the max speed of a Conveyor

maxSpeed

public ReversibleConveyor.Builder<T> maxSpeed(double maxSpeed)

Description copied from interface: ReversibleConveyor.MaxSpeedBuilder

Sets the max speed of a ReversibleConveyor instance.

Specified by:

maxSpeed in interface ReversibleConveyor.MaxSpeedBuilder<T>

Parameters:

maxSpeed - max speed of a Conveyor

Returns:

a ReversibleConveyor.PerformanceBuilder to set the performance of a Conveyor

performance

public ReversibleConveyor.Builder<T> performance(double performance)

Description copied from interface: ReversibleConveyor.PerformanceBuilder

Sets the performance (max internal flow rate) of a ReversibleConveyor instance.

Specified by:

performance in interface ReversibleConveyor.PerformanceBuilder<T>

Parameters:

performance - performance of a Conveyor

Returns:

a ReversibleConveyor.Builder object to set optional parameters and create a Conveyor instance

logicalLength

public ReversibleConveyor.Builder<T> logicalLength(double logicalLength)

Sets the logical length of a Conveyor. This is an optional parameter. If not set, the logical length of a Conveyor is calculated by the Conveyor's polyline.

Parameters:

logicalLength - logical length of a Conveyor

Returns:

the same ReversibleConveyor.Builder object

name

public ReversibleConveyor.Builder<T> name(String name)

Sets the name of a Conveyor. This is an optional parameter. If not set, the name of a new Conveyor is equal to the result of Conveyor.class.getName() method call.

Parameters:

name - name of a Conveyor

Returns:

the same ReversibleConveyor.Builder object

initialContents

public ReversibleConveyor.Builder<T> initialContents(List<MaterialFragmentDescriptor<T>> initialStock)

Set the contents of this Conveyor with the initialStock. Each element of the initialStock list is a MaterialFragmentDescriptor

Parameters:

initialStock - contents of this Conveyor

Returns:

the same ReversibleConveyor.Builder object

inputFlowWithRelativeOffset

public ReversibleConveyor.Builder<T> inputFlowWithRelativeOffset(FlowElement<T> sourceFlowElement,
 double relativeOffset)

Connects the sourceFlowElement (as a source of material) to this ReversibleConveyor.

The 'connection point', i.e. the exact location along the Conveyor where the material coming from the sourceFlowElement will be accepted by the Conveyor is set by relativeOffset (a number between 0 and 1).

Parameters:

sourceFlowElement - flow element that acts as a source of material

relativeOffset - a number in the open interval (0..1) (0 - not allowed, 1 - not allowed) that defines the point of incoming connection, where 0 means 'the beginning of the Conveyor'

Throws:

NullPointerException - if the sourceFlowElement is null

IllegalArgumentException - if relativeOffset is not in the open interval (0..1)

IllegalArgumentException - if the sourceFlowElement belongs to a different FlowEnvironment than this flow element

inputFlowWithRelativeOffset

public ReversibleConveyor.Builder<T> inputFlowWithRelativeOffset(List<Pair<FlowElement<T>,Double>> sourceFlowElementsByRelativeOffset)

Connects the sourceFlowElement (as a source of material) to this ReversibleConveyor.

The 'connection point', i.e. the exact location along the Conveyor where the material coming from the sourceFlowElement will be accepted by the Conveyor is set by relativeOffset (a number between 0 and 1).

Parameters:

sourceFlowElementsByRelativeOffset - collection of pairs where the first element is flow element that acts as a source of material and the second element is a number in the open interval (0..1) (0 - allowed, 1 - not allowed) that defines the point of incoming connection, where 0 means 'the beginning of the Conveyor'

Throws:

NullPointerException - if the sourceFlowElementsByRelativeOffset is null

NullPointerException - if the sourceFlowElement is null

IllegalArgumentException - if relativeOffset is not in the open interval (0..1)

IllegalArgumentException - if the sourceFlowElement belongs to a different FlowEnvironment than this flow element

forwardOutputFlowElement

public ReversibleConveyor.Builder<T> forwardOutputFlowElement(FlowElement<T> dest)

Connects the forward output of this Conveyor to the input of the dest flow element.

Parameters:

dest - flow element to connect to

Throws:

NullPointerException - if the dest flow element is null

IllegalArgumentException - if the dest flow element belongs to a different FlowEnvironment than this flow element

backwardOutputFlowElement

public ReversibleConveyor.Builder<T> backwardOutputFlowElement(FlowElement<T> dest)

Connects the backward output (the beginning of the conveyor in the forward direction) of this Conveyor to the input of the dest flow element. This output is used in backward direction.

Parameters:

dest - flow element to connect to

Throws:

NullPointerException - if the dest flow element is null

IllegalArgumentException - if the dest flow element belongs to a different FlowEnvironment than this flow element

build

public ReversibleConveyor<T> build()

Creates a new ReversibleConveyor instance.

Returns:

new ReversibleConveyor instance