Retrieves or sets the name of a SsimLibrary, Project or Scenario.

name(ssimObject)

# S4 method for character
name(ssimObject)

# S4 method for SsimLibrary
name(ssimObject)

# S4 method for Scenario
name(ssimObject)

# S4 method for Project
name(ssimObject)

name(ssimObject) <- value

# S4 method for character
name(ssimObject) <- value

# S4 method for SsimLibrary
name(ssimObject) <- value

# S4 method for Project
name(ssimObject) <- value

# S4 method for Scenario
name(ssimObject) <- value

Arguments

ssimObject

Scenario, Project, or SsimLibrary object

value

character string of the new name

Value

A character string: the name of the SsimObject.

Examples

# \donttest{ # 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") # Retrieve names of the SsimObjects name(myLibrary)
#> [1] "testlib"
name(myProject)
#> [1] "Definitions"
name(myScenario)
#> [1] "My Scenario"
# Set the name of the SyncroSim Scenario name(myScenario) <- "My Scenario Name" # }