Retrieves or sets whether or not a SsimLibrary, Project or Scenario is read-only.

readOnly(ssimObject)

# S4 method for character
readOnly(ssimObject)

# S4 method for SsimLibrary
readOnly(ssimObject)

# S4 method for Project
readOnly(ssimObject)

# S4 method for Scenario
readOnly(ssimObject)

readOnly(ssimObject) <- value

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

# S4 method for SsimObject
readOnly(ssimObject) <- value

Arguments

ssimObject

Scenario, Project, or SsimLibrary object

value

logical. If TRUE the SsimObject will be read-only. Default is FALSE

Value

A logical: TRUE if the SsimObject is read-only and FALSE otherwise.

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 the read-only status of a SsimObject readOnly(myLibrary)
#> [1] FALSE
readOnly(myProject)
#> [1] "No"
readOnly(myScenario)
#> [1] "No"
# Set the read-only status of a SsimObject readOnly(myScenario) <- TRUE # }