get_point_name.tempflow: Given a point-id (or a point-name) this function returns the...

Description Usage Arguments Value

View source: R/tempflow-getter.R

Description

Given a point-id (or a point-name) this function returns the corresponding point-name as defined in (the 'igraph'-object underlying) the given 'tempflow'-object. If the given point-id or point-name is not present and if 'safe' has the value TRUE, an error will be thrown.

Usage

1
2
## S3 method for class 'tempflow'
get_point_name(tempFlow, inpPoint, safe = TRUE)

Arguments

tempFlow

A 'tempflow'-object.

inpPoint

Either a string representing the point-name or an integers representing the point-id.

safe

If TRUE, it will be tested, whether the given point-id (or point-name) is present in the 'tempflow'-object.

Value

The point-name of the point specified in "inpPoint" as currently defined in the 'tempflow'-object "tempFlow".


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