projectId: Retrieves projectId of SyncroSim Project or Scenario

In rsyncrosim: The R Interface to 'SyncroSim'

Retrieves projectId of SyncroSim Project or Scenario

Description

Retrieves the projectId of a SyncroSim Project or Scenario.

Usage

projectId(ssimObject)

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

## S4 method for signature 'Project'
projectId(ssimObject)

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

Arguments

ssimObject

Scenario or Project object

Value

An integer: project id.

Examples

# Set the file path and name of the new SsimLibrary
myLibraryName <- file.path(tempdir(),"testlib")

# Set the 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")

# Get Project ID for SyncroSim Project and Scenario
projectId(myProject)
projectId(myScenario)

rsyncrosim documentation built on Oct. 8, 2022, 9:06 a.m.