Retrieves projectId of SyncroSim Project, Scenario, or Folder

Source: R/projectId.R

Retrieves the projectId of a SyncroSim Project, Scenario, or Folder.

projectId(ssimObject)

# S4 method for character
projectId(ssimObject)

# S4 method for Project
projectId(ssimObject)

# S4 method for Scenario
projectId(ssimObject)

# S4 method for Folder
projectId(ssimObject)

Arguments

ssimObject

Scenario, Project, or Folder object

Value

An integer: project id.

Examples

# \donttest{
# 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)
#> [1] 1
projectId(myScenario)
#> [1] 1
# }