rsyncrosim (version 2.0.1)

readOnly: Read-only status of a SsimLibrary, Project, Scenario or Folder

Description

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

Usage

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)
# S4 method for Folder
readOnly(ssimObject)
# S4 method for Chart
readOnly(ssimObject)
readOnly(ssimObject) <- value
# S4 method for character
readOnly(ssimObject) <- value
# S4 method for SsimObject
readOnly(ssimObject) <- value
# S4 method for Folder
readOnly(ssimObject) <- value
# S4 method for Chart
readOnly(ssimObject) <- value

Value

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

otherwise.

Arguments

ssimObject

Scenario, Project, SsimLibrary, or Folder object

value

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

Examples

if (FALSE) {
# Specify file path and name of new SsimLibrary
myLibraryName <- file.path(tempdir(), "testlib")

# Set up a SyncroSim Session, SsimLibrary, Project, Scenario, and Folder
mySession <- session()
myLibrary <- ssimLibrary(name = myLibraryName, session = mySession)
myProject <- project(myLibrary, project = "Definitions")
myScenario <- scenario(myProject, scenario = "My Scenario")
myFolder <- folder(myProject, "My Folder")

# Retrieve the read-only status of a SsimObject
readOnly(myLibrary)
readOnly(myProject)
readOnly(myScenario)
readOnly(myFolder)

# Set the read-only status of a SsimObject
readOnly(myScenario) <- TRUE
}