name {rsyncrosim} | R Documentation |
Name of a SsimLibrary, Project, Scenario, or Folder
Description
Retrieves or sets the name of a SsimLibrary
,
Project
, Scenario
, or Folder
.
Usage
name(ssimObject)
## S4 method for signature 'character'
name(ssimObject)
## S4 method for signature 'SsimLibrary'
name(ssimObject)
## S4 method for signature 'Scenario'
name(ssimObject)
## S4 method for signature 'Project'
name(ssimObject)
## S4 method for signature 'Folder'
name(ssimObject)
name(ssimObject) <- value
## S4 replacement method for signature 'character'
name(ssimObject) <- value
## S4 replacement method for signature 'SsimLibrary'
name(ssimObject) <- value
## S4 replacement method for signature 'Project'
name(ssimObject) <- value
## S4 replacement method for signature 'Scenario'
name(ssimObject) <- value
## S4 replacement method for signature 'Folder'
name(ssimObject) <- value
Arguments
ssimObject |
|
value |
character string of the new name |
Value
A character string: the name of the SsimObject.
Examples
## Not run:
# 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")
myFolder <- folder(myProject, folder = "New Folder")
# Retrieve names of the SsimObjects
name(myLibrary)
name(myProject)
name(myScenario)
name(myFolder)
# Set the name of the SyncroSim Scenario
name(myScenario) <- "My Scenario Name"
## End(Not run)
[Package rsyncrosim version 1.5.0 Index]