ignoreDependencies: Ignore dependencies for a Scenario

Description Usage Arguments Value Examples

Description

Retrieves or sets the Datafeeds to ignore for a Scenario.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
ignoreDependencies(ssimObject)

## S4 method for signature 'character'
ignoreDependencies(ssimObject)

## S4 method for signature 'Scenario'
ignoreDependencies(ssimObject)

ignoreDependencies(ssimObject) <- value

## S4 replacement method for signature 'character'
ignoreDependencies(ssimObject) <- value

## S4 replacement method for signature 'Scenario'
ignoreDependencies(ssimObject) <- value

Arguments

ssimObject

Scenario object

value

character string of Datafeed names to be ignored, separated by commas (optional)

Value

A character string: Scenario Datafeeds that will be ignored.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

# Set up a SyncroSim Session, SsimLibrary, Project, and Scenario
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")

# List the Datafeeds to ignore
ignoreDependencies(myScenario)

# Set Scenario Datafeeds to ignore
ignoreDependencies(myScenario) <- "stsim_RunControl,stsim_TransitionTarget"

rsyncrosim documentation built on Oct. 28, 2021, 1:07 a.m.