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

Description Usage Arguments Value Examples

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
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)

readOnly(ssimObject) <- value

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

## S4 replacement method for signature '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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
# 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)
readOnly(myProject)
readOnly(myScenario)

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

rsyncrosim documentation built on Oct. 28, 2021, 1:07 a.m.