projectId: Retrieves projectId of SyncroSim Project, Scenario, Folder,...

In rsyncrosim: The R Interface to 'SyncroSim'

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

Description

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

Usage

projectId(ssimObject)

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

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

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

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

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

Arguments

ssimObject

Scenario, Project, Folder, or Chart object

Value

An integer: project id.

Examples

## Not run: 
# 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)

## End(Not run)

rsyncrosim documentation built on Oct. 15, 2024, 1:06 a.m.