get_n_generated: Get Process Parameters

Description Usage Arguments Details See Also

View source: R/simmer-methods.R

Description

Getters for processes (sources and arrivals) number of arrivals generated by a source, the name of the active arrival, an attribute from the active arrival or a global one, and prioritization values.

Usage

1
2
3
4
5
6
7
8
9
get_n_generated(.env, source)

get_name(.env)

get_attribute(.env, keys, global = FALSE)

get_global(.env, keys)

get_prioritization(.env)

Arguments

.env

the simulation environment.

source

the name of the source.

keys

the attribute name(s).

global

if TRUE, the attribute will be global instead of per-arrival.

Details

get_n_generated returns the number of arrivals generated by a given source.

get_name returns the number of the running arrival. get_attribute returns a running arrival's attributes or global ones. If a provided key was not previously set, it returns a missing value. get_global is a shortcut for get_attribute(global=TRUE). get_prioritization returns a running arrival's prioritization values. get_name, get_attribute and get_prioritization are meant to be used inside a trajectory; otherwise, there will be no arrival running and these functions will throw an error.

See Also

set_attribute, set_prioritization.


r-simmer/simmer documentation built on Aug. 17, 2018, 9:18 p.m.