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

In rsyncrosim: The R Interface to 'SyncroSim'

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 signature 'character'
readOnly(ssimObject)

## S4 method for signature 'SsimLibrary'
readOnly(ssimObject)

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

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

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

readOnly(ssimObject) <- value

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

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

## S4 replacement method for signature 'Folder'
readOnly(ssimObject) <- value

Arguments

ssimObject	Scenario, Project, SsimLibrary, or Folder 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

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

## End(Not run)

rsyncrosim documentation built on Oct. 7, 2023, 9:08 a.m.