Used to allocate customer points to pipes in the network. The options and behavior of this class broadly match the static demand allocation tool in the user interface.

To use the methods of this class, you need to create an instance using the #new method and call the remaining methods.

network = WSApplication.current_network

allocator = WSDemandAllocation.new()
allocator.network = network
allocator.options = {'max_dist_to_pipe_native' => 200.00, 'max_pipe_diameter_native' => 200.00}
allocator.allocate

Methods:

• allocate
• demand_diagram= (Set)
• network= (Set)
• new
• options
• options= (Set)

allocate

#allocate ⇒ void

EXCHANGE, UI

Performs the allocation. Will raise an exception if the allocation fails.

demand_diagram= (Set)

#demand_diagram=(ddg) ⇒ void

EXCHANGE, UI

Optionally sets the demand diagram.

Parameters

network= (Set)

#network=(network) ⇒ void

EXCHANGE, UI

Sets the network to allocate demand for.

Parameters

new

#new ⇒ WSDemandAllocation

EXCHANGE, UI

Creates a new instance of this class.

options

#options ⇒ Hash

EXCHANGE, UI

Gets the current option, including all default values.

options= (Set)

#options=(hash) ⇒ void

EXCHANGE, UI

Sets the options to use for the allocation. The options hash can contain the following keys: