get_step_point_list.tempnetwork: This function returns a named list. The key 'startPointList'...

Description Usage Arguments Value

View source: R/tempnetwork-tempflow-getter.R

Description

This function returns a named list. The key 'startPointList' references the start-points of the specified steps, while the key 'endPointList' references their end-points.

Usage

1
2
3
## S3 method for class 'tempnetwork'
get_step_point_list(tempNetwork,
  srcPointList = NULL, dstPointList = NULL, safe = TRUE)

Arguments

tempNetwork

A 'tempnetwork'-object.

srcPointList

The vector containing the point-names (or point-ids) representing the start-points of the desired edges.

dstPointList

The vector containing the point-names (or point-ids) representing the end-points of the desired edges.

safe

If TRUE, it will be tested, whether the specified point-names (or point-ids) are present in the 'tempflow'-object of the given 'tempnetwork'-object; whether the vectors have the same length; whether the specified edges are present in the 'tempflow'-object of the given 'tempnetwork'-object.

Value

A list with the keys 'startPointList' and 'endPointList' containing the respective start- and end-points of the given steps.


KonstantinRK/tempnetwork documentation built on Dec. 23, 2019, 6:40 p.m.