Retrieves projectId of SyncroSim Project, Scenario, Folder, or Chart

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

Usage

projectId(ssimObject)

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

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

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

# S4 method for class 'Folder'
projectId(ssimObject)

# S4 method for class 'Chart'
projectId(ssimObject)

Arguments

ssimObject

Scenario, Project, Folder, or Chart 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
# }